查询半托管迁移代理列表
更新时间 2026-03-05 11:40:42
最近更新时间: 2026-03-05 11:40:42
接口功能介绍
查询半托管迁移代理列表
接口约束
支持的线上资源池 ：华东1
URI
GET /v4/zms/list-agent
路径参数 无
Query参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| regionID | 是 | String | 资源池ID | 81f7728xxxxx0155d307d5b | |
| searchName | 否 | String | 搜索代理名称，支持精确和模糊搜索 | my | |
| agentStatus | 否 | String | 筛选代理状态，①unregistered：未注册；②disconnected：未连接；③connected：已连接；④expired：已失效 | unregistered | |
| pageNo | 否 | Integer | 页码，默认值为1 | 2 | |
| pageSize | 否 | Integer | 页大小，默认值 10，取值范围 1~50 | 3 |
请求参数
请求头header参数 无
请求体body参数 无
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| statusCode | Integer | 返回状态码(800为成功，900为处理中/失败) | 800 | |
| message | String | 状态描述 | SUCCESS | |
| returnObj | Object | 响应对象 | returnObj | |
| description | String | 状态描述，一般为中文 | 成功 | |
| errorCode | String | 业务细分码（仅失败时具有此参数），为product.module.code三段式码 | openapi.userPermission.accessFailed | |
| error | String | 业务细分码（大驼峰形式，仅失败时具有此参数），为 Product.Module.Code 三段式码 | Openapi.UserPermission.AccessFailed |
表 returnObj
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| results | Array of Objects | 响应对象 | results | |
| totalCount | Integer | 总数量 | 5 | |
| pageNo | Integer | 当前页码 | 1 | |
| currentCount | Integer | 当前页数量 | 2 | |
| pageSize | Integer | 当前页展示数量 | 10 |
表 results
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| agentName | String | 代理名称 | akaka | |
| agentID | String | 代理ID | 222_agt_e7cc7xxxx103fe3e6395c | |
| regionID | String | 资源池ID | 81f7728xxxxx0155d307d5b | |
| agentStatus | String | 代理状态，①unregistered：未注册；②disconnected：未连接；③connected：已连接；④expired：已失效\ | 请重新创建代理 | connected |
| agentAddress | String | 代理内部地址 | 10.0.0.25 | |
| boundTaskCount | Integer | 代理已绑定任务数量 | 2 | |
| boundTaskList | Array of Objects | 代理上绑定的任务信息 | boundTaskList | |
| lastContactTime | String | 代理最后通信时间，仅当代理状态为“未连接”、“已失效 \ | 请重新创建代理”时展示，其余场景均为null | 2025-10-14 16:37:09 |
| workerCount | Integer | 代理的工作节点数量，展示代理下的worker节点的数量 若代理状态为“已失效 | 请重新创建代理”时，展示为null | 1 | |
| workerAvailableCount | Integer | 代理下状态为“可用”的工作节点数量 | 1 | |
| workerInfo | Array of Objects | 代理master下的所有worker信息，仅代理状态为“已连接”时存在，其余场景为null 代理采用master-worker架构，支持部署多台设备，当您仅部署在单台设备时，工作节点（worker）将与主节点（master）部署在同一设备 | workerInfo | |
| agentCreateTime | String | 代理创建时间 | 2025-09-03 17:17:20 |
表 boundTaskList
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| migrationName | String | 代理上绑定的迁移任务名称 | huaixiong11 | |
| migrationStatus | String | 代理上绑定的迁移任务状态，1.creating：创建中；2.created：已创建；3.create_failed：创建失败|请重新创建任务；4.starting：启动中；5.waiting：排队中；6.executing：迁移中；7.stopping：暂停中；8.stopped：暂停；9.restoring：恢复中；10.agent_lost：代理已失联；11.finished：迁移结束；12.failed：迁移中断；13.finished_error：迁移结束|存在失败对象；14.retrying：重试中；15.deleting：删除中 | finished |
表 workerInfo
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| workerIP | String | worker节点IP | 10.0.0.25:8283 | |
| workerStatus | String | worker节点状态，①available:可用；②error：错误 | available |
枚举参数
无
请求示例
请求url
GET https://zos-global.ctapi.ctyun.cn/v4/zms/list-agent?regionID=81f7728xxxxx0155d307d5b&pageNo=1&pageSize=10
请求头header
无
请求体body
无
响应示例
{
"returnObj": {
"currentCount": 2,
"totalCount": 2,
"pageSize": 10,
"results": [
{
"boundTaskCount": 2,
"agentName": "agentcc",
"boundTaskList": [
{
"migrationName": "chouxiaoxiongxiongxiongxiong",
"migrationStatus": "stopped"
},
{
"migrationName": "huaixiong11",
"migrationStatus": "finished"
}
],
"lastContactTime": null,
"workerCount": 1,
"workeravailableCount": 1,
"agentCreateTime": "2025-09-03 17:17:20",
"workerInfo": [
{
"workerStatus": "available",
"workerIP": "10.0.0.25:8283"
}
],
"regionID": "81f7728xxxxx0155d307d5b",
"agentAddress": "10.0.0.25",
"agentStatus": "connected",
"agentID": "222_agt_e7cc7xxxx103fe3e6395c"
},
{
"boundTaskCount": 0,
"agentName": "agentaa",
"boundTaskList": null,
"lastContactTime": "2025-10-14 16:37:09",
"workerCount": 0,
"agentCreateTime": "2025-08-08 09:42:28",
"workerInfo": null,
"regionID": "81f7728xxxxx0155d307d5b",
"agentAddress": "10.0.0.17",
"agentStatus": "expired",
"agentID": "222_agt_80c6xxxxb992616be45d76402"
}
],
"pageNo": 1
},
"details": "",
"message": "SUCCESS",
"description": "成功",
"statusCode": 800
}
状态码
请参考 状态码
错误码
请参考 错误码
