创建半托管迁移代理
更新时间 2026-03-05 11:40:21
最近更新时间: 2026-03-05 11:40:21
接口功能介绍
创建半托管迁移代理
接口约束
1、支持的线上资源池 ：华东1
2、单个用户可创建最多5个代理，若您已调整了配额，则以调整后的配额为准。
URI
POST /v4/zms/create-agent
路径参数 无
Query参数 无
请求参数
请求头header参数 无
请求体body参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| regionID | 是 | String | 资源池ID | 81f7728xxxxx0155d307d5b | |
| agentName | 是 | String | 代理名称，必须为大小写字母、数字、横线或下划线，长度在4-32个字符之间，名称不能重复 | agentkunkun |
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| 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
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| result | String | 任务结果 | success | |
| agentID | String | 代理ID | 222_agt_ddc4bXXXc4db1331c8fc8 | |
| registrationCode | String | 代理校验码 | 1761116146_222_agt_ddc4b920XXX1331c8fc8_IMaj12oc |
枚举参数
无
请求示例
请求url
无
请求头header
无
请求体body
{
"regionID":"81f7728xxxxx0155d307d5b",
"agentName":"agentkunkun"
}
响应示例
{
"returnObj": {
"registrationCode": "1761116146_222_agt_ddc4b920XXX1331c8fc8_IMaj12oc",
"agentID": "222_agt_ddc4bXXXc4db1331c8fc8",
"result": "success"
},
"details": "",
"message": "SUCCESS",
"description": "成功",
"statusCode": 800
}
状态码
请参考 状态码
错误码
请参考 错误码
