本文属于机器翻译版本。若本译文内容与英语原文存在差异，则一律以英文原文为准。
DescribeAgent
返回有关Amazon DataSync代理的元数据，例如其名称、端点类型和状态。
请求语法
{
"AgentArn": "string"
}请求参数
有关所有操作常用参数的信息，请参阅Common Param eters。
请求接受采用 JSON 格式的以下数据。
- AgentArn
-
指定要描述的 DataSync 代理（ARN）。
类型：字符串
长度约束：最大长度为 128。
模式：
^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}$必需：是
响应语法
{
"AgentArn": "string",
"CreationTime": number,
"EndpointType": "string",
"LastConnectionTime": number,
"Name": "string",
"PrivateLinkConfig": {
"PrivateLinkEndpoint": "string",
"SecurityGroupArns": [ "string" ],
"SubnetArns": [ "string" ],
"VpcEndpointId": "string"
},
"Status": "string"
}响应元素
如果此操作成功，则该服务将会发送回 HTTP 200 响应。
服务以 JSON 格式返回的以下数据。
- AgentArn
-
客服的 ARN。
类型：字符串
长度约束：最大长度为 128。
模式：
^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
-
激活代理的时间（即在您的账户中创建）。
类型：Timestamp
- EndpointType
-
代理连接到的端点的类型。如果端点是 VPC 端点，则无法通过公有互联网访问代理。
类型：字符串
有效值:
PUBLIC | PRIVATE_LINK | FIPS - LastConnectionTime
-
代理上次连接的时间 DataSync。
类型：Timestamp
- Name
-
该代理。
类型：字符串
长度限制：最小长度为 1。长度上限为 256。
模式：
^[a-zA-Z0-9\s+=._:@/-]+$ - PrivateLinkConfig
-
DataSync 用于访问 VPC 终端节点的子网和安全组。
类型：PrivateLinkConfig 对象
- Status
-
该代理。如果状态为 ONLINE，则代理已正确配置并可供使用。运行状态是代理的正常运行状态。如果状态为 OFFLINE，则代理的虚拟机已关闭或代理处于不健康状态。在解决导致不正常运行状态的问题后，代理将恢复为“ONLINE (联机)”状态。
类型：字符串
有效值:
ONLINE | OFFLINE
错误
有关所有操作常见错误的信息，请参阅常见错误。
- InternalException
-
当Amazon DataSync服务中发生错误时，会抛出此异常。
HTTP 状态代码：500
- InvalidRequestException
-
当客户端提交格式错误的请求时，会引发此异常。
HTTP 状态代码：400
示例
示例
以下示例返回样本请求中指定代理。
示例请求
{
"AgentArn": "arn:aws:datasync:us-east-2:111222333444:agent/agent-0b0addbeef44baca3"
}示例
此示例说明了的一种用法 DescribeAgent。
示例响应
{
"AgentArn": "arn:aws:datasync:us-east-2:111222333444:agent/agent-0b0addbeef44baca3",
"CreationTime": "1532660733.39",
"LastConnectionTime": "1532660733.39",
"Name": "MyAgent",
"Status": "ONLINE"
}另请参阅
有关在特定语言的 Amazon 软件开发工具包中使用此 API 的更多信息，请参阅以下内容：