ListAgents - AWS DataSync

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

ListAgents

傳回所擁有的代理程式清單AWS 帳戶中的AWS 區域請求中指定。傳回的清單依代理 Amazon Resource Name (ARN) 排序。

在預設情況下,這個操作會傳回最多 100 個用戶端。此作業支援分頁,可讓您選擇性地減少回應中傳回的代理程式數目。

如果您的代理程式超過回應中傳回的數量 (也就是說,回應只會傳回您的代理程式的截斷清單),則回應會包含一個標記,您可以在下一個要求中指定以擷取代理程式的下一頁。

請求語法

{ "MaxResults": number, "NextToken": "string" }

請求參數

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

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

MaxResults

要列出的用戶端數目上限。

類型:整數

有效範圍:最小值為 0。最大值為 100。

必要:否

NextToken

不透明的字串,指出下一個代理程式清單開始的位置。

類型:字串

長度限制:長度上限為 65 535。

模式:[a-zA-Z0-9=_-]+

必要:否

回應語法

{ "Agents": [ { "AgentArn": "string", "Name": "string", "Status": "string" } ], "NextToken": "string" }

回應元素

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

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

Agents

您帳戶中的專員清單。

類型:陣列AgentListEntry對象

NextToken

不透明的字串,指出開始傳回下一個代理程式清單的位置。

類型:字串

長度限制:長度上限為 65 535。

模式:[a-zA-Z0-9=_-]+

Errors

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

InternalException

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

HTTP 狀態碼:500

InvalidRequestException

當用戶端提交格式錯誤的請求時,就會擲出此例外狀況。

HTTP 狀態碼:400

另請參閱

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