ListAgents - Amazon DataSync
请求语法请求参数响应语法响应元素错误另请参阅
Amazon Web Services 文档中描述的 Amazon Web Services 服务或功能可能因区域而异。要查看适用于中国区域的差异，请参阅 中国的 Amazon Web Services 服务入门 (PDF)。

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

ListAgents

返回 Amazon DataSync 代理的列表，这些代理属于请求中指定的 Amazon Web Services 区域 中的 Amazon Web Services 账户。

通过分页，您可以减少响应时返回的代理数量。如果您在响应中收到截断的代理列表，则响应中包含一个标记，您可以在下一个请求中指定该标记，以获取下一页的代理。

ListAgents 是最终一致的。这意味着运行该操作的结果可能无法反映出您刚刚创建或删除了一个代理。例如，如果您使用 CreateAgent 创建代理，然后立即运行 ListAgents，则该代理可能不会立即显示在列表中。在这种情况下，您可以通过使用 DescribeAgent 随时确认代理是否已创建（或删除）。

请求语法

{
   "MaxResults": number,
   "NextToken": "string"
}

请求参数

有关所有操作的通用参数的信息，请参阅常用参数。

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

MaxResults

指定要在响应中列出的 DataSync 代理的最大 DataSync 代理数。默认情况下，响应最多显示 100 个代理。

类型：整数

有效范围：最小值为 0。最大值为 100。

必需：否

NextToken

指定一个不透明的字符串，用于指示响应中下一个结果列表的起始位置。

类型：字符串

长度约束：最大长度为 65535。

模式：[a-zA-Z0-9=_-]+

必需：否

响应语法

{
   "Agents": [ 
      { 
         "AgentArn": "string",
         "Name": "string",
         "Platform": { 
            "Version": "string"
         },
         "Status": "string"
      }
   ],
   "NextToken": "string"
}

响应元素

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

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

Agents

请求中指定 Amazon Web Services 区域 中 Amazon Web Services 账户 的 DataSync 代理列表。该列表按代理的 Amazon 资源名称 (ARN) 排序。

类型：AgentListEntry 对象数组

NextToken

不透明字符串，用于指示响应中下一个结果列表的起始位置。

类型：字符串

长度约束：最大长度为 65535。

模式：[a-zA-Z0-9=_-]+

错误

有关所有操作的常见错误信息，请参阅 常见错误。

InternalException

当 Amazon DataSync 服务中发生错误时，会引发此异常。

HTTP 状态代码：500

InvalidRequestException

当客户端提交格式错误的请求时，会引发此异常。

HTTP 状态代码：400

另请参阅

有关在特定语言的 Amazon SDK 中使用此 API 的更多信息，请参阅以下内容：