调用OnsTopicCreate接口创建Topic。

使用说明

本接口一般是在发布新应用或业务扩展等需要创建新的Topic资源时使用。

QPS限制

本接口的单用户QPS限制为1次/秒。超过限制,API调用会被限流,这可能会影响您的业务,请合理调用。更多信息,请参见QPS限制

授权信息

默认仅限阿里云账号使用本接口,RAM用户只有在被授予了相关资源的操作权限后方可使用。调用本接口需授予的权限信息如下表所示。更多信息,请参见权限策略和示例

API

Action

Resource(有命名空间)

Resource(无命名空间)

OnsTopicCreate

mq:CreateTopic

acs:mq:*:*:{instanceId}%{topic}

acs:mq:*:*:{topic}

请求参数

名称 类型 是否必选 示例值 描述
Action String OnsTopicCreate

系统规定参数。取值:OnsTopicCreate

Topic String test

需创建的Topic的名称,取值说明如下:

  • 长度限制为3~64个字符,只能包含字母、数字、短划线(-)和下划线(_)。
  • “CID”和“GID”是Group ID的保留字段,Topic名称不能以“CID”和“GID”开头。
  • 如果创建的Topic所在的实例有命名空间,则Topic的名称需要保证实例内唯一,不能和本实例下已有的Topic名称或Group ID重复;跨实例之间可以重名,例如实例A的Topic名称可以和实例B的Topic名称重复,也可以和实例B的Group ID重复。
  • 如果新建的Topic所在的实例无命名空间,则Topic的名称需要保证跨实例和跨地域全局唯一,全局范围内不能和已有的Topic名称或Group ID重复。
说明 实例是否有命名空间,可以在消息队列RocketMQ版控制台实例详情页面的基础信息区域查看。
MessageType Integer 0

消息类型。取值说明如下:

  • 0:普通消息
  • 1:分区顺序消息
  • 2:全局顺序消息
  • 4:事务消息
  • 5:定时/延时消息

各类型消息的详细说明,请参见消息类型概述

Remark String 测试

需创建的Topic的描述信息。

InstanceId String MQ_INST_188077086902****_BXSuW61e

需创建的Topic所对应的实例ID。

返回数据

名称 类型 示例值 描述
RequestId String B6949B58-223E-4B75-B4FE-7797C15E****

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

示例

请求示例

http(s)://ons.cn-zhangjiakou.aliyuncs.com/?Action=OnsTopicCreate
&InstanceId=MQ_INST_188077086902****_BXSuW61e
&MessageType=0
&Topic=test
&<公共请求参数>

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<OnsTopicCreateResponse>
<RequestId>B6949B58-223E-4B75-B4FE-7797C15E****</RequestId>
</OnsTopicCreateResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "RequestId" : "B6949B58-223E-4B75-B4FE-7797C15E****"
}

错误码

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

控制台操作

除了调用OnsTopicCreate接口,您还可以通过消息队列RocketMQ版控制台,创建Topic。具体操作,请参见Topic管理