接口功能介绍

实例列表

接口约束

无

URI

GET /v3/instance/list

路径参数 无

Query参数 无

请求参数

请求头header参数

参数	是否必填	参数类型	说明	示例	下级对象
regionId	是	String	资源池编码	100054c0416811e9a6690242ac110002

请求体body参数 无

响应参数

参数	参数类型	说明	示例	下级对象
statusCode	String	接口系统层面状态码。成功："800"，失败："900"。	800
message	String	接口调用状态描述。成功时为"success"，失败时为具体失败信息	success
returnObj	Object	核心返回对象。成功时包含MQ实例列表数据，失败时为空对象		returnObj
error	String	错误码。仅失败时返回，描述具体错误信息	201
表 returnObj

参数	参数类型	说明	示例	下级对象
prodInstList	Array of Objects	MQ实例列表数据。仅接口调用成功时返回		ProdInstInfo
表 ProdInstInfo

参数	参数类型	说明	示例	下级对象
prodInstId	String	实例id	091081efb5c34cb78a0fcbcd9e253515
billMode	String	计费模式 1：包周期；2：按需	2
prodInstName	String	MQ实例名称	MQ2-ok9xtk
runningState	String	实例运行状态	运行中
state	Integer	实例状态编码 1.运行中 2.已过期 3.已注销 4.已退订 5.扩容中 6.开通中 7.已取消 8.缩容中 9.重启中 10.网络变更中 11.运维恢复 12.运维停止 13.异常中 15.已欠费 -1.变更 101.开通失败	1
prodType	String	产品类型	单节点、1M1S
machineSpec	String	机器规格名	rocketmq.2u4g.single、rocketmq.4u8g.cluster
topicLimit	String	Topic数量限制	200
diskSpace	String	磁盘空间大小	100G
netName	String	网络名称（VPC名称）	vpc-48fe-victor、redis-1
subnet	String	子网名称	subnet-913b、redis-subnet-01
securityGroup	String	安全组ID	51170、44115
modTime	String	最后修改时间（UTC格式）	2025-10-31T18:28:14.000+00:00
deployType	String	部署类型编码 1-虚机部署	1
diskType	String	磁盘类型	SSD
diskIsEncrypt	Boolean	磁盘是否加密	false
fileReservedTime	Integer	文件保留时间（单位：小时）	168
clusterProperties	Object	集群配置属性		ClusterProperties
engineType	String	引擎类型	ctgmq-advance
labels	Array of Objects	标签列表		LabelInfo
vip	String	实例VIP地址	192.168.23.30、192.168.1.129
clusterType	Integer	集群类型编码 1-单机版 2-集群版	1
version	String	版本号	5.x、4.9.6
nodeSize	Integer	broker节点数量	1
outerProjectName	String	企业项目名称	default
vpcId	String	VPC ID	18414、17372
enableIpv6	Boolean	是否启用IPv6	false
resources	Array of Strings	资源列表	[]
expandAccess	Array of Strings	可扩展权限列表 MQ2_INST_VM_EXPAND-规格扩容；MQ2_INST_DISK_EXPAND-磁盘扩容；MQ2_INST_NODE_EXPAND-节点扩容	["MQ2_INST_VM_EXPAND", "MQ2_INST_DISK_EXPAND"]
shrinkAccess	Array of Strings	可缩容权限列表 MQ2_INST_VM_SHRINK-规格缩容当前只支持规格缩容	["MQ2_INST_VM_SHRINK"]
crtTime	String	创建时间（UTC格式）	2025-10-31T09:49:24.000+00:00
表 ClusterProperties

参数	参数类型	说明	示例
enableTpsLimit	String	是否启用TPS限制。0：未启用，1：已启用	0
deleteWhen	String	清理时间配置	4
tpsLimit	String	集群级TPS限制值	2500、5000
maxQueuesPerTopic	String	每个Topic最大队列数	8
表 LabelInfo

参数	参数类型	说明	示例
labelId	String	标签唯一标识ID	c2f0324741f349feb2e557e3f09cce7f
key	String	标签键	RY-key-11856
value	String	标签值	RY-val-11856

枚举参数

无

请求示例

请求url

https://[endpoint].ctapi.ctyun.cn/v3/instance/list

