ListAgents - Amazon DataSync
Amazon Web Services 文档中描述的 Amazon Web Services 服务或功能可能因区域而异。要查看适用于中国区域的差异,请参阅 中国的 Amazon Web Services 服务入门 (PDF)

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

ListAgents

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

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

ListAgents致的的的的。这意味着运行操作的结果可能无法反映出您刚刚创建或删除了代理。例如,如果您使用创建代理CreateAgent然后立即运行ListAgents,则该代理可能不会立即出现在列表中。在这种情况下,您可以随时使用来确认代理是否已创建(或删除)DescribeAgent

请求语法

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

请求参数

有关所有操作的常用参数,请参阅常用参数

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

MaxResults

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

类型:整数

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

必需:否

NextToken

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

类型:字符串

长度限制:最大长度为 65535。

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

必需:否

响应语法

{ "Agents": [ { "AgentArn": "string", "Name": "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 软件开发工具包中使用此 API 的更多信息,请参阅以下内容: