文档中心

消息队列 RocketMQ版

Topic管理

ModifyTopicDescription - 修改 Topic 描述

调用 ModifyTopicDescription 接口修改 Topic 描述。

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

下方仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。

Action string 必选示例值：ModifyTopicDescription

要执行的操作，取值：ModifyTopicDescription。

Version string 必选示例值：2023-01-01

API的版本，取值：2023-01-01。

InstanceId string 必选示例值：rocketmq-xxx

实例 ID。

TopicName string 必选示例值：test

Topic 名称。

Description string 必选示例值：description for test

Topic 描述。

返回参数

本接口无特有的返回参数。更多信息请见返回结构。

请求示例

POST /?Action=ModifyTopicDescription&Version=2023-01-01 HTTP/1.1​
Host: rocketmq.cn-beijing.volcengineapi.com​
Content-Type: application/json; charset=UTF-8​
X-Date: 20260313T023220Z​
X-Content-Sha256: 287e874e******d653b44d21e​
Authorization: HMAC-SHA256 Credential=Adfks******wekfwe/20260313/cn-beijing/RocketMQ/request, SignedHeaders=host;x-content-sha256;x-date, Signature=47a7d934ff7b37c03938******cd7b8278a40a1057690c401e92246a0e41085f​
​
{​
  "InstanceId": "rocketmq-xxx",​
  "TopicName": "test",​
  "Description": "description for test"​
}​

返回示例

{​
  "ResponseMetadata": {​
    "RequestId": "20260313103227028085200253A0****",​
    "Action": "ModifyTopicDescription",​
    "Version": "2023-01-01",​
    "Service": "RocketMQ",​
    "Region": "cn-beijing"​
  },​
  "Result": {}​
}​

错误码

下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。

状态码	错误码	错误信息	说明
200	OK	OK	成功。
400	InvalidPara	The specified parameter is not valid.	参数值无效。
400	InvalidParameter	The specified parameter %s is not valid.	参数值%s无效，请检查后重试。
400	TopicNotExist	The specified topic does not exist.	Topic 不存在。
403	OperationDenied_InvalidInstanceStatus	The operation is not valid for the current status of the instance.	当前实例状态不允许执行该操作。
404	InvalidTopicName_NotFound	The specified topic does not exist.	Topic 不存在。
500	ServerInternalError	The request failed due to some unknown error, exception or failure.	服务内部错误。
500	ResourceIsBusy	The resource is busy now, please try again later.	资源繁忙，可能由于指定资源正在被访问或回收。
500	InternalError	The request failed due to some unknown error, exception or failure.	内部错误，请稍后再试。
503	ServiceUnavailable	The request failed due to a temporary failure of the server.	当前服务暂时不可用。

最近更新时间：2026.03.13 11:08:48

这个页面对您有帮助吗？

有用

无用