全部产品
Search

搜索本产品

    云消息队列 RocketMQ 版：GetTopic - 获取指定主题的详情

    文档中心

    云消息队列 RocketMQ 版：GetTopic - 获取指定主题的详情

    更新时间：Sep 24, 2024

    获取某个指定主题的详细信息。

    调试

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

    授权信息

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

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

    请求语法

    GET /instances/{instanceId}/topics/{topicName} HTTP/1.1

    请求参数

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

    待查询主题所属的实例的 ID。

    		rmq-cn-7e22ody****
    topicNamestring是

    待查询主题的名称。

    		topic_test

    返回参数

    名称类型描述示例值
    object

    Result

    requestIdstring

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

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

    执行结果是否成功。

    		true
    dataobject

    返回结果。

    regionIdstring

    实例所属的地域 ID。

    		cn-hangzhou
    instanceIdstring

    主题所属实例的 ID。

    		rmq-cn-7e22ody****
    topicNamestring

    主题名称。

    		topic_test
    messageTypestring

    主题的消息类型,。

    参数取值如下：

    • TRANSACTION：事务消息
    • FIFO：顺序消息
    • DELAY：定时/延时消息
    • NORMAL：普通消息
    枚举值：
    • TRANSACTION：事务消息。
    • FIFO：顺序消息。
    • DELAY：定时消息/延时消息。
    • NORMAL：普通消息。
    		NORMAL
    statusstring

    主题的状态。

    参数取值如下：

    • RUNNING：运行中
    • CREATING：创建中
    		RUNNING
    remarkstring

    主题的备注信息。

    		This is the remark for test.
    createTimestring

    主题的创建时间。

    		2022-08-01 20:05:50
    updateTimestring

    主题的最后修改时间。

    		2022-08-01 20:05:50
    codestring

    错误码。

    		Topic.NotFound
    messagestring

    错误信息。

    		The topic cannot be found.
    httpStatusCodeinteger

    HTTP 状态码。

    		400
    dynamicCodestring

    动态错误码。

    		TopicName
    dynamicMessagestring

    动态错误信息。

    		topicName

    示例

    正常返回示例

    JSON格式

    {
  "requestId": "AF9A8B10-C426-530F-A0DD-96320B39****",
  "success": true,
  "data": {
    "regionId": "cn-hangzhou",
    "instanceId": "rmq-cn-7e22ody****",
    "topicName": "topic_test",
    "messageType": "NORMAL",
    "status": "RUNNING",
    "remark": "This is the remark for test.\n",
    "createTime": "2022-08-01 20:05:50",
    "updateTime": "2022-08-01 20:05:50"
  },
  "code": "Topic.NotFound",
  "message": "The topic cannot be found.",
  "httpStatusCode": 400,
  "dynamicCode": "TopicName",
  "dynamicMessage": "topicName"
}

    错误码

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

    变更历史

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