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

修改实例配置

功能介绍

修改实例配置。

调用方法

请参见如何调用API

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

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

instance_id

String

实例ID。

请求参数

表2 请求Body参数

参数

是否必选

参数类型

描述

kafka_configs

Array of ModifyInstanceConfig objects

kafka待修改配置列表。

表3 ModifyInstanceConfig

参数

是否必选

参数类型

描述

name

String

修改的配置名称。

value

String

配置的修改值。

响应参数

状态码: 200

表4 响应Body参数

参数

参数类型

描述

job_id

String

配置修改任务ID。

dynamic_config

Integer

本次修改动态配置参数个数。

static_config

Integer

本次修改静态配置参数个数。

请求示例

修改实例的连接空闲超时和日志删除的时间阈值。

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

{
  "kafka_configs" : [ {
    "name" : "connections.max.idle.ms",
    "value" : "500000"
  }, {
    "name" : "log.retention.hours",
    "value" : "66"
  } ]
}

响应示例

状态码: 200

修改实例配置成功。

{
  "job_id" : "8abfa7b38ba79a20018ba9afc550576a",
  "dynamic_config" : 0,
  "static_config" : 2
}

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
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
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.*;

import java.util.List;
import java.util.ArrayList;

public class ModifyInstanceConfigsSolution {

    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();
        ModifyInstanceConfigsRequest request = new ModifyInstanceConfigsRequest();
        request.withInstanceId("{instance_id}");
        ModifyInstanceConfigsReq body = new ModifyInstanceConfigsReq();
        List<ModifyInstanceConfig> listbodyKafkaConfigs = new ArrayList<>();
        listbodyKafkaConfigs.add(
            new ModifyInstanceConfig()
                .withName("connections.max.idle.ms")
                .withValue("500000")
        );
        listbodyKafkaConfigs.add(
            new ModifyInstanceConfig()
                .withName("log.retention.hours")
                .withValue("66")
        );
        body.withKafkaConfigs(listbodyKafkaConfigs);
        request.withBody(body);
        try {
            ModifyInstanceConfigsResponse response = client.modifyInstanceConfigs(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
33
34
35
36
37
38
39
40
41
42
43
44
45
# 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 = ModifyInstanceConfigsRequest()
        request.instance_id = "{instance_id}"
        listKafkaConfigsbody = [
            ModifyInstanceConfig(
                name="connections.max.idle.ms",
                value="500000"
            ),
            ModifyInstanceConfig(
                name="log.retention.hours",
                value="66"
            )
        ]
        request.body = ModifyInstanceConfigsReq(
            kafka_configs=listKafkaConfigsbody
        )
        response = client.modify_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
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
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.ModifyInstanceConfigsRequest{}
	request.InstanceId = "{instance_id}"
	nameKafkaConfigs:= "connections.max.idle.ms"
	valueKafkaConfigs:= "500000"
	nameKafkaConfigs1:= "log.retention.hours"
	valueKafkaConfigs1:= "66"
	var listKafkaConfigsbody = []model.ModifyInstanceConfig{
        {
            Name: &nameKafkaConfigs,
            Value: &valueKafkaConfigs,
        },
        {
            Name: &nameKafkaConfigs1,
            Value: &valueKafkaConfigs1,
        },
    }
	request.Body = &model.ModifyInstanceConfigsReq{
		KafkaConfigs: &listKafkaConfigsbody,
	}
	response, err := client.ModifyInstanceConfigs(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

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

状态码

状态码

描述

200

修改实例配置成功。

错误码

请参见错误码