创建主题
更新时间 2025-11-20 11:12:28
最近更新时间: 2025-11-20 11:12:28
接口功能介绍
创建主题
接口约束
无
URI
POST /v3/topic/create
路径参数 无
Query参数 无
请求参数
请求头header参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| regionId | 是 | String | 资源池编码 | 100054c0416811e9a6690242ac110002 |
请求体body参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| prodInstId | 是 | String | 实例id | d7ed2dbad63843f4bcb3b9dc0955a617 | |
| brokerNameList | 是 | Array of Strings | 关联的Broker节点名称列表，需填写实际部署的Broker节点名称，不可为空数组 | ["broker_1"] | |
| writeQueueNums | 是 | Integer | 主题的写队列数量，用于控制消息写入的并发能力，需为正整数 | 4 | |
| readQueueNums | 是 | Integer | 主题的读队列数量，需与写队列数量保持一致，确保消息消费的负载均衡，需为正整数 | 4 | |
| order | 是 | Boolean | 标识主题是否为顺序消息队列，true表示顺序队列，false表示普通队列 | false | |
| perm | 是 | Integer | 主题的权限控制值，固定可选值为2（只读）、4（只写）、6（读写），默认推荐6 | 6 | |
| allowdConsumerGroups | 是 | Array of Strings | 允许订阅该主题的消费者组列表，空数组表示不限制消费者组订阅 | [] | |
| topicName | 是 | String | 主题名称，需符合MQ主题命名规范（字母、数字、下划线组合，长度1-64字符），不可重复 | test1 |
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| statusCode | String | 接口系统层面状态码。成功："800"，失败："900"。 | 800 | |
| message | String | 描述状态。 | ||
| returnObj | Object | 返回对象。 | ||
| error | String | 错误码，描述错误信息。 |
枚举参数
无
请求示例
请求url
https://[endpoint].ctapi.ctyun.cn/v3/topic/create
请求头header
无
请求体body
{
"readQueueNums": 4,
"perm": 6,
"writeQueueNums": 4,
"topicName": "topicTest",
"prodInstId": "d7ed2dbad63843f4bcb3b9dc0955a617",
"brokerNameList": [
"broker_1"
],
"order": false
}
响应示例
响应成功示例
{
"returnObj":{},
"message":"success",
"statusCode":800
}
响应失败示例
{
"returnObj": {},
"message": "...",
"error":"201",
"statusCode": "900"
}
状态码
请参考 状态码
错误码
请参考 错误码
