更新时间:2025-09-03 GMT+08:00

获取实例配置

功能介绍

获取实例配置。

URI

GET /v2/{project_id}/instances/{instance_id}/configs

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

项目ID,获取方式请参见获取项目ID

instance_id

String

实例ID。

请求参数

响应参数

状态码:200

表2 响应Body参数

参数

参数类型

描述

kafka_configs

Array of InstanceConfig objects

Kafka配置列表。

表3 InstanceConfig

参数

参数类型

描述

name

String

配置名称。

valid_values

String

有效值。

default_value

String

默认值。

config_type

String

配置类型:static/dynamic。

value

String

配置当前值。

value_type

String

值类型。

请求示例

GET https://{endpoint}/v2/{project_id}/instances/{instance_id}/configs

响应示例

状态码:200

获取实例配置成功。

{
  "kafka_configs" : [ {
    "name" : "min.insync.replicas",
    "valid_values" : "1~3",
    "default_value" : "1",
    "config_type" : "dynamic",
    "value" : "1",
    "value_type" : "integer"
  }, {
    "name" : "message.max.bytes",
    "valid_values" : "0~10485760",
    "default_value" : "10485760",
    "config_type" : "dynamic",
    "value" : "10485760",
    "value_type" : "integer"
  }, {
    "name" : "auto.create.groups.enable",
    "valid_values" : "true,false",
    "default_value" : "true",
    "config_type" : "dynamic",
    "value" : "true",
    "value_type" : "enum"
  }, {
    "name" : "connections.max.idle.ms",
    "valid_values" : "5000~600000",
    "default_value" : "600000",
    "config_type" : "static",
    "value" : "600000",
    "value_type" : "integer"
  }, {
    "name" : "log.retention.hours",
    "valid_values" : "1~168",
    "default_value" : "72",
    "config_type" : "static",
    "value" : "72",
    "value_type" : "integer"
  }, {
    "name" : "max.connections.per.ip",
    "valid_values" : "100~20000",
    "default_value" : "1000",
    "config_type" : "dynamic",
    "value" : "1000",
    "value_type" : "integer"
  }, {
    "name" : "group.max.session.timeout.ms",
    "valid_values" : "6000~1800000",
    "default_value" : "1800000",
    "config_type" : "static",
    "value" : "1800000",
    "value_type" : "integer"
  }, {
    "name" : "unclean.leader.election.enable",
    "valid_values" : "true,false",
    "default_value" : "false",
    "config_type" : "dynamic",
    "value" : "false",
    "value_type" : "enum"
  }, {
    "name" : "default.replication.factor",
    "valid_values" : "1~3",
    "default_value" : "3",
    "config_type" : "static",
    "value" : "3",
    "value_type" : "integer"
  }, {
    "name" : "offsets.retention.minutes",
    "valid_values" : "1440~30240",
    "default_value" : "20160",
    "config_type" : "dynamic",
    "value" : "20160",
    "value_type" : "integer"
  }, {
    "name" : "num.partitions",
    "valid_values" : "1~200",
    "default_value" : "3",
    "config_type" : "static",
    "value" : "3",
    "value_type" : "integer"
  }, {
    "name" : "group.min.session.timeout.ms",
    "valid_values" : "6000~300000",
    "default_value" : "6000",
    "config_type" : "static",
    "value" : "6000",
    "value_type" : "integer"
  }, {
    "name" : "allow.everyone.if.no.acl.found",
    "valid_values" : "true,false",
    "default_value" : "true",
    "config_type" : "static",
    "value" : "true",
    "value_type" : "enum"
  } ]
}

状态码

状态码

描述

200

获取实例配置成功。

错误码

请参见错误码