文档中心

存储迁移服务

代理组

ListAgentGroups - 列举代理组

调用 ListAgentGroups 接口列举代理组。

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

下方仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。

Action string 必选示例值：ListAgentGroups

要执行的操作，取值：ListAgentGroups。

Version string 必选示例值：2025-01-01

API的版本，取值：2025-01-01。

PageSize integer 必选示例值：100

分页大小。

IdCursor string 必选示例值：267

分页 Marker。

PageNumber integer 必选示例值：1

页码。

FetchCount boolean 可选示例值：true

是否获取总数。

返回参数

下方仅列出本接口特有的返回参数。更多信息请参见返回结构。

HasNext boolean 示例值：true

是否含有下一页。

ItemList object[] 示例值：-

代理组信息。

DeployArea string 示例值：CloudOverlay

部署区域，取值类型说明：

CloudOverlay：云上 VPC 网络

Premises：线下 IDC 环境

Id string 示例值：1*

代理组 ID。

AccountId string 示例值：210000****

账号 ID。

AgentGroupName string 示例值：agent-group-name

代理组名称。

DeployType string 示例值：HalfManaged

部署类型，取值为 HalfManaged：半托管。

CreateAt string 示例值：1766974902040

创建时间，毫秒时间戳。

UpdateAt string 示例值：1766974902040

更新时间，毫秒时间戳。

TotalCount integer 示例值：100

代理组总数。

请求示例

GET /?Action=ListAgentGroups&Version=2025-01-01&PageSize=100&IdCursor=267&PageNumber=1 HTTP/1.1​
Host: dms.cn-beijing.volcengineapi.com​
X-Date: 20251009T085811Z​
Authorization: HMAC-SHA256 Credential=Adfks******wekfwe/20251009/cn-beijing/dms/request, SignedHeaders=host;x-date, Signature=47a7d934ff7b37c03938******cd7b8278a40a1057690c401e92246a0e41085f​
​
​

返回示例

{​
  "ResponseMetadata": {​
    "RequestId": "20251009165815186220226170D451D5",​
    "Action": "ListAgentGroups",​
    "Version": "2025-01-01",​
    "Service": "dms",​
    "Region": "cn-beijing"​
  },​
  "Result": {​
    "HasNext": true,​
    "ItemList": [​
      {​
        "DeployArea": "CloudOverlay",​
        "Id": "1*",​
        "AccountId": "210000****",​
        "AgentGroupName": "agent-group-name",​
        "DeployType": "HalfManaged",​
        "CreateAt": "1766974902040",​
        "UpdateAt": "1766974902040"​
      }​
    ],​
    "TotalCount": 100​
  }​
}​

错误码

下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。

状态码	错误码	错误信息	说明
400	2002-00000012	InvalidRequestBody	参数错误。
404	2002-00000014	EntityNotFoundErr	对应实体不存在。
500	2001-00000001	ServiceInternalErr	服务端异常，请稍后重试。

最近更新时间：2026.01.27 18:52:33

这个页面对您有帮助吗？

有用

无用