本文為英文版的機器翻譯版本，如內容有任何歧義或不一致之處，概以英文版為準。
DescribeAgent
傳回 AWS DataSync 代理程式的相關資訊，例如其名稱、服務端點類型和狀態。
請求語法
{
"AgentArn": "string"
}請求參數
如需所有動作的一般參數資訊，請參閱《Common Parameters》。
請求接受採用 JSON 格式的下列資料。
- AgentArn
-
指定您要取得相關資訊之 DataSync 代理程式的 Amazon Resource Name (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
-
代理程式啟用的時間。
類型：Timestamp
- EndpointType
-
您的代理程式所連線的服務端點類型。
類型：字串
有效值:
PUBLIC | PRIVATE_LINK | FIPS | FIPS_PRIVATE_LINK - LastConnectionTime
-
上次客服人員與 DataSync 服務通訊的時間。
類型：Timestamp
- 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" } }
另請參閱
如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
