本文属于机器翻译版本。若本译文内容与英语原文存在差异，则一律以英文原文为准。
返回有关 AWS DataSync 代理的信息，例如其名称、服务端点类型和状态。
请求语法
{
"AgentArn": "string"
}请求参数
有关所有操作的通用参数的信息，请参阅常用参数。
请求接受采用 JSON 格式的以下数据。
- AgentArn
-
指定您想要获取相关信息的 DataSync 代理的 Amazon 资源名称 (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",
"Platform": {
"Version": "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
-
激活代理的时间。
类型：时间戳
- EndpointType
-
您的代理连接到的服务端点的类型。
类型：字符串
有效值：
PUBLIC | PRIVATE_LINK | FIPS - LastConnectionTime
-
代理上次与 DataSync服务通信的时间。
类型：时间戳
- Name
-
代理名称。
类型：字符串
长度约束：最小长度为 0。最大长度为 256。
模式：
^[a-zA-Z0-9\s+=._:@/-]+$ - Platform
-
有关代理的平台相关详细信息，例如版本号。
类型：Platform 对象
- PrivateLinkConfig
-
代理在连接 VPC 服务端点时使用的网络配置。
类型：PrivateLinkConfig 对象
- Status
-
代理的状态。
-
如果状态为
ONLINE，则表示已正确配置代理并且可供使用。 -
如果状态为
OFFLINE，则表示代理已与 DataSync 该代理失去联系五分钟或更长时间。这可能是由于多种原因造成。有关更多信息，请参阅如何解决代理离线问题？
类型：字符串
有效值：
ONLINE | OFFLINE -
错误
有关所有操作的常见错误信息，请参阅 常见错误。
- InternalException
-
当 AWS DataSync 服务中发生错误时，会引发此异常。
HTTP 状态代码：500
- InvalidRequestException
-
当客户端提交格式错误的请求时，会引发此异常。
HTTP 状态代码：400
示例
示例请求
以下示例返回请求中指定的代理信息。
{
"AgentArn": "arn:aws:datasync:us-east-2:111122223333:agent/agent-1234567890abcdef0"
}示例响应
以下示例响应描述了使用公共服务端点的代理。
{
"AgentArn": "arn:aws:datasync:us-east-2:111122223333:agent/agent-1234567890abcdef0",
"Name": "Data center migration agent",
"Status": "ONLINE",
"LastConnectionTime": "2022-10-17T17:21:35.540000+00:00",
"CreationTime": "2022-10-05T20:52:29.499000+00:00",
"EndpointType": "PUBLIC",
"Platform": {
"Version": "2"
}
}另请参阅
有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容：
