消息队列 Kafka版
消息队列 Kafka版
消息队列 Kafka版
文档指南
请输入
用户指南
实例管理
Kafka Agent
API 参考
V2（2022-05-01）
OpenAPIV2
网络管理
Topic 管理
Group 管理
SASL 用户管理
白名单管理
附录
V1（2018-01-01）
实例管理
Topic 管理
Group 管理
SDK 参考
Apache Kafka SDK
Java 客户端 SDK
Go 客户端 SDK
Python 客户端 SDK
Volcengine SDK
Volcengine Python SDK
Volcengine Java SDK
最佳实践
- 文档首页
消息队列 Kafka版API 参考V2（2022-05-01）Topic 管理ModifyTopicAttributes - 修改 Topic 描述
复制全文
下载 pdfModifyTopicAttributes - 修改 Topic 描述
文档反馈
问问助手调用 ModifyTopic 接口修改 Topic 的描述。
使用说明
创建实例后，可以调用该接口调整 Topic 的描述信息。
调试
API Explorer
您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。
请求参数
Action string 必选 示例值：ModifyTopicAttributes
要执行的操作，取值：ModifyTopicAttributes。
Version string 必选 示例值：2022-05-01
API的版本，取值：2022-05-01。
InstanceId string 必选 示例值：kafka-****
Topic 所在的实例 ID。
TopicName string 必选 示例值：my_topic
Topic 的名称。Topic 创建后不支持修改 TopicName。
Description string 可选 示例值：new-describe
修改 Topic 的描述信息。若参数不填，将会清空已有的 Topic 描述信息。
返回参数
请求示例
POST /?Action=ModifyTopicAttributes&Version=2022-05-01 HTTP/1.1
Content-Type: application/json
Host: kafka.volcengineapi.com
X-Date: 20210328T100802Z
Authorization: HMAC-SHA256 Credential=AK********/20210328/cn-beijing/Kafka/request, SignedHeaders=x-date, Signature=********
{
"InstanceId": "kafka-cnngbnntswg1****",
"TopicName":"httptopic",
"Description":"topic for http module"
}
返回示例
{
"ResponseMetadata": {
"RequestId": "20230227194819ABF4BF3AE0C5F76CECDD",
"Action": "ModifyTopicAttributes",
"Version": "2022-05-01",
"Service": "Kafka",
"Region": "cn-beijing"
},
"Result": null
}
错误码
状态码 | 错误码 | 错误信息 | 说明 |
状态码 | 错误码 | 错误信息 | 说明 |
400 | InvalidParameter | The specified parameter is not valid. | 参数值无效。 |
403 | OperationDenied.InvalidInstanceStatus | The operation is not valid for the current status of the instance. | 当前实例状态不允许执行该操作。 |
403 | OperationDenied.InvalidTopicStatus | The operation is not valid for the current status of the topic. | 当前Kafka主题状态不允许执行该操作。 |
403 | OperationDenied.AccountNotAuthorized | You are not authorized to perform this operation. | 您不具备相关权限 ，请授权或切换账号后重试。 |
404 | InvalidInstanceId.NotFound | The specified Instance ID does not exist. | 实例不存在。 |
404 | InvalidTopicName.NotFound | The specified topic does not exist. | Topic 不存在。 |
500 | InternalError | The request failed due to some unknown error, exception or failure. | 内部错误，请稍后重试。 |
最近更新时间：2025.08.08 17:47:27
这个页面对您有帮助吗？
有用
有用
无用
无用