本文為英文版的機器翻譯版本,如內容有任何歧義或不一致之處,概以英文版為準。
ListLocations
傳回來源和目的地位置的清單。
如果您的位置多於回應中傳回的位置 (也就是說,回應只會傳回已截斷的代理程式清單),則回應會包含一個 Token,您可以在下一個要求中指定以擷取下一頁位置。
請求語法
{
"Filters": [
{
"Name": "string
",
"Operator": "string
",
"Values": [ "string
" ]
}
],
"MaxResults": number
,
"NextToken": "string
"
}
請求參數
如需所有動作共用參數的相關資訊,請參閱一般參數。
請求接受採用 JSON 格式的下列資料。
- Filters
-
您可以使用 API 篩選,以縮小傳回的資源清單
ListLocations
。例如,若要擷取特定來源位置上的所有工作,您可以使ListLocations
用篩選器名稱LocationType S3
和Operator Equals
。類型:LocationFilter 物件陣列
必要:否
- MaxResults
-
傳回的位置數上限。
類型:整數
有效範圍:最小值為 0。最大值為 100。
必要:否
- NextToken
-
不透明字串,指出下一個位置清單開始的位置。
類型:字串
長度限制:長度上限為 65535。
模式:
[a-zA-Z0-9=_-]+
必要:否
回應語法
{
"Locations": [
{
"LocationArn": "string",
"LocationUri": "string"
}
],
"NextToken": "string"
}
回應元素
如果動作成功,則服務傳回 HTTP 200 回應。
服務會傳回下列 JSON 格式的資料。
- Locations
-
包含位置清單的陣列。
類型:LocationListEntry 物件陣列
- NextToken
-
一個不透明的字符串,指示開始返回下一個位置列表的位置。
類型:字串
長度限制:長度上限為 65535。
模式:
[a-zA-Z0-9=_-]+
錯誤
如需所有動作常見的錯誤相關資訊,請參閱常見錯誤。
- InternalException
-
當在AWS DataSync服務中發生錯誤時,拋出此異常。
HTTP 狀態碼:500
- InvalidRequestException
-
當客戶端提交格式錯誤的請求時,拋出此異常。
HTTP 狀態碼:400
另請參閱
如需在語言特定的 AWS 開發套件之一中使用此 API 的詳細資訊,請參閱下列說明: