文档首页/ 应用与数据集成平台 ROMA Connect/ API参考/ 消息集成API/ 主题管理/ 修改Topic - UpdateMqsInstanceTopic
更新时间：2025-10-22 GMT+08:00
在线调试
CLI示例
查看PDF
分享

修改Topic - UpdateMqsInstanceTopic

功能介绍

修改Topic。

授权信息

账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限，具体权限要求请参见权限和授权项。

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目ID，获取方式请参见API参考的“附录 > 获取项目ID”章节。

instance_id

是

String

实例ID。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

用户Token。通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。
表3 请求Body参数

参数

是否必选

参数类型

描述

topics

是

Array of UpdateTopicObject objects

Topic列表。
表4 UpdateTopicObject

参数

是否必选

参数类型

描述

name

是

String

Topic名称。

retention_time

否

Integer

消息老化时间。默认值为72。取值范围1~168，单位小时。

sync_replication

否

Boolean

是否开启同步复制。

sync_message_flush

否

Boolean

是否使用同步落盘。

description

否

String

描述。

sensitive_word

否

String

敏感字段。

new_partition_numbers

否

Integer

调整后的分区数。

响应参数

状态码：204

No Content

状态码：400

表5 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误信息。

状态码：403

表6 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误信息。

请求示例

修改指定Topic的配置，消息老化时间修改为72小时，并开启同步复制和同步落盘

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

{
  "topics" : [ {
    "name" : "topic-test",
    "retention_time" : 72,
    "sync_replication" : true,
    "sync_message_flush" : true,
    "description" : "",
    "sensitive_word" : ""
  } ]
}

响应示例

状态码：400

Bad Request

{
  "error_code" : 400,
  "error_msg" : "Bad Request"
}

状态码：403

Forbidden

{
  "error_code" : 403,
  "error_msg" : "Forbidden"
}

状态码

状态码

描述

204

No Content

400

Bad Request

403

Forbidden

错误码

请参见错误码。

父主题： 主题管理