As traduções são geradas por tradução automática. Em caso de conflito entre o conteúdo da tradução e da versão original em inglês, a versão em inglês prevalecerá.
DescribeAgent
Retorna metadados sobre um AWS DataSync agente, como nome, tipo de endpoint e status.
Sintaxe da solicitação
{
"AgentArn": "string"
}Parâmetros de solicitação
Para obter informações sobre os parâmetros que são comuns a todas as ações, consulte Parâmetros comuns.
A solicitação aceita os dados a seguir no formato JSON.
- AgentArn
-
Especifica o nome do recurso da Amazon (ARN) do o nome do o nome do recurso da Amazon (ARN) do o nome do DataSync o nome do
Tipo: String
Restrições de tamanho: tamanho máximo de 128.
Padrão:
^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):datasync:[a-z\-0-9]+:[0-9]{12}:agent/agent-[0-9a-z]{17}$Obrigatório: Sim
Sintaxe da resposta
{
"AgentArn": "string",
"CreationTime": number,
"EndpointType": "string",
"LastConnectionTime": number,
"Name": "string",
"PrivateLinkConfig": {
"PrivateLinkEndpoint": "string",
"SecurityGroupArns": [ "string" ],
"SubnetArns": [ "string" ],
"VpcEndpointId": "string"
},
"Status": "string"
}Elementos de resposta
Se a ação for bem-sucedida, o serviço reenviará uma resposta HTTP 200.
Os dados a seguir são retornados no formato JSON pelo serviço.
- AgentArn
-
O ARN do agente.
Tipo: String
Restrições de tamanho: tamanho máximo de 128.
Padrão:
^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):datasync:[a-z\-0-9]+:[0-9]{12}:agent/agent-[0-9a-z]{17}$ - CreationTime
-
A hora em que o agente foi ativado (ou seja, criado em sua conta).
Tipo: Timestamp
- EndpointType
-
O tipo de endpoint ao qual seu agente está conectado. Se o endpoint for um VPC endpoint, o agente não estará acessível pela Internet pública.
Tipo: String
Valores válidos:
PUBLIC | PRIVATE_LINK | FIPS - LastConnectionTime
-
A hora em que o agente se conectou pela última vezDataSync.
Tipo: Timestamp
- Name
-
O nome do o nome do o nome do o nome do e
Tipo: String
Restrições de tamanho: tamanho mínimo 1. Tamanho máximo de 256.
Padrão:
^[a-zA-Z0-9\s+=._:@/-]+$ - PrivateLinkConfig
-
A sub-rede e o grupo de segurança que DataSync costumavam acessar um endpoint VPC.
Tipo: objeto PrivateLinkConfig
- Status
-
O nome do o e Se o status for ONLINE, o agente está configurado corretamente e está disponível para uso. O status Em execução é o status normal de execução de um agente. Se o status for OFFLINE, a VM do agente será desativada ou o agente não estará em um estado de saúde. Quando o problema que provocou o estado não íntegro é resolvido, o agente volta para o status ONLINE.
Tipo: String
Valores válidos:
ONLINE | OFFLINE
Erros
Para obter informações sobre os erros comuns a todas as ações, consulteErros comuns.
- InternalException
-
Essa exceção é lançada quando ocorre um erro no AWS DataSync serviço.
Código de status HTTP: 500
- InvalidRequestException
-
Essa exceção é lançada quando o cliente envia uma solicitação malformada.
Código de status HTTP: 400
Exemplos
Exemplo
O exemplo especificado.
Exemplo de solicitação
{
"AgentArn": "arn:aws:datasync:us-east-2:111222333444:agent/agent-0b0addbeef44baca3"
}Exemplo
Este exemplo ilustra um uso de. DescribeAgent
Exemplo de resposta
{
"AgentArn": "arn:aws:datasync:us-east-2:111222333444:agent/agent-0b0addbeef44baca3",
"CreationTime": "1532660733.39",
"LastConnectionTime": "1532660733.39",
"Name": "MyAgent",
"Status": "ONLINE"
}Consulte também
Para obter mais informações sobre como usar essa API em um dos AWS SDKs específicos de linguagem, consulte o seguinte:
