更新时间:2024-07-09 GMT+08:00

获取实例配置

功能介绍

获取实例配置。

调用方法

请参见如何调用API

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"
  } ]
}

SDK代码示例

SDK代码示例如下。

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
package com.huaweicloud.sdk.test;

import com.huaweicloud.sdk.core.auth.ICredential;
import com.huaweicloud.sdk.core.auth.BasicCredentials;
import com.huaweicloud.sdk.core.exception.ConnectionException;
import com.huaweicloud.sdk.core.exception.RequestTimeoutException;
import com.huaweicloud.sdk.core.exception.ServiceResponseException;
import com.huaweicloud.sdk.kafka.v2.region.KafkaRegion;
import com.huaweicloud.sdk.kafka.v2.*;
import com.huaweicloud.sdk.kafka.v2.model.*;


public class ShowInstanceConfigsSolution {

    public static void main(String[] args) {
        // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
        // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
        String ak = System.getenv("CLOUD_SDK_AK");
        String sk = System.getenv("CLOUD_SDK_SK");
        String projectId = "{project_id}";

        ICredential auth = new BasicCredentials()
                .withProjectId(projectId)
                .withAk(ak)
                .withSk(sk);

        KafkaClient client = KafkaClient.newBuilder()
                .withCredential(auth)
                .withRegion(KafkaRegion.valueOf("<YOUR REGION>"))
                .build();
        ShowInstanceConfigsRequest request = new ShowInstanceConfigsRequest();
        request.withInstanceId("{instance_id}");
        try {
            ShowInstanceConfigsResponse response = client.showInstanceConfigs(request);
            System.out.println(response.toString());
        } catch (ConnectionException e) {
            e.printStackTrace();
        } catch (RequestTimeoutException e) {
            e.printStackTrace();
        } catch (ServiceResponseException e) {
            e.printStackTrace();
            System.out.println(e.getHttpStatusCode());
            System.out.println(e.getRequestId());
            System.out.println(e.getErrorCode());
            System.out.println(e.getErrorMsg());
        }
    }
}
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
# coding: utf-8

import os
from huaweicloudsdkcore.auth.credentials import BasicCredentials
from huaweicloudsdkkafka.v2.region.kafka_region import KafkaRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdkkafka.v2 import *

if __name__ == "__main__":
    # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak = os.environ["CLOUD_SDK_AK"]
    sk = os.environ["CLOUD_SDK_SK"]
    projectId = "{project_id}"

    credentials = BasicCredentials(ak, sk, projectId)

    client = KafkaClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(KafkaRegion.value_of("<YOUR REGION>")) \
        .build()

    try:
        request = ShowInstanceConfigsRequest()
        request.instance_id = "{instance_id}"
        response = client.show_instance_configs(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
package main

import (
	"fmt"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic"
    kafka "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/kafka/v2"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/kafka/v2/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/kafka/v2/region"
)

func main() {
    // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak := os.Getenv("CLOUD_SDK_AK")
    sk := os.Getenv("CLOUD_SDK_SK")
    projectId := "{project_id}"

    auth := basic.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        WithProjectId(projectId).
        Build()

    client := kafka.NewKafkaClient(
        kafka.KafkaClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

    request := &model.ShowInstanceConfigsRequest{}
	request.InstanceId = "{instance_id}"
	response, err := client.ShowInstanceConfigs(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。

状态码

状态码

描述

200

获取实例配置成功。

错误码

请参见错误码