更新时间:2024-07-05 GMT+08:00

查询实例的扩容规格列表

功能介绍

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

调用方法

请参见如何调用API

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

engine

String

消息引擎的类型。支持的类型为rocketmq。

project_id

String

项目ID,获取方式请参见获取项目ID

instance_id

String

实例ID。

表2 Query参数

参数

是否必选

参数类型

描述

type

String

产品的类型。 advanced:专享版。

请求参数

响应参数

状态码: 200

表3 响应Body参数

参数

参数类型

描述

engine

String

消息引擎类型。

versions

Array of strings

消息引擎支持的版本。

products

Array of RocketMQExtendProductInfoEntity objects

规格变更的产品信息。

表4 RocketMQExtendProductInfoEntity

参数

参数类型

描述

type

String

实例类型。

product_id

String

产品ID。

ecs_flavor_id

String

该产品使用的ECS规格。

billing_code

String

账单计费类型。

arch_types

Array of strings

支持的CPU架构类型。

charging_mode

Array of strings

支持的计费模式类型。

ios

Array of RocketMQExtendProductIosEntity objects

磁盘IO信息。

properties

RocketMQExtendProductPropertiesEntity object

功能特性的键值对。

available_zones

Array of strings

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

unavailable_zones

Array of strings

资源售罄的可用区列表。

support_features

Array of RocketMQProductSupportFeaturesEntity objects

支持的特性功能。

qingtian_incompatible

Boolean

是否为擎天实例。

表5 RocketMQExtendProductIosEntity

参数

参数类型

描述

io_spec

String

存储IO规格。

available_zones

Array of strings

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

type

String

IO类型。

unavailable_zones

Array of strings

资源售罄的可用区列表。

表6 RocketMQExtendProductPropertiesEntity

参数

参数类型

描述

max_broker

String

Broker的最大个数。

max_topic_per_broker

String

每个节点最多能创建的Topic个数。

max_consumer_per_broker

String

每个节点的最大消费者数。

max_storage_per_node

String

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

min_broker

String

Broker的最小个数。

engine_versions

String

消息引擎版本。

min_storage_per_node

String

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

product_alias

String

product_id的别名。

表7 RocketMQProductSupportFeaturesEntity

参数

参数类型

描述

name

String

特性名称。

properties

Map<String,String>

功能特性的键值对。

请求示例

查询实例扩容列表。

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

响应示例