请求头header

无

请求体body

无

响应示例

响应成功示例
{
        "message": "success",
        "returnObj": {
                "prodInstList": [
                        {
                                "prodInstId": "091081efb5c34cb78a0fcbcd9e253515",
                                "billMode": "2",
                                "prodInstName": "MQ2-ok9xtk",
                                "runningState": "运行中",
                                "state": 1,
                                "prodType": "单节点",
                                "machineSpec": "rocketmq.2u4g.single",
                                "topicLimit": "200",
                                "diskSpace": "100G",
                                "netName": "vpc-48fe-victor",
                                "subnet": "subnet-913b",
                                "securityGroup": "51170",
                                "modTime": "2025-10-31T18:28:14.000+00:00",
                                "deployType": "1",
                                "diskType": "SSD",
                                "diskIsEncrypt": false,
                                "fileReservedTime": 168,
                                "clusterProperties": {
                                        "enableTpsLimit": "0",
                                        "deleteWhen": "4",
                                        "tpsLimit": "2500",
                                        "maxQueuesPerTopic": "8"
                                },
                                "engineType": "ctgmq-advance",
                                "labels": [],
                                "vip": "192.168.23.30",
                                "clusterType": 1,
                                "version": "5.x",
                                "nodeSize": 1,
                                "outerProjectName": "default",
                                "vpcId": "18414",
                                "enableIpv6": false,
                                "resources": [],
                                "expandAccess": [
                                        "MQ2_INST_VM_EXPAND",
                                        "MQ2_INST_DISK_EXPAND"
                                ],
                                "shrinkAccess": [
                                        "MQ2_INST_VM_SHRINK"
                                ],
                                "crtTime": "2025-10-31T09:49:24.000+00:00"
                        },
                        {
                                "prodInstId": "079ba066b4fc4bb694696d14d27ddb63",
                                "billMode": "2",
                                "prodInstName": "MQ2-7wrfcp",
                                "runningState": "运行中",
                                "state": 1,
                                "prodType": "1M1S",
                                "machineSpec": "rocketmq.4u8g.cluster",
                                "topicLimit": "200",
                                "diskSpace": "100G",
                                "netName": "redis-1",
                                "subnet": "redis-subnet-01",
                                "securityGroup": "44115",
                                "modTime": "2025-11-12T03:46:16.000+00:00",
                                "deployType": "1",
                                "diskType": "SSD",
                                "diskIsEncrypt": false,
                                "fileReservedTime": 168,
                                "clusterProperties": {
                                        "enableTpsLimit": "0",
                                        "deleteWhen": "4",
                                        "tpsLimit": "5000",
                                        "maxQueuesPerTopic": "8"
                                },
                                "engineType": "ctgmq-advance",
                                "labels": [],
                                "vip": "192.168.1.129",
                                "clusterType": 2,
                                "version": "4.9.6",
                                "nodeSize": 2,
                                "outerProjectName": "default",
                                "vpcId": "17372",
                                "enableIpv6": false,
                                "resources": [],
                                "expandAccess": [
                                        "MQ2_INST_VM_EXPAND",
                                        "MQ2_INST_DISK_EXPAND",
                                        "MQ2_INST_NODE_EXPAND"
                                ],
                                "shrinkAccess": [
                                        "MQ2_INST_VM_SHRINK"
                                ],
                                "crtTime": "2025-11-12T03:46:13.000+00:00"
                        }
                ]
        },
        "statusCode": 800
}
响应失败示例
{
    "returnObj": {},
    "message": "...",
    "error":"201",
    "statusCode": 900
}

状态码

请参考状态码

错误码

请参考错误码

息壤智算

应用商城

定价

合作伙伴

开发者

支持与服务

了解天翼云

分布式消息服务RocketMQ

分布式消息服务RocketMQ

接口功能介绍

接口约束

URI

请求参数

响应参数

枚举参数

请求示例

响应示例

状态码

错误码

活动

息壤智算

应用商城

定价

合作伙伴

开发者

支持与服务

了解天翼云

分布式消息服务RocketMQ

分布式消息服务RocketMQ

接口功能介绍

接口约束

URI

请求参数

响应参数

枚举参数

请求示例

响应示例

状态码

错误码