Las traducciones son generadas a través de traducción automática. En caso de conflicto entre la traducción y la version original de inglés, prevalecerá la version en inglés.
DescribeAgent
Devuelve metadatos sobre un AWS DataSync agente, como su nombre, tipo de extremo y estado.
Sintaxis de la solicitud
{
"AgentArn": "string"
}Parámetros de solicitud
Para obtener información sobre los parámetros comunes a todas las acciones, consulte Parámetros comunes.
La solicitud acepta los siguientes datos en formato JSON.
- AgentArn
-
Especifica el nombre de recurso de Amazon (ARN) del DataSync agente que se va a describir.
Tipo: String
Limitaciones de longitud: longitud máxima de 128 caracteres.
Patrón:
^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}$Obligatorio: sí
Sintaxis de la respuesta
{
"AgentArn": "string",
"CreationTime": number,
"EndpointType": "string",
"LastConnectionTime": number,
"Name": "string",
"PrivateLinkConfig": {
"PrivateLinkEndpoint": "string",
"SecurityGroupArns": [ "string" ],
"SubnetArns": [ "string" ],
"VpcEndpointId": "string"
},
"Status": "string"
}Elementos de respuesta
Si la acción se realiza correctamente, el servicio devuelve una respuesta HTTP 200.
El servicio devuelve los datos siguientes en formato JSON.
- AgentArn
-
El ARN del agente.
Tipo: String
Limitaciones de longitud: longitud máxima de 128 caracteres.
Patrón:
^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
-
La hora en que se activó el agente (es decir, se creó en su cuenta).
Tipo: Timestamp
- EndpointType
-
El tipo de punto de enlace al que está conectado el agente. Si el punto de enlace es un punto de enlace de la VPC, no se puede acceder al agente a través de Internet pública.
Tipo: String
Valores válidos:
PUBLIC | PRIVATE_LINK | FIPS - LastConnectionTime
-
La hora a la que el agente se conectó por última vezDataSync.
Tipo: Timestamp
- Name
-
El nombre del agente.
Tipo: String
Limitaciones de longitud: longitud mínima de 1. La longitud máxima es de 256 caracteres.
Patrón:
^[a-zA-Z0-9\s+=._:@/-]+$ - PrivateLinkConfig
-
La subred y el grupo de seguridad que DataSync solían acceder a un punto final de VPC.
Tipo: objeto PrivateLinkConfig
- Status
-
El estado del agente. Si el estado es ONLINE, el agente está configurado correctamente y está disponible para su uso. El estado en ejecución es el estado de ejecución normal de un agente. Si el estado es SIN CONEXIÓN, la máquina virtual del agente está apagada o el agente no está en buen estado. Cuando se resuelve el problema que ha provocado el mal estado, el agente recupera el estado ONLINE.
Tipo: String
Valores válidos:
ONLINE | OFFLINE
Errores
Para obtener información sobre los errores comunes a todas las acciones, consulteErrores comunes.
- InternalException
-
Esta excepción se produce cuando se produce un error en el AWS DataSync servicio.
Código de estado HTTP: 500
- InvalidRequestException
-
Esta excepción se produce cuando el cliente envía una solicitud con formato incorrecto.
Código de estado HTTP: 400
Ejemplos
Ejemplo
El siguiente ejemplo devuelve información sobre el agente especificado.
Solicitud de muestra
{
"AgentArn": "arn:aws:datasync:us-east-2:111222333444:agent/agent-0b0addbeef44baca3"
}Ejemplo
Este ejemplo ilustra un uso deDescribeAgent.
Respuesta de ejemplo
{
"AgentArn": "arn:aws:datasync:us-east-2:111222333444:agent/agent-0b0addbeef44baca3",
"CreationTime": "1532660733.39",
"LastConnectionTime": "1532660733.39",
"Name": "MyAgent",
"Status": "ONLINE"
}Véase también
Para obtener más información sobre el uso de esta API en un SDK de AWS de un lenguaje específico, consulte:
