本文為英文版的機器翻譯版本，如內容有任何歧義或不一致之處，概以英文版為準。 # CreateAgent 啟用您在儲存環境中部署的 AWS DataSync 代理程式。啟用程序會將代理程式與您的建立關聯 AWS 帳戶。如果您尚未部署代理程式，請參閱[我需要 DataSync 代理程式嗎？](https://docs.aws.amazon.com/datasync/latest/userguide/do-i-need-datasync-agent.html) ## 請求語法 ``` { "ActivationKey": "string", "AgentName": "string", "SecurityGroupArns": [ "string" ], "SubnetArns": [ "string" ], "Tags": [ { "Key": "string", "Value": "string" } ], "VpcEndpointId": "string" } ``` ## 請求參數如需所有動作的一般參數資訊，請參閱《[Common Parameters](CommonParameters.md)》。請求接受採用 JSON 格式的下列資料。 ** [ActivationKey](#API_CreateAgent_RequestSyntax) ** 指定 DataSync 代理程式的啟用金鑰。如果您沒有啟用金鑰，請參閱[啟用您的代理](https://docs.aws.amazon.com/datasync/latest/userguide/activate-agent.html)程式。類型：字串長度限制：長度上限為 29。模式：`[A-Z0-9]{5}(-[A-Z0-9]{5}){4}` 必要：是 ** [AgentName](#API_CreateAgent_RequestSyntax) ** 指定代理程式的名稱。建議您指定可記住的名稱。類型：字串長度限制：長度下限為 0。長度上限為 256。模式：`^[a-zA-Z0-9\s+=._:@/-]+$` 必要：否 ** [SecurityGroupArns](#API_CreateAgent_RequestSyntax) ** 指定安全群組的 Amazon Resource Name (ARN)，允許代理程式和 VPC 服務端點之間的流量。您只能指定一個 ARN。類型：字串陣列陣列成員：固定項目數為 1。長度限制：長度上限為 128。模式：`^arn:(aws|aws-cn|aws-us-gov|aws-eusc|aws-iso|aws-iso-b):ec2:[a-z\-0-9]*:[0-9]{12}:security-group/sg-[a-f0-9]+$` 必要：否 ** [SubnetArns](#API_CreateAgent_RequestSyntax) ** 指定 VPC 服務端點所在的子網路 ARN。您只能指定一個 ARN。類型：字串陣列陣列成員：固定項目數為 1。長度限制：長度上限為 128。模式：`^arn:(aws|aws-cn|aws-us-gov|aws-eusc|aws-iso|aws-iso-b):ec2:[a-z\-0-9]*:[0-9]{12}:subnet/subnet-[a-f0-9]+$` 必要：否 ** [Tags](#API_CreateAgent_RequestSyntax) ** 指定可協助您分類、篩選和搜尋 AWS 資源的標籤。我們建議為您的代理程式建立至少一個標籤。類型：[TagListEntry](API_TagListEntry.md) 物件陣列陣列成員：項目數下限為 0。項目數上限為 50。必要：否 ** [VpcEndpointId](#API_CreateAgent_RequestSyntax) ** 指定您正在使用的 [VPC 服務端點](https://docs.aws.amazon.com/datasync/latest/userguide/choose-service-endpoint.html#datasync-in-vpc) ID。例如，VPC 端點 ID 看起來像 `vpce-01234d5aff67890e1`。您使用的 VPC 服務端點必須包含 DataSync 服務名稱（例如 `com.amazonaws.us-east-2.datasync`)。類型：字串模式：`^vpce-[0-9a-f]{17}$` 必要：否 ## 回應語法 ``` { "AgentArn": "string" } ``` ## 回應元素如果動作成功，則服務傳回 HTTP 200 回應。服務會傳回下列 JSON 格式的資料。 ** [AgentArn](#API_CreateAgent_ResponseSyntax) ** 您剛啟用之代理程式的 ARN。使用 [ListAgents](https://docs.aws.amazon.com/datasync/latest/userguide/API_ListAgents.html) 操作傳回 AWS 帳戶和中的客服人員清單 AWS 區域。類型：字串長度限制：長度上限為 128。模式：`^arn:(aws|aws-cn|aws-us-gov|aws-eusc|aws-iso|aws-iso-b):datasync:[a-z\-0-9]+:[0-9]{12}:agent/agent-[0-9a-z]{17}$` ## 錯誤如需所有動作常見錯誤的資訊，請參閱[常見錯誤](CommonErrors.md)。 ** InternalException ** 當服務發生錯誤時，就會擲出此 AWS DataSync 例外狀況。 HTTP 狀態碼：500 ** InvalidRequestException ** 當用戶端提交格式不正確的請求時，會擲回此例外狀況。 HTTP 狀態碼：400 ## 範例 ### 請求範例下列範例會啟用 DataSync 代理程式。 ``` { "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 SDKs中使用此 API 的詳細資訊，請參閱下列內容： + [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/datasync-2018-11-09/CreateAgent) + [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/datasync-2018-11-09/CreateAgent) + [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/datasync-2018-11-09/CreateAgent) + [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/datasync-2018-11-09/CreateAgent) + [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/datasync-2018-11-09/CreateAgent) + [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/datasync-2018-11-09/CreateAgent) + [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/datasync-2018-11-09/CreateAgent) + [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/datasync-2018-11-09/CreateAgent) + [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/datasync-2018-11-09/CreateAgent) + [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/datasync-2018-11-09/CreateAgent)