更新时间:2026-04-03 GMT+08:00

修改主题

功能介绍

修改主题。

URI

PUT /v2/{project_id}/instances/{instance_id}/topics/{topic}

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释:

项目ID,获取方式请参见获取项目ID。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

instance_id

是

String

参数解释:

实例ID。获取方法如下:调用“查询所有实例列表”接口,从响应体中获取实例ID。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

topic

是

String

参数解释:

主题名称。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

请求参数

表2 请求Body参数

参数

是否必选

参数类型

描述

read_queue_num

否

Number

参数解释:

总读队列个数。

约束限制:

仅4.8.0实例支持修改该参数,且仅当queues参数为空时,该参数才生效。

取值范围:

大于等于当前Topic所关联代理数数量。

默认取值:

3。

write_queue_num

否

Number

参数解释:

总写队列个数。

约束限制:

仅4.8.0实例支持修改该参数,且仅当queues参数为空时,该参数才生效。

取值范围:

大于等于当前Topic所关联代理数数量。

默认取值:

3。

permission

否

String

参数解释:

权限。

约束限制:

仅4.8.0实例支持修改该参数。

取值范围:

不涉及。

默认取值:

不涉及。

queues

否

Array of UpdateTopicQueueEntity objects

参数解释:

队列。

约束限制:

仅4.8.0实例支持修改该参数。

取值范围:

不涉及。

默认取值:

不涉及。

topic_desc

否

String

参数解释:

Topic描述。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

表3 UpdateTopicQueueEntity

参数

是否必选

参数类型

描述

broker

否

String

参数解释:

Broker名称。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

read_queue_num

否

Number

参数解释:

读队列个数。

约束限制:

不涉及。

取值范围:

大于等于0。

默认取值:

3。

write_queue_num

否

Number

参数解释:

写队列个数。

约束限制:

不涉及。

取值范围:

大于等于0。

默认取值:

3。

响应参数

状态码:204

修改主题成功。

无

请求示例

修改指定主题的参数,总读队列个数修改为3,总写队列个数修改为3。

PUT https://{endpoint}/v2/{project_id}/instances/{instance_id}/topics/{topic}

{
  "permission" : "all",
  "queues" : [ {
    "broker" : "broker-0",
    "read_queue_num" : 3,
    "write_queue_num" : 3
  } ],
  "topic_desc" : "topic_description"
}

响应示例

无

状态码

状态码

描述

204

修改主题成功。

错误码

请参见错误码。