状态码: 200

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

  • {
      "engine" : "rocketmq",
      "versions" : [ "4.8.0" ],
      "products" : [ {
        "type" : "cluster.small",
        "product_id" : "c6.4u8g.cluster.small",
        "ecs_flavor_id" : "c6.xlarge.2",
        "billing_code" : "dms.platinum.c6",
        "arch_types" : [ "X86" ],
        "charging_mode" : [ "monthly", "hourly" ],
        "ios" : [ {
          "io_spec" : "dms.physical.storage.high.v2",
          "available_zones" : [ "xxx" ],
          "type" : "evs",
          "unavailable_zones" : [ "xxx" ]
        }, {
          "io_spec" : "dms.physical.storage.ultra.v2",
          "available_zones" : [ ],
          "type" : "evs",
          "unavailable_zones" : [ "xxx" ]
        } ],
        "support_features" : [ ],
        "properties" : {
          "max_broker" : "2",
          "max_topic_per_broker" : "2000",
          "max_storage_per_node" : "30000",
          "max_consumer_per_broker" : "2000",
          "min_broker" : "1",
          "product_alias" : "rocketmq.4u8g.cluster.small",
          "engine_versions" : "4.8.0",
          "min_storage_per_node" : "300"
        },
        "available_zones" : [ "xxx" ],
        "unavailable_zones" : [ "xxx" ],
        "qingtian_incompatible" : false
      }, {
        "type" : "cluster",
        "product_id" : "c6.4u8g.cluster",
        "ecs_flavor_id" : "s6.xlarge.2",
        "billing_code" : "dms.platinum.c6",
        "arch_types" : [ "X86" ],
        "charging_mode" : [ "monthly", "hourly" ],
        "ios" : [ {
          "io_spec" : "dms.physical.storage.ultra.v2",
          "available_zones" : [ ],
          "type" : "evs",
          "unavailable_zones" : [ "xxx" ]
        }, {
          "io_spec" : "dms.physical.storage.high.v2",
          "available_zones" : [ "xxx" ],
          "type" : "evs",
          "unavailable_zones" : [ "xxx" ]
        } ],
        "support_features" : [ ],
        "properties" : {
          "max_broker" : "10",
          "max_topic_per_broker" : "4000",
          "max_storage_per_node" : "60000",
          "max_consumer_per_broker" : "4000",
          "min_broker" : "1",
          "product_alias" : "rocketmq.4u8g.cluster",
          "engine_versions" : "4.8.0",
          "min_storage_per_node" : "300"
        },
        "available_zones" : [ "xxx" ],
        "unavailable_zones" : [ "xxx" ],
        "qingtian_incompatible" : false
      }, {
        "type" : "cluster",
        "product_id" : "c6.8u16g.cluster",
        "ecs_flavor_id" : "c6s.2xlarge.2",
        "billing_code" : "dms.platinum.c6",
        "arch_types" : [ "X86" ],
        "charging_mode" : [ "monthly", "hourly" ],
        "ios" : [ {
          "io_spec" : "dms.physical.storage.high.v2",
          "available_zones" : [ "xxx" ],
          "type" : "evs",
          "unavailable_zones" : [ "xxx" ]
        }, {
          "io_spec" : "dms.physical.storage.ultra.v2",
          "available_zones" : [ ],
          "type" : "evs",
          "unavailable_zones" : [ "xxx" ]
        } ],
        "support_features" : [ ],
        "properties" : {
          "max_broker" : "10",
          "max_topic_per_broker" : "8000",
          "max_storage_per_node" : "90000",
          "max_consumer_per_broker" : "8000",
          "min_broker" : "1",
          "product_alias" : "rocketmq.8u16g.cluster",
          "engine_versions" : "4.8.0",
          "min_storage_per_node" : "300"
        },
        "available_zones" : [ "xxx" ],
        "unavailable_zones" : [ "xxx" ],
        "qingtian_incompatible" : false
      }, {
        "type" : "cluster",
        "product_id" : "c6.12u24g.cluster",
        "ecs_flavor_id" : "c6s.3xlarge.2",
        "billing_code" : "dms.platinum.c6",
        "arch_types" : [ "X86" ],
        "charging_mode" : [ "monthly", "hourly" ],
        "ios" : [ {
          "io_spec" : "dms.physical.storage.ultra.v2",
          "available_zones" : [ ],
          "type" : "evs",
          "unavailable_zones" : [ "xxx" ]
        }, {
          "io_spec" : "dms.physical.storage.high.v2",
          "available_zones" : [ "xxx" ],
          "type" : "evs",
          "unavailable_zones" : [ "xxx" ]
        } ],
        "support_features" : [ ],
        "properties" : {
          "max_broker" : "10",
          "max_topic_per_broker" : "12000",
          "max_storage_per_node" : "90000",
          "max_consumer_per_broker" : "12000",
          "min_broker" : "1",
          "product_alias" : "rocketmq.12u24g.cluster",
          "engine_versions" : "4.8.0",
          "min_storage_per_node" : "300"
        },
        "available_zones" : [ "xxx" ],
        "unavailable_zones" : [ "xxx" ],
        "qingtian_incompatible" : false
      }, {
        "type" : "cluster",
        "product_id" : "c6.16u32g.cluster",
        "ecs_flavor_id" : "c6.4xlarge.2",
        "billing_code" : "dms.platinum.c6",
        "arch_types" : [ "X86" ],
        "charging_mode" : [ "monthly", "hourly" ],
        "ios" : [ {
          "io_spec" : "dms.physical.storage.high.v2",
          "available_zones" : [ "xxx" ],
          "type" : "evs",
          "unavailable_zones" : [ "xxx" ]
        }, {
          "io_spec" : "dms.physical.storage.ultra.v2",
          "available_zones" : [ ],
          "type" : "evs",
          "unavailable_zones" : [ "xxx" ]
        } ],
        "support_features" : [ ],
        "properties" : {
          "max_broker" : "10",
          "max_topic_per_broker" : "16000",
          "max_storage_per_node" : "90000",
          "max_consumer_per_broker" : "16000",
          "min_broker" : "1",
          "product_alias" : "rocketmq.16u32g.cluster",
          "engine_versions" : "4.8.0",
          "min_storage_per_node" : "300"
        },
        "available_zones" : [ "xxx" ],
        "unavailable_zones" : [ "xxx" ],
        "qingtian_incompatible" : false
      } ]
    }

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.rocketmq.v2.region.RocketMQRegion;
import com.huaweicloud.sdk.rocketmq.v2.*;
import com.huaweicloud.sdk.rocketmq.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);

        RocketMQClient client = RocketMQClient.newBuilder()
                .withCredential(auth)
                .withRegion(RocketMQRegion.valueOf("<YOUR REGION>"))
                .build();
        ShowEngineInstanceExtendProductInfoRequest request = new ShowEngineInstanceExtendProductInfoRequest();
        request.withEngine("{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 huaweicloudsdkrocketmq.v2.region.rocketmq_region import RocketMQRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdkrocketmq.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 = RocketMQClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(RocketMQRegion.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"
    rocketmq "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/rocketmq/v2"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/rocketmq/v2/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/rocketmq/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 := rocketmq.NewRocketMQClient(
        rocketmq.RocketMQClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

    request := &model.ShowEngineInstanceExtendProductInfoRequest{}
	request.Engine = "{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

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

错误码

请参见错误码