StartDiscoveryJob - AWS DataSync

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

StartDiscoveryJob

在內部部署儲存系統上執行DataSync探查工作。如果您尚未將儲存系統新增至DataSync Discovery,請先使用作業執行此AddStorageSystem操作。

請求語法

{ "ClientToken": "string", "CollectionDurationMinutes": number, "StorageSystemArn": "string", "Tags": [ { "Key": "string", "Value": "string" } ] }

請求參數

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

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

ClientToken

指定用戶端權杖,以確保使用此 API 作業的要求是冪等的。若您未指定名稱,DataSync會自動為您產生名稱。

類型:String

模式:[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}

必要:是

CollectionDurationMinutes

指定您要執行探查的期限期限期限期限期限期限期限期限期限

注意

為了獲得更準確的建議,我們建議至少 14 天的持續時間。較長的持續時間可讓您有時間收集足夠數量的資料點,並提供儲存效能和使用率的現實呈現。

類型:整數

有效範圍:最小值為 60。最大值。

必要:是

StorageSystemArn

指定要在其執行探查任務之現場系統的 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}:system/storage-system-[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$

必要:是

Tags

指定可協助您分類、篩選和搜尋 AWS 資源的標籤。

類型:TagListEntry 物件陣列

陣列成員:項目數下限為 0。項目數上限為 50。

必要:否

回應語法

{ "DiscoveryJobArn": "string" }

回應元素

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

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

DiscoveryJobArn

您開始的探查工作的 ARN。

類型:字串

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

模式:^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):datasync:[a-z\-0-9]+:[0-9]{12}:system/storage-system-[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}/job/discovery-job-[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$

錯誤

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

InternalException

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

HTTP 狀態碼:500

InvalidRequestException

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

HTTP 狀態碼:400

另請參閱

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