CreateAgent - AWS DataSync

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

CreateAgent

啟動您已在儲存環境中部署的AWS DataSync代理程式。啟用程序會為代理程式與您AWS 帳戶.

如果您尚未部署代理程式,請參閱下列主題以進一步了解:

注意

如果您要在AWS儲存空間服務之間進行轉移,則不需要DataSync代理程式。

請求語法

{ "ActivationKey": "string", "AgentName": "string", "SecurityGroupArns": [ "string" ], "SubnetArns": [ "string" ], "Tags": [ { "Key": "string", "Value": "string" } ], "VpcEndpointId": "string" }

請求參數

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

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

ActivationKey

指定DataSync代理程式的啟動金鑰。如果您沒有啟用金鑰,請參閱啟用您的代理程式

類型:字串

長度限為:長度限為 29。

模式:[A-Z0-9]{5}(-[A-Z0-9]{5}){4}

必要:是

AgentName

指定您代理程式的名稱。您可以在DataSync控制台中看到此名稱。

類型:字串

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

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

必要:否

SecurityGroupArns

指定安全群組的 Amazon 資源名稱 (ARN),以在使用虛擬私有雲端 (VPC) 端點時保護您任務的網路界面

類型:字串陣列

陣列成員:固定項目數為 1。

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

模式:^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):ec2:[a-z\-0-9]*:[0-9]{12}:security-group/sg-[a-f0-9]+$

必要:否

SubnetArns

指定使用 VPC 端點時要在其中執行DataSync工作的子網路的 ARN。這是為您的傳輸DataSync建立和管理網路介面的子網路。

類型:字串陣列

陣列成員:固定項目數為 1。

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

模式:^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):ec2:[a-z\-0-9]*:[0-9]{12}:subnet/.*$

必要:否

Tags

指定可協助您分類、篩選和搜尋 AWS 資源的標籤。建議您代理程式建立至少一個標籤。

類型:TagListEntry 物件陣列

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

必要:否

VpcEndpointId

指定您希望您代理程式連線到的 ID。例如,VPC 端點的 ID 如vpce-01234d5aff67890e1下所示。

重要

您使用的 VPC 端點必須包含DataSync服務名稱 (例如com.amazonaws.us-east-2.datasync)。

類型:String

模式:^vpce-[0-9a-f]{17}$

必要:否

回應語法

{ "AgentArn": "string" }

回應元素

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

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

AgentArn

您剛啟動之代理程式的 ARN。使用此ListAgents作業傳回AWS 帳戶與中的代理程式清單AWS 區域。

類型:字串

長度限制:長度上限為 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}$

錯誤

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

InternalException

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

HTTP 狀態碼:500

InvalidRequestException

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

HTTP 狀態碼:400

範例

請求範例

下列範例會啟動DataSync代理程式,並將其與您的AWS 帳戶.

{ "ActivationKey": "AAAAA-1AAAA-BB1CC-33333-EEEEE", "AgentName": "MyAgent", "Tags": [{ "Key": "Job", "Value": "TransferJob-1" }] }

回應範例

回應會傳回已啟動代理程式的 ARN。

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

另請參閱

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