# 修改实例配置 - ModifyInstanceConfigs #### 功能介绍 修改实例配置。 #### 调用方法 请参见[如何调用API](https://support.huaweicloud.com/api-kafka/api-call-process.html)。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。 - 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-kafka/api-grant-policy.html)。 - 如果使用身份策略授权，当前API调用无需身份策略权限。 #### URI PUT /v2/{project_id}/instances/{instance_id}/configs 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 是 | String | **参数解释**： 项目ID，获取方式请参见[获取项目ID](https://support.huaweicloud.com/api-kafka/kafka-api-0036212547.html)。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 **默认取值**： 不涉及。 | | instance_id | 是 | String | **参数解释**： 实例ID。获取方法如下：调用"查询所有实例列表"接口，从响应体中获取实例ID。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 **默认取值**： 不涉及。 | #### 请求参数 表2请求Body参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | kafka_configs | 否 | Array of [ModifyInstanceConfig] objects | **参数解释**： Kafka待修改配置列表。 **约束限制**： 不涉及。 | 表3ModifyInstanceConfig | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | name | 否 | String | **参数解释**： 修改的配置名称。 **约束限制**： 不涉及。 **取值范围**： 请调用[获取实例配置](https://support.huaweicloud.com/api-kafka/ShowInstanceConfigs.html)接口，获取实例配置名称。 **默认取值**： 不涉及。 | | value | 否 | String | **参数解释**： 配置的修改值。 **约束限制**： 不涉及。 **取值范围**： 请调用[获取实例配置](https://support.huaweicloud.com/api-kafka/ShowInstanceConfigs.html)接口，获取实例配置参数对应的有效值valid_values。 **默认取值**： 不涉及。 | #### 响应参数 **状态码：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代码示例如下。 - [Java] 修改实例的连接空闲超时和日志删除的时间阈值。 ``` 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("")) .build(); ModifyInstanceConfigsRequest request = new ModifyInstanceConfigsRequest(); request.withInstanceId("{instance_id}"); ModifyInstanceConfigsReq body = new ModifyInstanceConfigsReq(); List 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()); } } } ``` - [Python] 修改实例的连接空闲超时和日志删除的时间阈值。 ``` # 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("")) \ .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) ``` - [Go] 修改实例的连接空闲超时和日志删除的时间阈值。 ``` 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, err := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). WithProjectId(projectId). SafeBuild() if err != nil { fmt.Println(err) return } hcClient, err := kafka.KafkaClientBuilder(). WithRegion(region.ValueOf("")). WithCredential(auth). SafeBuild() if err != nil { fmt.Println(err) return } client := kafka.NewKafkaClient(hcClient) 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](https://console.huaweicloud.com/apiexplorer/#/openapi/Kafka/sdk?api=ModifyInstanceConfigs)的代码示例页签，可生成自动对应的SDK代码示例。 #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | 修改实例配置成功。 | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-kafka/ErrorCode.html)。