You need to enable JavaScript to run this app.
导航
消息队列 Kafka版
  • 文档首页
    • /
  • 消息队列 Kafka版

DescribeTopicParameters

最近更新时间：2023.03.30 19:59:26

首次发布时间：2023.03.30 19:59:26

我的收藏

调用 DescribeTopicParameters 查看指定 Topic 的参数配置。

使用说明

此接口用于查看指定 Topic 的参数配置信息，包括最小同步副本个数、最大消息大小等。

请求参数

参数

参数类型

是否必选

示例值

说明

InstanceId

String

是

kafka-cnngbnntswg1****

实例 ID。

TopicName

String

是

Name

Topic 名称。

响应参数

参数

参数类型

示例值

说明

Parameters

String

{"LogRetentionHours":"72","MessageMaxByte":"10","MinInsyncReplicaNumber":"2"}

Topic 级别的参数配置。说明如下：

  • LogAutoDeletion：是否自动删除旧消息。
  • MessageMaxByte：最大消息大小。单位为 MB。
  • MinInsyncReplicaNumber：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\"}"
    }
}