查询实例基本信息
更新时间 2025-11-18 17:45:51
最近更新时间: 2025-11-18 17:45:51
接口功能介绍
查询实例基本信息
接口约束
无
URI
GET /v3/instance/baseInfo
路径参数 无
Query参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| prodInstId | 是 | String | 实例id | 079ba066b4fc4bb694696d14d27ddb63 |
请求参数
请求头header参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| regionId | 是 | String | 资源池编码 | 100054c0416811e9a6690242ac110002 |
请求体body参数 无
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| statusCode | String | 接口系统层面状态码。成功："800"，失败："900"。 | 800 | |
| message | String | 接口调用状态描述。成功时为"success"，失败时为具体失败信息 | success | |
| returnObj | Object | 核心返回对象 | returnObj | |
| error | String | 错误码。仅失败时返回，描述具体错误信息 | 201 | |
| 表 returnObj |
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| instanceBaseInfo | Object | MQ实例基础信息详情。仅接口调用成功时返回 | InstanceBaseInfo | |
| 表 InstanceBaseInfo |
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| prodInstId | String | 实例id | 079ba066b4fc4bb694696d14d27ddb63 | |
| billMode | String | 计费模式 1：包周期；2：按需 | 2 | |
| prodInstName | String | MQ实例名称 | MQ2-7wrfcp | |
| runningState | String | 实例运行状态 | 运行中 | |
| prodType | String | 产品类型 | 1M1S | |
| machineSpec | String | 机器规格 | rocketmq.4u8g.cluster | |
| tpsLimit | String | TPS限制值 | 5000 | |
| topicLimit | String | Topic数量限制。按需返回，可能为null | null | |
| diskSpace | String | 磁盘空间大小 | 100G | |
| netName | String | 网络名称（VPC名称） | redis-1 | |
| subnet | String | 子网名称 | redis-subnet-01 | |
| securityGroup | String | 安全组ID | 44115 | |
| expTime | String | 过期时间。按需返回，可能为null | null | |
| nameServer | String | NameServer地址列表，多个地址以分号分隔 | 192.168.1.134:9101;192.168.1.132:9101;192.168.1.130:9101 | |
| crtTime | String | 创建时间（UTC格式） | 2025-11-12T03:46:13.000+00:00 |
枚举参数
无
请求示例
请求url
https://[endpoint].ctapi.ctyun.cn/v3/instance/baseInfo
请求头header
无
请求体body
无
响应示例
响应成功示例
{
"message": "success",
"returnObj": {
"instanceBaseInfo": {
"prodInstId": "079ba066b4fc4bb694696d14d27ddb63",
"billMode": "2",
"prodInstName": "MQ2-7wrfcp",
"runningState": "运行中",
"prodType": "1M1S",
"machineSpec": "rocketmq.4u8g.cluster",
"tpsLimit": "5000",
"topicLimit": null,
"diskSpace": "100G",
"netName": "redis-1",
"subnet": "redis-subnet-01",
"securityGroup": "44115",
"expTime": null,
"nameServer": "192.168.1.134:9101;192.168.1.132:9101;192.168.1.130:9101",
"crtTime": "2025-11-12T03:46:13.000+00:00"
}
},
"statusCode": 800
}
响应失败示例
{
"returnObj": {},
"message": "...",
"error":"201",
"statusCode": 900
}
状态码
请参考 状态码
错误码
请参考 错误码
