调用 DescribeTopicParameters 查看指定 Topic 的参数配置信息,包括最小同步副本个数、最大消息大小等。
下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。
参数 | 类型 | 是否必填 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | DescribeTopicParameters | 要执行的操作,取值:DescribeTopicParameters。 |
Version | String | 是 | 2022-05-01 | API的版本,取值:2022-05-01。 |
InstanceId | String | 是 | kafka-cnngbnntswg1**** | 实例 ID。 |
TopicName | String | 是 | Name | Topic 名称。 |
下表仅列出本接口特有的返回参数。更多信息请参见返回结构。
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
Parameters | String | {"LogRetentionHours":"72","MessageMaxByte":"10","MinInsyncReplicaNumber":"2"} | Topic 级别的参数配置。说明如下:
|
POST /?Action=DescribeTopicParameters&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": "my_topic" }
{ "ResponseMetadata": { "RequestId": "20230227195620C7B6D308FCE70D6B1BD1", "Action": "DescribeTopicParameters", "Version": "2022-05-01", "Service": "Kafka", "Region": "cn-beijing" }, "Result": { "Parameters": "{\"LogRetentionHours\":\"72\",\"MessageMaxByte\":\"10\",\"MinInsyncReplicaNumber\":\"2\"}" } }
下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。
状态码 | 错误码 | 说明 |
---|---|---|
400 | InvalidParameter | 参数值无效。 |
403 | OperationDenied.InvalidInstanceStatus | 当前实例状态不允许执行该操作。 |
404 | InvalidInstanceId.NotFound | 实例不存在。 |
404 | InvalidTopicName.NotFound | Topic不存在。 |