实例列表查询
更新时间 2025-12-03 09:42:58
最近更新时间: 2025-12-03 09:42:58
接口功能介绍
实例列表查询
接口约束
无
URI
GET /v3/api/instances
路径参数 无
Query参数 无
请求参数
请求头header参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| regionId | 是 | String | 资源池编码 | bb9fdb42056f11eda1610242ac110002 华东1 |
请求体body参数 无
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| message | String | 错误信息 | ||
| statusCode | String | 800-成功 其他失败 | ||
| returnObj | Array of Objects | returnObj | returnObj | |
| error | String | 错误码 | ||
| 表 returnObj |
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| prodInstId | String | 实例ID | ||
| instanceName | String | 实例名称 | ||
| status | String | 实例状态 | ||
| vip | String | 内网接入地址 | ||
| vipv6 | String | 内网接入地址(IPv6) |
枚举参数
参数名 status
| 枚举值 | 类型 | 说明 |
|---|---|---|
| 1 | String | 运行中 |
| -1 | String | 开通中 |
| 2 | String | 已过期 |
| 5 | String | 规格变更中 |
| 6 | String | 网络变更中 |
| 20 | String | 配置变更中 |
请求示例
请求url
https://mqtt-global.ctapi.ctyun.cn/v3/api/instances
请求头header
{
"regionId":"bb9fdb42056f11eda1610242ac110002"
}
请求体body
无
响应示例
{
“statusCode”: 800,
"returnObj": [
{
"prodInstId": "445d30ce3d5d40a2a79dc444a8c83859"，
“instanceName”： “mqtt-test”,
"status": 1,
"vip": "192.168.0.3",
"vipv6": "2001:db8:85a3::8a2e:370:7334"
}
]
}
状态码
请参考 状态码
错误码
请参考 错误码
