文档

CreateTopic - 创建主题

更新时间:
一键部署

创建云消息队列 RocketMQ 版的主题(Topic)。主题是云消息队列 RocketMQ 版中消息传输和存储的顶层容器,用于标识同一类业务逻辑的消息。在消息收发模型中,生产者将消息发送至主题,消费者通过订阅指定的主题来消费其中的消息。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
rocketmq:CreateTopicWrite
  • Topic
    acs:rocketmq:{#regionId}:{#accountId}:instance/{#InstanceId}/topic/{#TopicName}

请求语法

POST /instances/{instanceId}/topics/{topicName}

请求参数

名称类型必填描述示例值
instanceIdstring

待创建主题所属的实例的 ID。

rmq-cn-7e22ody****
topicNamestring

待创建主题的名称,用于标识主题,全局唯一。

取值规范如下:

  • 字符限制:支持字母 a~z 或 A~Z、数字 0~9 以及下划线(_)、短划线(-)。
  • 长度限制:1~60 个字符。

保留字符限制,请参见参数限制

topic_test
bodyobject

主题信息。

messageTypestring

待创建主题的消息类型。

参数取值如下:

  • TRANSACTION:事务消息
  • FIFO:顺序消息
  • DELAY:定时/延时消息
  • NORMAL:普通消息

注意 主题的类型和发送消息的类型必须一致。例如,您创建的主题的类型为顺序消息,则该主题只能用于收发顺序消息,不能收发其他类型的消息。

NORMAL
remarkstring

待创建主题的备注信息。

This is the remark for test.

返回参数

名称类型描述示例值
object

Result

requestIdstring

请求 ID,每个请求的 ID 都是唯一的,可用于排查和定位问题。

AF9A8B10-C426-530F-A0DD-96320B39****
successboolean

执行结果是否成功。

true
databoolean

返回结果。

true
codestring

错误码。

Topic.Existed
messagestring

错误信息。

The topic already exists.
httpStatusCodeinteger

HTTP 状态码。

400
dynamicCodestring

动态错误码。

TopicName
dynamicMessagestring

动态错误信息。

topicName

示例

正常返回示例

JSON格式

{
  "requestId": "AF9A8B10-C426-530F-A0DD-96320B39****",
  "success": true,
  "data": true,
  "code": "Topic.Existed",
  "message": "The topic already exists.",
  "httpStatusCode": 400,
  "dynamicCode": "TopicName",
  "dynamicMessage": "topicName"
}

错误码

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
暂无变更历史
  • 本页导读 (1)
文档反馈