创建实例
更新时间 2025-12-10 10:48:39
最近更新时间: 2025-12-10 10:48:39
接口功能介绍
开通RocketMQ实例
接口约束
无
URI
POST /v3/instance/createPostPayOrder
路径参数 无
Query参数 无
请求参数
请求头header参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| regionId | 是 | String | 资源池编码 | 200000002368 |
请求体body参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| specName | 是 | String | 规格名称，通过规格接口获取支持的规格列表 | rocketmq.2u4g.cluster | |
| billMode | 否 | Integer | 计费模式 取值范围: 1为预付费，即包年包月，包周期； 2为后付费，即按需； 默认值为按需。 | 2 | |
| cycleCnt | 否 | Integer | billMode为1时生效且为必选值，表示预付费的订购周期时长，单位：月。 取值范围：1，2，3，4，5，6，12，24，36 | 1 | |
| autoRenew | 否 | Boolean | 预付费实例是否自动续订 取值范围： true：自动续订。 false：不自动续订。 默认不自动续订。 | false | |
| autoRenewCycleCount | 否 | Integer | autoRenew为true时生效且为必选值，表示自动续订的周期时长，单位：月。 取值范围：1，2，3，4，5，6，12，24，36 | 1 | |
| nodeNum | 是 | Integer | broker的节点数，值等于代理数*2，取值范围为[1，32]，单机版传1 | 2 | |
| diskType | 是 | String | 存储类型 SAS 、SSD、FAST-SSD | SSD | |
| diskSize | 是 | Integer | 节点存储空间大小,单位G | 100 | |
| azInfo | 是 | String | az信息通过规格接口查询，支持单可用区和三可用区 | ||
| vpcId | 是 | String | 私有云ID | ||
| securityGroupId | 是 | String | 安全组ID | ||
| subnetId | 是 | String | 子网ID | ||
| clusterName | 是 | String | 实例名称 | MQ-openAPI |
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| statusCode | String | 接口系统层面状态码。成功：800，失败：900 | ||
| message | String | 描述状态 | ||
| returnObj | String | 返回对象 | returnObj | |
| error | String | 错误码，只有非成功才有这个字段，方便快速定位问题 | 201 | |
| 表 returnObj |
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| data | Object | 订单核心数据。仅接口调用成功时返回 | OrderData | |
| 表 OrderData |
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| submitted | Boolean | 订单是否提交成功标识 | true | |
| newOrderId | String | 系统生成的订单唯一标识ID | 9a439b4646784662a0672cc3df35b164 | |
| newOrderNo | String | 系统生成的业务订单编号 | 20250716144120097418 | |
| totalPrice | String | 订单总价格。按需返回 | null |
枚举参数
无
请求示例
请求url
https://[endpoint].ctapi.ctyun.cn/v3/instance/createPostPayOrder
请求头header
regionId: bb9fdb42056f11eda1610242ac110002
请求体body
{
"specName": "rocketmq.4u8g.cluster",
"billMode": 1,
"cycleCnt": 1,
"engineType": "ctgmq-advance",
"nodeNum": 2,
"diskType": "SAS",
"diskSize": 100,
"azInfo":"[{\"azName\":\"cn-xinan1-1A\",\"azId\":337}]",
"vpcId": "vpc-7reh61pveb",
"subnetId": "subnet-abug44gdbf",
"securityGroupId": "sg-o0mrfucmol",
"clusterName":"MQtest_API"
}
响应示例
{
"message": "success",
"returnObj": {
"data": {
"submitted": true, //是否已经提交
"newOrderId": "9a439b4646784662a0672cc3df35b164",// 订单id
"newOrderNo": "20250716144120097418",// 订单号
"totalPrice": null// 总价格，按需该字段为null
}
},
"statusCode": 800
}
状态码
请参考 状态码
错误码
请参考 错误码
