文档首页> 分布式消息服务Kafka版> API参考> API V2（推荐）> 规格变更管理> 查询实例的扩容规格列表

更新时间：2024-07-05 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代码示例如下。

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

          

        

      
     

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

          

        

      
     

      
       
         
         
           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	查询实例的扩容规格列表成功。

错误码

请参见错误码。

父主题：规格变更管理

上一篇：实例扩容

下一篇：主题管理

意见反馈

文档内容是否对您有帮助？

有帮助没帮助

提供反馈

提交成功！非常感谢您的反馈，我们会继续努力做到更好！您可在我的云声建议查看反馈及问题处理状态。

系统繁忙，请稍后重试

在使用文档中是否遇到以下问题

内容与产品页面不一致

内容不易理解

缺失示例代码

步骤不可操作

搜不到想要的内容

缺少最佳实践

意见反馈（选填）

0/500

请至少选择一项反馈信息并填写问题反馈

字符长度不能超过500

直接提交取消

如您有其它疑问，您也可以通过华为云社区问答频道来与我们联系探讨

智能客服提问云社区提问

查询实例的扩容规格列表

功能介绍

调用方法

URI

请求参数

响应参数

请求示例

响应示例

SDK代码示例

状态码

错误码

相关文档

相关产品

意见反馈

文档内容是否对您有帮助？

7*24

备案

专业服务

退订

建议反馈

售前咨询热线