Querying Product Information for Instance Specification Modification
Function
This API is used to query the product information for instance specification modification.
Calling Method
For details, see Calling APIs.
Authorization Information
Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.
- If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.
- If you are using identity policy-based authorization, no identity policy-based permission required for calling this API.
URI
GET /v2/{project_id}/kafka/instances/{instance_id}/extend
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| project_id | Yes | String | Definition Project ID. For details, see Obtaining a Project ID. Constraints N/A Range N/A Default Value N/A |
| instance_id | Yes | String | Definition Instance ID. To obtain it, call the API for querying all instances. Constraints N/A Range N/A Default Value N/A |
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| type | Yes | String | Definition Product type. Constraints N/A Range advanced Default Value N/A |
Request Parameters
None
Response Parameters
Status code: 200
| Parameter | Type | Description |
|---|---|---|
| engine | String | Definition Message engine type. Range kafka. |
| versions | Array of strings | Definition Versions supported by the message engine. |
| total | Long | Definition Total number. Range N/A |
| previous_offset | Long | Definition Previous offset. Range N/A |
| next_offset | Long | Definition Next offset. Range N/A |
| products | Array of ExtendProductInfoEntity objects | Definition Information about the product whose specifications are changed. |
| Parameter | Type | Description |
|---|---|---|
| type | String | Definition Instance type. Range |
| product_id | String | Definition Product ID. Range N/A |
| ecs_flavor_id | String | Definition Used ECS flavor. Range N/A |
| billing_code | String | Definition Billing code. Range N/A |
| qingtian_incompatible | Boolean | Definition Whether the specifications are incompatible with QingTian instances. Range |
| arch_types | Array of strings | Definition Supported CPU architectures. |
| charging_mode | Array of strings | Definition Supported billing modes. |
| ios | Array of ExtendProductIosEntity objects | Definition Disk I/O information. |
| support_features | Array of ExtendProductSupportFeaturesEntity objects | Definition Supported features. |
| properties | Definition Product specification attribute description. | |
| available_zones | Array of strings | Definition AZs with available resources. |
| unavailable_zones | Array of strings | Definition List of AZs where resources have been sold out. |
| Parameter | Type | Description |
|---|---|---|
| io_spec | String | Definition Storage I/O specification. Range |
| available_zones | Array of strings | Definition AZs with available resources. |
| type | String | Definition I/O type. Range evs. |
| unavailable_zones | Array of strings | Definition AZs where resources are sold out. |
| Parameter | Type | Description |
|---|---|---|
| name | String | Definition Feature name. Range N/A |
| properties | Map<String,String> | Definition Key-value pair of a feature. |
| Parameter | Type | Description |
|---|---|---|
| max_partition_per_broker | String | Definition Maximum number of partitions per broker. Range N/A |
| network_bandwidth | String | Definition Assured network bandwidth. Range N/A |
| max_connections_per_broker | String | Definition Maximum number of connections per broker. Range N/A |
| max_replica_per_broker | String | Definition Maximum number of replicas per broker. Range N/A |
| max_ssl_connections_per_broker | String | Definition Maximum number of SSL connections per broker. Range N/A |
| max_broker | String | Definition Maximum number of brokers. Range N/A |
| max_storage_per_node | String | Definition Maximum storage space of each broker. Unit: GB. Range N/A |
| max_consumer_per_broker | String | Definition Maximum number of consumers of each broker. Range N/A |
| min_broker | String | Definition Minimum number of brokers. Range N/A |
| max_bandwidth_per_broker | String | Definition Maximum bandwidth of each broker. Range N/A |
| min_storage_per_node | String | Definition Minimum storage space of each broker. Unit: GB. Range N/A |
| max_tps_per_broker | String | Definition Maximum TPS of each broker. Range N/A |
| product_alias | String | Definition Alias of product_id. Range N/A |
Example Requests
Querying product information for instance specification modification
GET https://{endpoint}/v2/{project_id}/kafka/instances/{instance_id}/extend?type={type} Example Responses
Status code: 200
{
"engine" : "kafka",
"versions" : [ "1.1.0", "2.7" ],
"products" : [ {
"type" : "cluster",
"product_id" : "c6.2u4g.cluster",
"ecs_flavor_id" : "c3.large.2",
"arch_types" : [ "X86" ],
"charging_mode" : [ "monthly", "hourly" ],
"ios" : [ {
"io_spec" : "dms.physical.storage.high.v2",
"available_zones" : [ "xxx" ],
"type" : "evs",
"unavailable_zones" : [ ]
}, {
"io_spec" : "dms.physical.storage.ultra.v2",
"available_zones" : [ "xxx" ],
"type" : "evs",
"unavailable_zones" : [ ]
} ],
"support_features" : [ {
"name" : "connector_obs",
"properties" : {
"max_task" : "10",
"max_node" : "10",
"min_task" : "1",
"min_node" : "2"
}
} ],
"properties" : {
"max_partition_per_broker" : "250",
"max_broker" : "30",
"max_storage_per_node" : "10000",
"max_consumer_per_broker" : "4000",
"min_broker" : "3",
"product_alias" : "kafka.2u4g.cluster",
"max_bandwidth_per_broker" : "100",
"min_storage_per_node" : "100",
"max_tps_per_broker" : "30000"
},
"available_zones" : [ "xxx" ],
"unavailable_zones" : [ ]
}, {
"type" : "cluster",
"product_id" : "c6.2u4g.cluster.dec",
"ecs_flavor_id" : "c6.large.2",
"arch_types" : [ "X86" ],
"charging_mode" : [ "monthly", "hourly" ],
"ios" : [ {
"io_spec" : "dms.physical.storage.ultra.v2",
"available_zones" : [ "xxx" ],
"type" : "evs",
"unavailable_zones" : [ ]
}, {
"io_spec" : "dms.physical.storage.high.v2",
"available_zones" : [ "xxx" ],
"type" : "evs",
"unavailable_zones" : [ ]
} ],
"support_features" : [ {
"name" : "connector_obs",
"properties" : {
"max_task" : "10",
"max_node" : "10",
"min_task" : "1",
"min_node" : "2"
}
} ],
"properties" : {
"max_partition_per_broker" : "100",
"max_broker" : "30",
"max_storage_per_node" : "400",
"max_consumer_per_broker" : "4000",
"min_broker" : "3",
"product_alias" : "kafka.2u4g.cluster.dec",
"max_bandwidth_per_broker" : "100",
"min_storage_per_node" : "100",
"max_tps_per_broker" : "30000"
},
"available_zones" : [ ],
"unavailable_zones" : [ "xxx" ]
}, {
"type" : "cluster",
"product_id" : "c6.4u8g.cluster",
"ecs_flavor_id" : "c3.xlarge.2",
"arch_types" : [ "X86" ],
"charging_mode" : [ "monthly", "hourly" ],
"ios" : [ {
"io_spec" : "dms.physical.storage.high.v2",
"available_zones" : [ "xxx" ],
"type" : "evs",
"unavailable_zones" : [ ]
}, {
"io_spec" : "dms.physical.storage.ultra.v2",
"available_zones" : [ "xxx" ],
"type" : "evs",
"unavailable_zones" : [ ]
} ],
"support_features" : [ {
"name" : "connector_obs",
"properties" : {
"max_task" : "10",
"max_node" : "10",
"min_task" : "1",
"min_node" : "2"
}
} ],
"properties" : {
"max_partition_per_broker" : "500",
"max_broker" : "30",
"max_storage_per_node" : "20000",
"max_consumer_per_broker" : "4000",
"min_broker" : "3",
"product_alias" : "kafka.4u8g.cluster",
"max_bandwidth_per_broker" : "100",
"min_storage_per_node" : "100",
"max_tps_per_broker" : "100000"
},
"available_zones" : [ "xxx" ],
"unavailable_zones" : [ ]
}, {
"type" : "cluster",
"product_id" : "c6.8u16g.cluster",
"ecs_flavor_id" : "c3.2xlarge.2",
"arch_types" : [ "X86" ],
"charging_mode" : [ "monthly", "hourly" ],
"ios" : [ {
"io_spec" : "dms.physical.storage.high.v2",
"available_zones" : [ "xxx" ],
"type" : "evs",
"unavailable_zones" : [ ]
}, {
"io_spec" : "dms.physical.storage.ultra.v2",
"available_zones" : [ "xxx" ],
"type" : "evs",
"unavailable_zones" : [ ]
} ],
"support_features" : [ {
"name" : "connector_obs",
"properties" : {
"max_task" : "10",
"max_node" : "10",
"min_task" : "1",
"min_node" : "2"
}
} ],
"properties" : {
"max_partition_per_broker" : "1000",
"max_broker" : "30",
"max_storage_per_node" : "30000",
"max_consumer_per_broker" : "4000",
"min_broker" : "3",
"product_alias" : "kafka.8u16g.cluster",
"max_bandwidth_per_broker" : "100",
"min_storage_per_node" : "100",
"max_tps_per_broker" : "150000"
},
"available_zones" : [ "xxx" ],
"unavailable_zones" : [ ]
}, {
"type" : "cluster",
"product_id" : "c6.12u24g.cluster",
"ecs_flavor_id" : "c3.3xlarge.2",
"arch_types" : [ "X86" ],
"charging_mode" : [ "monthly", "hourly" ],
"ios" : [ {
"io_spec" : "dms.physical.storage.high.v2",
"available_zones" : [ "xxx" ],
"type" : "evs",
"unavailable_zones" : [ ]
}, {
"io_spec" : "dms.physical.storage.ultra.v2",
"available_zones" : [ "xxx" ],
"type" : "evs",
"unavailable_zones" : [ ]
} ],
"support_features" : [ {
"name" : "connector_obs",
"properties" : {
"max_task" : "10",
"max_node" : "10",
"min_task" : "1",
"min_node" : "2"
}
} ],
"properties" : {
"max_partition_per_broker" : "1500",
"max_broker" : "30",
"max_storage_per_node" : "30000",
"max_consumer_per_broker" : "4000",
"min_broker" : "3",
"product_alias" : "kafka.12u24g.cluster",
"max_bandwidth_per_broker" : "100",
"min_storage_per_node" : "100",
"max_tps_per_broker" : "200000"
},
"available_zones" : [ "xxx" ],
"unavailable_zones" : [ ]
}, {
"type" : "cluster",
"product_id" : "c6.16u32g.cluster",
"ecs_flavor_id" : "c3.4xlarge.2",
"arch_types" : [ "X86" ],
"charging_mode" : [ "monthly", "hourly" ],
"ios" : [ {
"io_spec" : "dms.physical.storage.high.v2",
"available_zones" : [ "xxx" ],
"type" : "evs",
"unavailable_zones" : [ ]
}, {
"io_spec" : "dms.physical.storage.ultra.v2",
"available_zones" : [ "xxx" ],
"type" : "evs",
"unavailable_zones" : [ ]
} ],
"support_features" : [ {
"name" : "connector_obs",
"properties" : {
"max_task" : "10",
"max_node" : "10",
"min_task" : "1",
"min_node" : "2"
}
} ],
"properties" : {
"max_partition_per_broker" : "2000",
"max_broker" : "30",
"max_storage_per_node" : "30000",
"max_consumer_per_broker" : "4000",
"min_broker" : "3",
"product_alias" : "kafka.16u32g.cluster",
"max_bandwidth_per_broker" : "100",
"min_storage_per_node" : "100",
"max_tps_per_broker" : "250000"
},
"available_zones" : [ "xxx" ],
"unavailable_zones" : [ ]
} ]
} SDK Sample Code
The SDK sample code is as follows.
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 ShowKafkaInstanceExtendProductInfoSolution { 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(); ShowKafkaInstanceExtendProductInfoRequest request = new ShowKafkaInstanceExtendProductInfoRequest(); request.withInstanceId("{instance_id}"); try { ShowKafkaInstanceExtendProductInfoResponse response = client.showKafkaInstanceExtendProductInfo(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 = ShowKafkaInstanceExtendProductInfoRequest() request.instance_id = "{instance_id}" response = client.show_kafka_instance_extend_product_info(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 | 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("<YOUR REGION>")). WithCredential(auth). SafeBuild() if err != nil { fmt.Println(err) return } client := kafka.NewKafkaClient(hcClient) request := &model.ShowKafkaInstanceExtendProductInfoRequest{} request.InstanceId = "{instance_id}" response, err := client.ShowKafkaInstanceExtendProductInfo(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
For SDK sample code of more programming languages, see the Sample Code tab in API Explorer. SDK sample code can be automatically generated.
Status Codes
| Status Code | Description |
|---|---|
| 200 | Successfully queried the product information for instance specification modification. |
Error Codes
See Error Codes.
What is your overall rating for this page?
Thank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot