You need to enable JavaScript to run this app.
文档中心
存储迁移服务

存储迁移服务

复制全文
下载 pdf
代理
ListAgents - 列举代理
复制全文
下载 pdf
ListAgents - 列举代理
调用 ListAgents 接口列举代理。​
调试​
API Explorer
您可以通过 API Explorer 在线发起调用,无需关注签名生成过程,快速获取调用结果。
​
请求参数​
下方仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。​
Action string 必选 示例值:ListAgents​
要执行的操作,取值:ListAgents。​
​
Version string 必选 示例值:2025-01-01​
API的版本,取值:2025-01-01。​
​
PageSize integer 必选 示例值:100​
分页大小。​
​
IdCursor string 必选 示例值:267​
分页 Marker。​
​
PageNumber integer 必选 示例值:1​
页码。​
​
FetchCount boolean 可选 示例值:true​
是否获取总数。​
​
​
​
返回参数​
下方仅列出本接口特有的返回参数。更多信息请参见返回结构。​
HasNext boolean 示例值:false​
是否含有下一页。​
​
TotalCount integer 示例值:1​
代理组总数。​
​
ItemList object[] 示例值:-​
代理信息。​
Id string 示例值:1*​
代理 ID。​
​
AccountId string 示例值:210000****​
账号 ID。​
​
Alias string 示例值:aaaa​
代理别名。​
​
AgentGroupId string 示例值:1*​
代理组 ID。​
​
RunningMode string 示例值:Process​
运行模式, 取值为:​
Process:独立进程。​
​
NetworkType string 示例值:Public​
网络类型,取值说明如下:​
  • Public:公网。​
  • Vpc:私有网络。​
​
Status boolean 示例值:true​
是否正常运行。​
​
CreateAt string 示例值:1764748140000​
创建时间,使用毫秒时间戳。​
​
UpdateAt string 示例值:1764748140000​
更新时间,使用毫秒时间戳。​
​
​
​
​
请求示例​
​
GET /?Action=ListAgents&Version=2025-01-01&PageSize=100&IdCursor=267&PageNumber=1 HTTP/1.1​
Host: dms.cn-beijing.volcengineapi.com​
X-Date: 20251009T091422Z​
Authorization: HMAC-SHA256 Credential=Adfks******wekfwe/20251009/cn-beijing/dms/request, SignedHeaders=host;x-date, Signature=47a7d934ff7b37c03938******cd7b8278a40a1057690c401e92246a0e41085f​
​
​
​
返回示例​
​
{​
"ResponseMetadata": {​
"RequestId": "20251009171427157042192138C5DCF8",​
"Action": "ListAgents",​
"Version": "2025-01-01",​
"Service": "dms",​
"Region": "cn-beijing"​
},​
"Result": {​
"HasNext": false,​
"TotalCount": 424,​
"ItemList": {​
"Id": "1*",​
"AccountId": "210000****",​
"Alias": "aaaa",​
"AgentGroupId": "1*",​
"RunningMode": "Process",​
"NetworkType": "Public",​
"Status": true,​
"CreateAt": "1764748140000",​
"UpdateAt": "1764748140000"​
}​
}​
}​
​
错误码​
下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。​
​
状态码​
错误码​
错误信息​
说明​
400​
2002-00000012​
InvalidRequestBody​
参数错误。​
404​
2002-00000014​
EntityNotFoundErr​
对应实体不存在。​
500​
2001-00000001​
ServiceInternalErr​
服务端异常,请稍后重试。​
​
​
最近更新时间:2026.01.09 10:14:35
这个页面对您有帮助吗?
有用
有用
无用
无用