文档

OnsTopicCreate - 创建Topic

更新时间:
一键部署

调用OnsTopicCreate接口创建Topic。

接口说明

注意 阿里云提供的 OpenAPI 属于管控类 API,用于管理和查询阿里云服务的相关资源。仅推荐在管控链路集成,消息收发的核心数据链路中严禁依赖 OpenAPI 实现,否则可能会导致链路产生风险。
本接口一般是在发布新应用或业务扩展等需要创建新的 Topic 资源时使用。

调试

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

授权信息

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

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

请求参数

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

需创建的 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 版控制台实例详情页面的基础信息区域查看。
test
MessageTypeinteger

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

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

各类型消息的详细说明,请参见消息类型列表

0
Remarkstring

需创建的 Topic 的描述信息。

测试
InstanceIdstring

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

MQ_INST_188077086902****_BXSuW61e

返回参数

名称类型描述示例值
object

返回的数据结构。

RequestIdstring

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

B6949B58-223E-4B75-B4FE-7797C15E****

示例

正常返回示例

JSON格式

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

错误码

HTTP status code错误码错误信息
400%s%s, please check and retry later

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

变更历史

变更时间变更内容概要操作
暂无变更历史

控制台操作

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

  • 本页导读 (1)
文档反馈