Help Center/ Distributed Message Service for Kafka/ API Reference/ APIs V2 (Recommended)/ Specification Modification Management/ Querying Product Information for Instance Specification Modification
Updated on 2024-06-07 GMT+08:00

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.

URI

GET /v2/{engine}/{project_id}/instances/{instance_id}/extend

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

engine

Yes

String

Message engine.

project_id

Yes

String

Project ID. For details about how to obtain it, see Obtaining a Project ID.

instance_id

Yes

String

Instance ID.

Table 2 Query Parameters

Parameter

Mandatory

Type

Description

type

Yes

String

Product edition.

  • advanced: premium edition

Request Parameters

None

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

engine

String

Message engine: Kafka.

versions

Array of strings

Versions supported by the message engine.

products

Array of ExtendProductInfoEntity objects

Product information for specification modification.

Table 4 ExtendProductInfoEntity

Parameter

Type

Description

type

String

Instance type.

product_id

String

Product ID.

ecs_flavor_id

String

ECS flavor used by the product.

arch_types

Array of strings

Supported CPU architectures.

charging_mode

Array of strings

Supported billing modes.

ios

Array of ExtendProductIosEntity objects

Disk I/O information.

support_features

Array of ExtendProductSupportFeaturesEntity objects

Supported features.

properties

ExtendProductPropertiesEntity object

Product specification description.

available_zones

Array of strings

AZs where there are available resources.

unavailable_zones

Array of strings

AZs where resources are sold out.

Table 5 ExtendProductIosEntity

Parameter

Type

Description

io_spec

String

Storage I/O specification.

available_zones

Array of strings

AZs where there are available resources.

type

String

I/O type.

unavailable_zones

Array of strings

AZs where resources are sold out.

Table 6 ExtendProductSupportFeaturesEntity

Parameter

Type

Description

name

String

Feature name.

properties

Map<String,String>

Key-value pair of a feature.

Table 7 ExtendProductPropertiesEntity

Parameter

Type

Description

max_partition_per_broker

String

Maximum number of partitions of each broker.

max_broker

String

Maximum number of brokers.

max_storage_per_node

String

Maximum storage space of each broker. Unit: GB.

max_consumer_per_broker

String

Maximum number of consumers of each broker.

min_broker

String

Minimum number of brokers.

max_bandwidth_per_broker

String

Maximum bandwidth of each broker.

min_storage_per_node

String

Minimum storage space of each broker. Unit: GB.

max_tps_per_broker

String

Maximum TPS of each broker.

product_alias

String

Alias of product_id.

Example Requests

Querying product information for instance specification modification

GET https://{endpoint}/v2/{engine}/{project_id}/instances/{instance_id}/extend?type={type}

Example Responses

Status code: 200

Successfully queried the product information for instance specification modification.

  • Product information for instance specification modification queried.

    {
      "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.high.dss.v2",
          "available_zones" : [ "xxx" ],
          "type" : "evs",
          "unavailable_zones" : [ ]
        }, {
          "io_spec" : "dms.physical.storage.ultra.dss.v2",
          "available_zones" : [ "xxx" ],
          "type" : "evs",
          "unavailable_zones" : [ ]
        }, {
          "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
49
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 ShowEngineInstanceExtendProductInfoSolution {

    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();
        ShowEngineInstanceExtendProductInfoRequest request = new ShowEngineInstanceExtendProductInfoRequest();
        request.withEngine(ShowEngineInstanceExtendProductInfoRequest.EngineEnum.fromValue("{engine}"));
        request.withInstanceId("{instance_id}");
        try {
            ShowEngineInstanceExtendProductInfoResponse response = client.showEngineInstanceExtendProductInfo(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
# 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 = ShowEngineInstanceExtendProductInfoRequest()
        request.engine = "{engine}"
        request.instance_id = "{instance_id}"
        response = client.show_engine_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
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.ShowEngineInstanceExtendProductInfoRequest{}
	request.Engine = model.GetShowEngineInstanceExtendProductInfoRequestEngineEnum().ENGINE
	request.InstanceId = "{instance_id}"
	response, err := client.ShowEngineInstanceExtendProductInfo(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.