DescribeAgent - AWS DataSync

本文為英文版的機器翻譯版本,如內容有任何歧義或不一致之處,概以英文版為準。

DescribeAgent

傳回中繼資料,例如名稱、網路界面和代理程式的中繼資料 (也就是說,無論代理程式是否在執行中)。若要指定要描述哪個代理程式,請在請求中使用代理程式的 Amazon Resource Name (ARN)。

請求語法

{ "AgentArn": "string" }

請求參數

如需所有動作常見的參數相關資訊,請參閱一般參數

請求接受採用 JSON 格式的下列資料。

AgentArn

代理程式的 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", "PrivateLinkConfig": { "PrivateLinkEndpoint": "string", "SecurityGroupArns": [ "string" ], "SubnetArns": [ "string" ], "VpcEndpointId": "string" }, "Status": "string" }

回應元素

如果動作成功,則服務傳回 HTTP 200 回應。

服務會傳回下列 JSON 格式的資料。

AgentArn

代理程式的 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}$

CreationTime

啟動代理程式的時間 (也就是在您的帳戶中建立)。

類型:時間戳記

EndpointType

代理程式所連線之端點的類型。如果端點是 VPC 端點,則無法透過公有網際網路存取代理程式。

類型:字串

有效值: PUBLIC | PRIVATE_LINK | FIPS

LastConnectionTime

代理程式上次連線至 DataSync 的時間。

類型:時間戳記

Name

代理程式的名稱。

類型:字串

長度限制:長度下限為 1。長度上限為 256。

模式:^[a-zA-Z0-9\s+=._:@/-]+$

PrivateLinkConfig

DataSync 用於存取 VPC 端點的子網路和安全群組。

類型:PrivateLinkConfig 物件

Status

代理程式的狀態。如果狀態為 ONLINE,表示代理程式的設定正確,以及可供使用。執行中狀態是代理程式正常執行的狀態。如果狀態為 [離線],表示代理程式的 VM 處於關閉狀態或代理程式得的運作狀態不佳。當造成運作狀態不佳的問題解決時,代理程式會回到 ONLINE (線上) 狀態。

類型:字串

有效值: ONLINE | OFFLINE

Errors

如需所有動作常見的錯誤相關資訊,請參閱常見錯誤

InternalException

當發生錯誤時,就會擲出此例外狀況AWS DataSync服務。

HTTP 狀態碼:500

InvalidRequestException

當客戶端提交格式不佳的請求時,就會擲出此例外狀況。

HTTP 狀態碼:400

Examples

Example

以下範例會傳回有關範例要求中指定代理程式的資訊。

請求範例

{ "AgentArn": "arn:aws:datasync:us-east-2:111222333444:agent/agent-0b0addbeef44baca3" }

Example

此範例說明 DescribeAgent 的一種用法。

回應範例

{ "AgentArn": "arn:aws:datasync:us-east-2:111222333444:agent/agent-0b0addbeef44baca3", "CreationTime": "1532660733.39", "LastConnectionTime": "1532660733.39", "Name": "MyAgent", "Status": "ONLINE" }

另請參閱

如需在語言特定的 AWS 開發套件之一中使用此 API 的詳細資訊,請參閱下列說明: