# 实例扩容 - ResizeKafkaInstance #### 功能介绍 实例规格变更。当前通过调用API，只支持按需实例进行实例扩容。 #### 调用方法 请参见[如何调用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)。 - 如果使用身份策略授权，需具备如下身份策略权限。 | 授权项 | 访问级别 | 资源类型（\*为必须） | 条件键 | 别名 | 依赖的授权项 | |:---|:---|:---|:---|:---|:---| | dms:instance:scale | Write | kafka \* | - g:ResourceTag/\ - g:EnterpriseProjectId | - | - | #### URI POST /v2/{project_id}/kafka/instances/{instance_id}/extend 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 是 | String | **参数解释**： 项目ID，获取方式请参见[获取项目ID](https://support.huaweicloud.com/api-kafka/kafka-api-0036212547.html)。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 **默认取值**： 不涉及。 | | instance_id | 是 | String | **参数解释**： 实例ID。获取方法如下：调用"查询所有实例列表"接口，从响应体中获取实例ID。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 **默认取值**： 不涉及。 | #### 请求参数 表2请求Body参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | oper_type | 是 | String | **参数解释**： 变更类型。 **约束限制**： 不涉及。 **取值范围**： - storage：存储空间扩容，代理数量不变。 - horizontal：代理数量扩容，每个broker的存储空间不变。 - vertical：垂直扩容，broker的底层虚机规格变更，代理数量和存储空间不变。 **默认取值**： 不涉及。 | | new_storage_space | 否 | Integer | **参数解释**： 扩容后的存储空间。 **约束限制**： 磁盘容量仅支持设置为100的整数倍。 实例存储空间 = 代理数量 \* 每个broker的存储空间。 当oper_type类型是storage或horizontal时，该参数有效且必填。 - 当oper_type类型是storage时，代理数量不变，每个broker存储空间最少扩容100GB。 - 当oper_type类型是horizontal时，每个broker的存储空间不变。 **取值范围**： 不涉及。 **默认取值**： 不涉及。 | | new_broker_num | 否 | Integer | **参数解释**： 扩容后的代理数量。 **约束限制**： 当oper_type参数为horizontal时，该参数有效且必填。 **取值范围**： 大于扩容前的代理数量，小于50。 **默认取值**： 不涉及。 | | new_product_id | 否 | String | **参数解释**： 垂直扩容时的新产品ID。产品ID可以从[查询产品规格列表](https://support.huaweicloud.com/api-kafka/ListEngineProducts.html)获取。 **约束限制**： 当oper_type参数为vertical时，该参数有效且必填。 **取值范围**： 不涉及。 **默认取值**： 不涉及。 | | publicip_id | 否 | String | **参数解释**： 实例绑定的弹性IP地址的ID。获取方法：参考[《弹性公网IP API参考》](https://support.huaweicloud.com/api-eip/ListPublicipsV3.html)，调用"查询弹性公网IP列表"接口，从响应体中获取弹性公网IP的ID。 以英文逗号隔开多个弹性IP地址的ID。 **约束限制**： 当实例开启公网访问，且oper_type参数为horizontal时，该参数有效且必填。 **取值范围**： 不涉及。 **默认取值**： 不涉及。 | | tenant_ips | 否 | Array of strings | **参数解释**： 指定的内网IP地址。 **约束限制**： - 仅支持指定IPv4。 - 指定的IP数量只能小于等于新增节点数量。 - 当指定IP小于节点数量时，未指定的节点随机分配内网IP地址。 **取值范围**： 不涉及。 **默认取值**： 不涉及。 | | second_tenant_subnet_id | 否 | String | **参数解释**： 实例扩容时新节点使用备用子网的id。 **约束限制**： - 当实例扩容使用备用子网，则传入此值。 - 需要联系客服申请开通后，才能传入此值。 **取值范围**： 不涉及。 **默认取值**： 不涉及。 | #### 响应参数 **状态码：200** 表3响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | job_id | String | **参数解释**： 规格变更任务ID。 **取值范围**： 不涉及。 | #### 请求示例 - 扩容存储空间（按需实例）。 ``` POST https://{endpoint}/v2/{project_id}/kafka/instances/{instance_id}/extend { "oper_type" : "storage", "new_storage_space" : 600 } ``` - 扩容代理数量（按需实例）。 ``` POST https://{endpoint}/v2/{project_id}/kafka/instances/{instance_id}/extend { "oper_type" : "horizontal", "new_storage_space" : 1600, "new_broker_num" : 4, "tenant_ips" : [ "127.xx.xx.x", "127.xx.xx.x", "127.xx.xx.x" ] } ``` - 扩容代理规格（按需实例）。 ``` POST https://{endpoint}/v2/{project_id}/kafka/instances/{instance_id}/extend { "oper_type" : "vertical", "new_product_id" : "c6.4u8g.cluster" } ``` #### 响应示例 **状态码：200** 实例扩容成功。 ``` { "job_id" : "93b94287-728d-4bb1-a158-cb66cb0854e7" } ``` #### 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.*; public class ResizeKafkaInstanceSolution { 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(); ResizeKafkaInstanceRequest request = new ResizeKafkaInstanceRequest(); request.withInstanceId("{instance_id}"); ResizeEngineInstanceReq body = new ResizeEngineInstanceReq(); body.withNewStorageSpace(600); body.withOperType("storage"); request.withBody(body); try { ResizeKafkaInstanceResponse response = client.resizeKafkaInstance(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()); } } } ``` - 扩容代理数量（按需实例）。 ``` 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 ResizeKafkaInstanceSolution { 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(); ResizeKafkaInstanceRequest request = new ResizeKafkaInstanceRequest(); request.withInstanceId("{instance_id}"); ResizeEngineInstanceReq body = new ResizeEngineInstanceReq(); List listbodyTenantIps = new ArrayList<>(); listbodyTenantIps.add("127.xx.xx.x"); listbodyTenantIps.add("127.xx.xx.x"); listbodyTenantIps.add("127.xx.xx.x"); body.withTenantIps(listbodyTenantIps); body.withNewBrokerNum(4); body.withNewStorageSpace(1600); body.withOperType("horizontal"); request.withBody(body); try { ResizeKafkaInstanceResponse response = client.resizeKafkaInstance(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()); } } } ``` - 扩容代理规格（按需实例）。 ``` 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 ResizeKafkaInstanceSolution { 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(); ResizeKafkaInstanceRequest request = new ResizeKafkaInstanceRequest(); request.withInstanceId("{instance_id}"); ResizeEngineInstanceReq body = new ResizeEngineInstanceReq(); body.withNewProductId("c6.4u8g.cluster"); body.withOperType("vertical"); request.withBody(body); try { ResizeKafkaInstanceResponse response = client.resizeKafkaInstance(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 = ResizeKafkaInstanceRequest() request.instance_id = "{instance_id}" request.body = ResizeEngineInstanceReq( new_storage_space=600, oper_type="storage" ) response = client.resize_kafka_instance(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) ``` - 扩容代理数量（按需实例）。 ``` # 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 = ResizeKafkaInstanceRequest() request.instance_id = "{instance_id}" listTenantIpsbody = [ "127.xx.xx.x", "127.xx.xx.x", "127.xx.xx.x" ] request.body = ResizeEngineInstanceReq( tenant_ips=listTenantIpsbody, new_broker_num=4, new_storage_space=1600, oper_type="horizontal" ) response = client.resize_kafka_instance(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) ``` - 扩容代理规格（按需实例）。 ``` # 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 = ResizeKafkaInstanceRequest() request.instance_id = "{instance_id}" request.body = ResizeEngineInstanceReq( new_product_id="c6.4u8g.cluster", oper_type="vertical" ) response = client.resize_kafka_instance(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.ResizeKafkaInstanceRequest{} request.InstanceId = "{instance_id}" newStorageSpaceResizeEngineInstanceReq:= int32(600) request.Body = &model.ResizeEngineInstanceReq{ NewStorageSpace: &newStorageSpaceResizeEngineInstanceReq, OperType: "storage", } response, err := client.ResizeKafkaInstance(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } ``` - 扩容代理数量（按需实例）。 ``` 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.ResizeKafkaInstanceRequest{} request.InstanceId = "{instance_id}" var listTenantIpsbody = []string{ "127.xx.xx.x", "127.xx.xx.x", "127.xx.xx.x", } newBrokerNumResizeEngineInstanceReq:= int32(4) newStorageSpaceResizeEngineInstanceReq:= int32(1600) request.Body = &model.ResizeEngineInstanceReq{ TenantIps: &listTenantIpsbody, NewBrokerNum: &newBrokerNumResizeEngineInstanceReq, NewStorageSpace: &newStorageSpaceResizeEngineInstanceReq, OperType: "horizontal", } response, err := client.ResizeKafkaInstance(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } ``` - 扩容代理规格（按需实例）。 ``` 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.ResizeKafkaInstanceRequest{} request.InstanceId = "{instance_id}" newProductIdResizeEngineInstanceReq:= "c6.4u8g.cluster" request.Body = &model.ResizeEngineInstanceReq{ NewProductId: &newProductIdResizeEngineInstanceReq, OperType: "vertical", } response, err := client.ResizeKafkaInstance(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=ResizeKafkaInstance)的代码示例页签，可生成自动对应的SDK代码示例。 #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | 实例扩容成功。 | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-kafka/ErrorCode.html)。