ListAgents - AWS DataSync
請求語法請求參數回應語法回應元素錯誤另請參閱

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

ListAgents

傳回屬於要求中AWS 區域指定的AWS 帳戶中的AWS DataSync代理程式清單。

透過分頁，您可以減少回應中傳回的代理程式數目。如果您在回應中取得截斷的代理程式清單，則回應會包含一個標記，您可以在下一個要求中指定，以擷取下一頁代理程式。

ListAgents為最終一致性。這表示執行作業的結果可能不會反映您剛建立或刪除代理程式。例如，如果您使用建立代理程式，CreateAgent然後立即執行ListAgents，則該代理程式可能不會立即顯示在清單中。在這種情況下，您可以隨時使用來確認是否已建立 (或刪除) 代理程式DescribeAgent。

請求語法

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

請求參數

如需有關所有動作共用之參數的資訊，請參閱一般參數。

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

MaxResults

指定資訊在回應中DataSync列出資料的最大數目。根據預設，回應最多會顯示 100 個代理程式。

類型：整數

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

必要：否

NextToken

指定不透明的字串，指出在回應中下一個結果清單開始的位置。

類型：字串

長度：長度為 65535。

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

必要：否

回應語法

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

回應元素

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

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

Agents

請求中AWS 區域指定的AWS 帳戶中的DataSync代理程式清單。清單是按照資源的 Amazon Resource Mource Mource Mource Mource Mource By。

類型：AgentListEntry 物件陣列

NextToken

不透明的字串，指出在回應中下一個結果清單開始的位置。

類型：字串

長度：長度為 65535。

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

錯誤

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

InternalException

當在AWS DataSync服務中發生錯誤時，拋出此異常。

HTTP 狀態碼：500

InvalidRequestException

當客戶端提交格式錯誤的請求時，拋出此異常。

HTTP 狀態碼：400

另請參閱

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