本文属于机器翻译版本。若本译文内容与英语原文存在差异，则一律以英文原文为准。

# CreateAgent
<a name="API_CreateAgent"></a>

激活您在存储环境中部署的 AWS DataSync 代理。激活过程会将代理与您的关联 AWS 账户。

如果您尚未部署代理，请参阅[我需要 DataSync代理吗？](https://docs.aws.amazon.com/datasync/latest/userguide/do-i-need-datasync-agent.html) 

## 请求语法
<a name="API_CreateAgent_RequestSyntax"></a>

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

## 请求参数
<a name="API_CreateAgent_RequestParameters"></a>

有关所有操作的通用参数的信息，请参阅[常用参数](CommonParameters.md)。

请求接受采用 JSON 格式的以下数据。

 ** [ActivationKey](#API_CreateAgent_RequestSyntax) **   <a name="DataSync-CreateAgent-request-ActivationKey"></a>
指定 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) **   <a name="DataSync-CreateAgent-request-AgentName"></a>
指定代理名称。我们建议您指定一个您可以记住的名称。  
类型：字符串  
长度限制：最小长度为 0。最大长度为 256。  
模式：`^[a-zA-Z0-9\s+=._:@/-]+$`  
必需：否

 ** [SecurityGroupArns](#API_CreateAgent_RequestSyntax) **   <a name="DataSync-CreateAgent-request-SecurityGroupArns"></a>
指定允许代理与 VPC 服务端点之间流量的安全组的 Amazon 资源名称（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}:security-group/sg-[a-f0-9]+$`  
必需：否

 ** [SubnetArns](#API_CreateAgent_RequestSyntax) **   <a name="DataSync-CreateAgent-request-SubnetArns"></a>
指定 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) **   <a name="DataSync-CreateAgent-request-Tags"></a>
指定可帮助您对 AWS 资源进行分类、筛选和搜索的标签。我们建议为您的代理创建至少一个标签。  
类型：[TagListEntry](API_TagListEntry.md) 对象数组  
数组成员：最少 0 个物品。最多 50 项。  
必需：否

 ** [VpcEndpointId](#API_CreateAgent_RequestSyntax) **   <a name="DataSync-CreateAgent-request-VpcEndpointId"></a>
指定您正在使用的 [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}$`  
必需：否

## 响应语法
<a name="API_CreateAgent_ResponseSyntax"></a>

```
{
   "AgentArn": "string"
}
```

## 响应元素
<a name="API_CreateAgent_ResponseElements"></a>

如果此操作成功，则该服务将会发送回 HTTP 200 响应。

服务以 JSON 格式返回以下数据。

 ** [AgentArn](#API_CreateAgent_ResponseSyntax) **   <a name="DataSync-CreateAgent-response-AgentArn"></a>
您刚激活的代理的 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}$`

## 错误
<a name="API_CreateAgent_Errors"></a>

有关所有操作的常见错误信息，请参阅 [常见错误](CommonErrors.md)。

 ** InternalException **   
当 AWS DataSync 服务中发生错误时，会引发此异常。  
HTTP 状态代码：500

 ** InvalidRequestException **   
当客户端提交格式错误的请求时，会引发此异常。  
HTTP 状态代码：400

## 示例
<a name="API_CreateAgent_Examples"></a>

### 示例请求
<a name="API_CreateAgent_Example_1"></a>

以下示例激活 DataSync 代理。

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

### 示例响应
<a name="API_CreateAgent_Example_2"></a>

响应返回已激活代理的 ARN。

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

## 另请参阅
<a name="API_CreateAgent_SeeAlso"></a>

有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容：
+  [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/datasync-2018-11-09/CreateAgent) 
+  [AWS 适用于.NET 的 SDK V4](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 v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/datasync-2018-11-09/CreateAgent) 
+  [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datasync-2018-11-09/CreateAgent) 
+  [AWS JavaScript V3 版软件开发工具包](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 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/datasync-2018-11-09/CreateAgent) 
+  [AWS Python 软件开发工具包](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)