You need to enable JavaScript to run this app.
导航
ModifyTopicAttributes - 修改 Topic 描述
最近更新时间:2024.10.31 17:26:45首次发布时间:2023.03.30 19:59:25

调用 ModifyTopic 接口修改 Topic 的描述。

使用说明

创建实例后,可以调用该接口调整 Topic 的描述信息。

调试

请求参数

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

参数
类型
是否必填
示例值
描述
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.

内部错误,请稍后重试。