文档首页/ 分布式消息服务Kafka版/ API参考/ API V2（推荐）/ 规格变更管理/ 查询实例的扩容规格列表
更新时间：2024-07-09 GMT+08:00
在线调试
CLI示例
查看PDF
分享

查询实例的扩容规格列表

功能介绍

查询实例的扩容规格列表。

调用方法

请参见如何调用API。

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

engine

是

String

消息引擎。

project_id

是

String

项目ID，获取方式请参见获取项目ID。

instance_id

是

String

实例ID。
表2 Query参数

参数

是否必选

参数类型

描述

type

是

String

产品的类型。

  • advanced: 专享版

请求参数

无

响应参数

状态码： 200

表3 响应Body参数

参数

参数类型

描述

engine

String

消息引擎类型:kafka。

versions

Array of strings

消息引擎支持的版本。

products

Array of ExtendProductInfoEntity objects

规格变更的产品信息。
表4 ExtendProductInfoEntity

参数

参数类型

描述

type

String

实例类型。

product_id

String

产品ID。

ecs_flavor_id

String

该产品使用的ECS规格。

arch_types

Array of strings

支持的CPU架构类型。

charging_mode

Array of strings

支持的计费模式类型。

ios

Array of ExtendProductIosEntity objects

磁盘IO信息。

support_features

Array of ExtendProductSupportFeaturesEntity objects

支持的特性功能。

properties

ExtendProductPropertiesEntity object

产品规格属性描述。

available_zones

Array of strings

有可用资源的可用区列表。

unavailable_zones

Array of strings

资源售罄的可用区列表。
表5 ExtendProductIosEntity

参数

参数类型

描述

io_spec

String

存储IO规格。

available_zones

Array of strings

有可用资源的可用区列表。

type

String

IO类型。

unavailable_zones

Array of strings

资源售罄的可用区列表。
表6 ExtendProductSupportFeaturesEntity

参数

参数类型

描述

name

String

特性名称。

properties

Map<String,String>

功能特性的键值对。
表7 ExtendProductPropertiesEntity

参数

参数类型

描述

max_partition_per_broker

String

每个Broker的最大分区数。

max_broker

String

Broker的最大个数。

max_storage_per_node

String

每个节点的最大存储。单位为GB。

max_consumer_per_broker

String

每个Broker的最大消费者数。

min_broker

String

Broker的最小个数。

max_bandwidth_per_broker

String

每个Broker的最大带宽。

min_storage_per_node

String

每个节点的最小存储。单位为GB。

max_tps_per_broker

String

每个Broker的最大TPS。

product_alias

String

product_id的别名。

请求示例

查询实例的扩容规格列表。

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

响应示例

状态码： 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.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代码示例

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
 
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)
    }
}

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

状态码

状态码

描述

200

查询实例的扩容规格列表成功。

错误码

请参见错误码。

父主题： 规格变更管理