获取实例列表
更新时间 2025-11-19 14:32:14
最近更新时间: 2025-11-19 14:32:14
接口功能介绍
查询实例列表。
接口约束
无
URI
GET /rcc/v1/cluster/list
路径参数 无
Query参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| instanceId | 否 | String | 实例ID | 8e3a382e241d11ed957c0242ac110006 | |
| instName | 否 | String | 实例名 | MSECM-xxx | |
| engineType | 否 | String | 引擎类型,可选值:nacos、eureka和zookeeper | nacos | |
| status | 否 | Integer | 实例状态,可选值:1,2,3,5,101,201,998,999 | 1 | |
| pageNum | 否 | Integer | 页码 | 1 | |
| pageSize | 否 | Integer | 分页大小 | 10 |
请求参数
请求头header参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| regionId | 是 | String | 资源池 ID | d8bbd132b53a11e9b0e40242ac110002 |
请求体body参数 无
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| statusCode | Integer | 返回状态码(2000成功,5000系统错误,18xxxx业务错误) | 1000 | |
| error | String | 业务错误码,RCC_statusCode | RCC_1000 | |
| message | String | 返回结果描述 | invalid param | |
| returnObj | Object | 返回数据体 | returnObj | |
| 表 returnObj |
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| records | Array of Objects | 实例列表 | records | |
| total | Integer | 总条数 | 17 | |
| size | Integer | 分页大小 | 10 | |
| current | Integer | 当前页码 | 1 | |
| pages | Integer | 总页数 | 2 | |
| 表 records |
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| spuInstId | String | 实例ID | ad68937a003e4afbbdf2100c2f4b6ff0 | |
| tenantId | Long | 租户ID | 1234 | |
| userId | Long | 用户ID | 1234 | |
| spuCode | String | 产品编码 | msercm | |
| seriesCode | String | 系列编码 | msercm.eureka | |
| engineType | String | 引擎类型 | nacos | |
| versionNo | String | 产品版本 | 2.8.4 | |
| skuCode | String | 产品批次规格编码 | msercm.eureka.s1 | |
| prodInstName | String | 实例名称 | nacos-test | |
| prodInstAttrs | String | 实例属性 | ||
| createTimestamp | String | 创建时间 | 2023-10-09 10:37:31 | |
| updateTimestamp | String | 更新时间 | 2023-10-09 10:37:31 | |
| status | Integer | 实例状态 | 1 | |
| lastRefTime | String | 上次刷新时间 | 2023-10-09 10:37:31 | |
| tenantCode | String | 租户编码 | Ctyun6cf921601a2c4ac11688088111 | |
| regionCode | String | 资源池编码 | d8bbd132b53a11e9b0e40242ac110002 | |
| regionName | String | 资源池 | 华东1 | |
| regionVersion | Integer | 资源池版本 | 1 | |
| securityGroupUuid | String | 安全组ID | 9d40a252-2c28-4519-924b-b34f5fb30151 | |
| securityGroupName | String | 安全组 | security-vw1f | |
| subnetName | String | 子网名称 | paas-1 | |
| subnetUuid | String | 子网ID | 04efe2c3-7d6f-4f08-a38e-06f6dd622b31 | |
| vpcUuid | String | VPC ID | 1581db10-6915-4235-b302-f177210d9b32 | |
| vpcName | String | VPC名称 | pass-1 | |
| azInfo | String | 可用区信息 | [{azId:000,azName:az-test}] | |
| prodSrc | String | 产品来源 | 2 | |
| billMode | Integer | 付费类型 | 2 | |
| expTime | String | 过期时间 | 2023-10-09 10:37:31 | |
| instanceNum | Integer | 集群节点数 | 3 |
枚举参数
无
请求示例
请求url
http://endpoint.cn/v1/cluster/list
请求头header
{"regionId": "d8bbd132b53a11e9b0e40242ac110002"}
请求体body
无
响应示例
{
"statusCode": 0,
"message": "string",
"returnObj": {
"records": [
{
"spuInstId": "string",
"tenantId": 0,
"userId": null,
"spuCode": "string",
"seriesCode": "string",
"engineType": "string",
"versionNo": "string",
"skuCode": "string",
"prodInstName": "string",
"prodInstAttrs": "string",
"createTimestamp": "string",
"updateTimestamp": "string",
"status": 0,
"lastRefTime": "string",
"tenantCode": "string",
"regionCode": "string",
"regionName": "string",
"regionVersion": "string",
"securityGroupUuid": "string",
"securityGroupName": "string",
"subnetName": "string",
"subnetUuid": "string",
"vpcUuid": "string",
"vpcName": "string",
"azInfo": "string",
"prodSrc": "string",
"billMode": 0,
"expTime": "string",
"instanceNum": 0,
"msg": "string"
}
],
"total": 0,
"size": 0,
"current": 0,
"orders": [
"string"
],
"optimizeCountSql": true,
"hitCount": true,
"countId": null,
"maxLimit": null,
"searchCount": true,
"pages": 0
}
}
状态码
请参考 状态码
错误码
请参考 错误码