本文属于机器翻译版本。若本译文内容与英语原文存在差异，则一律以英文原文为准。
CreateAgent
激活在存储环境中部署的Amazon DataSync代理。激活过程可将您的代理与账户关联。在激活过程中，您需要指定要在其中激活代理的 Amazon Web Services 区域 等信息。您激活目标位置（位Amazon Web Services 区域于 Amazon S3 或 Amazon EFS）所在的中的代理。您在此 Amazon Web Services 区域 中创建任务。
您可以在 VPC (Virtual Private Cloud) 中激活代理或向代理授予 VPC 终端节点的访问权限，这样无需通过公有互联网即可运行任务。
您可以对多个位置使用代理。如果一个任务使用多个代理，则所有这些代理都需处于“可用”状态，任务才能运行。如果对源位置使用多个代理，则所有这些代理的状态都必须为“可用”才能使任务运行。
有关更多信息，请参阅《Amazon DataSync 用户指南》中的创建和激活代理。
Amazon 通过使用一种确保尽量不中断任务的机制来定期自动更新代理。
请求语法
{
"ActivationKey": "string",
"AgentName": "string",
"SecurityGroupArns": [ "string" ],
"SubnetArns": [ "string" ],
"Tags": [
{
"Key": "string",
"Value": "string"
}
],
"VpcEndpointId": "string"
}请求参数
有关所有操作共享的参数的详细信息，请参阅 Comon Parameters (常用参数)。
请求接受采用 JSON 格式的以下数据。
- ActivationKey
-
您的代理激活密钥。您可以通过发送带有重定向的 HTTP GET 请求来获取激活密钥，重定向可以帮助您获取代理 IP 地址（端口 80）。或者，您也可以从 DataSync 控制台获取。
响应中返回的重定向 URL 在查询字符串参数中为您的代理提供激活密钥
activationKey。它可能还包括其他与激活相关的参数；但是，这些只是默认值。您传递给此 API 调用的参数将决定代理的实际配置。有关更多信息，请参阅《Amazon DataSync 用户指南》中的创建和激活代理。
类型：字符串
长度约束：最大长度为 29。
模式：
[A-Z0-9]{5}(-[A-Z0-9]{5}){4}必需：是
- AgentName
-
您为代理配置的名称。可以将该值用作在控制台中标识代理的文本参考。
类型：字符串
长度限制：最小长度为 1。长度上限为 256。
模式：
^[a-zA-Z0-9\s+=._:@/-]+$必需：否
- SecurityGroupArns
-
用于保护数据传输任务子网的安全组的 ARN。请参阅SecurityGroupArns。
类型：字符串数组
数组成员：固定数量为 1 项。
长度约束：最大长度为 128。
模式：
^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):ec2:[a-z\-0-9]*:[0-9]{12}:security-group/.*$必需：否
- SubnetArns
-
子网的 Amazon 资源名称（ARN）， DataSync 将在其中为每个数据传输任务创建弹性网络接口。运行任务的代理必须为私有代理。当您启动与 VPC 中创建的代理关联的任务或启动可以访问 VPC 中 IP 地址的任务时，该任务也是私有的。在这种情况下，为子网中的每个任务 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
-
表示要与代理关联的标签的键值对。该值可为空字符串。该值可帮助您管理、筛选和搜索代理。
注意
键和值的有效字符包括可用 UTF-8 格式表示的字母、空格和数字，以及以下特殊字符：+ - = . _ : / @。
类型：TagListEntry 对象数组
数组成员：最少 0 项。最多 50 项。
必需：否
- VpcEndpointId
-
代理有权访问的 VPC (Virtual Private Cloud) 终端节点的 ID。这是客户端 VPC 终端节点，也称为 PrivateLink。如果您没有 PrivateLink VPC 终端节点，请参阅 Amazon VPC 用户指南中的创建 VPC 终端节点服务配置。
VPC 终端节点 ID 类似如下内容：
vpce-01234d5aff67890e1。类型：字符串
模式：
^vpce-[0-9a-f]{17}$必需：否
响应语法
{
"AgentArn": "string"
}响应元素
如果此操作成功，则该服务将会发送回 HTTP 200 响应。
服务以 JSON 格式返回的以下数据。
- AgentArn
-
代理的 Amazon 资源名称（ARN）。使用
ListAgents操作以返回账户和 Amazon Web Services 区域 的代理列表。类型：字符串
长度约束：最大长度为 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
-
当Amazon DataSync服务中发生错误时，会抛出此异常。
HTTP 状态代码：500
- InvalidRequestException
-
当客户端提交格式错误的请求时，会引发此异常。
HTTP 状态代码：400
示例
示例
以下示例创建代理并使用激活密钥将其激活。
示例请求
{
"ActivationKey": "AAAAA-7AAAA-GG7MC-3I9R3-27COD",
"AgentName": "MyAgent",
"Tags": [
{
"Key": "Job",
"Value": "TransferJob-1"
}
]
}示例
响应将返回激活的代理 Amazon 资源名称 (ARN)。
示例响应
{
"AgentArn": "arn:aws:datasync:us-east-2:111222333444:agent/agent-0b0addbeef44baca3"
}另请参阅
有关在特定语言的 Amazon 软件开发工具包中使用此 API 的更多信息，请参阅以下内容：