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

# ListAgents
<a name="API_ListAgents"></a>

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

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

 `ListAgents` 是最终一致的。这意味着运行该操作的结果可能无法反映出您刚刚创建或删除了一个代理。例如，如果您使用创建代理[CreateAgent](https://docs.amazonaws.cn/datasync/latest/userguide/API_CreateAgent.html)然后立即运行`ListAgents`，则该代理可能不会立即显示在列表中。在这种情况下，您可以随时使用确认代理是否已创建（或删除）[DescribeAgent](https://docs.amazonaws.cn/datasync/latest/userguide/API_DescribeAgent.html)。

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

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

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

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

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

 ** [MaxResults](#API_ListAgents_RequestSyntax) **   <a name="DataSync-ListAgents-request-MaxResults"></a>
指定要在响应中列出的 DataSync 代理的最大数量。默认情况下，响应最多显示 100 个代理。  
类型：整数  
有效范围：最小值为 0。最大值为 100。  
必需：否

 ** [NextToken](#API_ListAgents_RequestSyntax) **   <a name="DataSync-ListAgents-request-NextToken"></a>
指定一个不透明的字符串，用于指示响应中下一个结果列表的起始位置。  
类型：字符串  
长度约束：最大长度为 65535。  
模式：`[a-zA-Z0-9=_-]+`  
必需：否

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

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

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

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

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

 ** [Agents](#API_ListAgents_ResponseSyntax) **   <a name="DataSync-ListAgents-response-Agents"></a>
请求 Amazon Web Services 账户 中 Amazon Web Services 区域 指定的您的 DataSync 代理列表。该列表按代理商的 Amazon 资源名称 (ARNs) 排序。  
类型：[AgentListEntry](API_AgentListEntry.md) 对象数组

 ** [NextToken](#API_ListAgents_ResponseSyntax) **   <a name="DataSync-ListAgents-response-NextToken"></a>
不透明字符串，用于指示响应中下一个结果列表的起始位置。  
类型：字符串  
长度约束：最大长度为 65535。  
模式：`[a-zA-Z0-9=_-]+`

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

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

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

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

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

有关以特定语言之一使用此 API 的更多信息 Amazon SDKs，请参阅以下内容：
+  [Amazon 命令行界面 V2](https://docs.amazonaws.cn/goto/cli2/datasync-2018-11-09/ListAgents) 
+  [Amazon 适用于.NET 的 SDK V4](https://docs.amazonaws.cn/goto/DotNetSDKV4/datasync-2018-11-09/ListAgents) 
+  [Amazon 适用于 C\+\+ 的 SDK](https://docs.amazonaws.cn/goto/SdkForCpp/datasync-2018-11-09/ListAgents) 
+  [Amazon 适用于 Go v2 的 SDK](https://docs.amazonaws.cn/goto/SdkForGoV2/datasync-2018-11-09/ListAgents) 
+  [Amazon 适用于 Java 的 SDK V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/datasync-2018-11-09/ListAgents) 
+  [Amazon JavaScript V3 版软件开发工具包](https://docs.amazonaws.cn/goto/SdkForJavaScriptV3/datasync-2018-11-09/ListAgents) 
+  [Amazon 适用于 Kotlin 的 SDK](https://docs.amazonaws.cn/goto/SdkForKotlin/datasync-2018-11-09/ListAgents) 
+  [Amazon 适用于 PHP 的 SDK V3](https://docs.amazonaws.cn/goto/SdkForPHPV3/datasync-2018-11-09/ListAgents) 
+  [Amazon Python 软件开发工具包](https://docs.amazonaws.cn/goto/boto3/datasync-2018-11-09/ListAgents) 
+  [Amazon 适用于 Ruby V3 的 SDK](https://docs.amazonaws.cn/goto/SdkForRubyV3/datasync-2018-11-09/ListAgents)