消息队列 RocketMQ版
消息队列 RocketMQ版
消息队列 RocketMQ版
文档指南
请输入
产品动态
用户指南
实例管理
后台任务管理
Terraform
RocketMQ Agent
API 参考
实例管理
Topic管理
Group管理
消息查询
死信队列
密钥管理
风险巡检
白名单管理
终端节点服务
SDK 参考
RocketMQ 5.x
RocketMQ 4.x
RocketMQ 管控面SDK
最佳实践
- 文档首页
消息队列 RocketMQ版API 参考Topic管理ModifyTopicDescription - 修改 Topic 描述
复制全文
下载 pdfModifyTopicDescription - 修改 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
这个页面对您有帮助吗？
有用
有用
无用
无用