Querying Flavor List

Function

This API is used to query the flavor list of an engine.

Calling Method

For details, see Calling APIs.

URI

GET /v2/{engine}/products

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
engine	Yes	String	Definition Message engine type. Constraints N/A Range rocketmq: RocketMQ message engine. reliability: RocketMQ message engine alias. Default Value rocketmq

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
type	No	String	Definition Product type. Constraints N/A Range advanced: Huawei Cloud service type. dec: Dedicated cloud service type. Default Value N/A
product_id	No	String	Definition RocketMQ instance flavors. Constraints N/A Range c6.4u8g.cluster.small: Max. 2,000 topics and 2,000 consumer groups per broker c6.4u8g.cluster: Max. 4,000 topics and 4,000 consumer groups per broker c6.8u16g.cluster: Max. 8,000 topics and 8,000 consumer groups per broker c6.12u24g.cluster: Max. 12,000 topics and 12,000 consumer groups per broker c6.16u32g.cluster: Max. 16,000 topics and 16,000 consumer groups per broker rocketmq.b1.large.1: RocketMQ 5.x basic edition single-node flavor, instance TPS 500 rocketmq.b2.large.4: RocketMQ 5.x basic edition cluster flavor, instance TPS 2,000 rocketmq.b2.large.8: RocketMQ 5.x basic edition cluster flavor, instance TPS 4,000 rocketmq.b2.large.12: RocketMQ 5.x basic edition cluster flavor, instance TPS 6,000 rocketmq.p1.large.1: RocketMQ 5.x professional edition single-node flavor, instance TPS 500 rocketmq.p2.large.8: RocketMQ 5.x professional edition cluster flavor, instance TPS 4,000 rocketmq.p2.large.12: RocketMQ 5.x professional edition cluster flavor, instance TPS 6,000 rocketmq.p2.large.20: RocketMQ 5.x professional edition cluster flavor, instance TPS 10,000 rocketmq.p2.large.40: RocketMQ 5.x professional edition cluster flavor, instance TPS 20,000 rocketmq.p2.large.100: RocketMQ 5.x professional edition cluster flavor, instance TPS 50,000 rocketmq.p2.large.150: RocketMQ 5.x professional edition cluster flavor, instance TPS 75,000 rocketmq.p2.large.200: RocketMQ 5.x professional edition cluster flavor, instance TPS 100,000 rocketmq.p2.large.300: RocketMQ 5.x professional edition cluster flavor, instance TPS 150,000 Default Value N/A

Request Parameters

None

Response Parameters

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
total	Number	Definition Total number. Range ≥ 0
next_offset	Integer	Definition Offset of the next page. Range ≥ 0
previous_offset	Integer	Definition Offset of the previous page. Range ≥ 0
engine	String	Definition Engine type. Range rocketmq: RocketMQ message engine. reliability: RocketMQ message engine alias.
versions	Array of strings	Definition Supported versions.
products	Array of ProductEntity objects	Definition Instance details.

**Table 4** ProductEntity
Parameter	Type	Description
type	String	Definition Product type. Range single: 4.8.0 single-node. cluster: 4.8.0 cluster single.basic: 5.x single-node basic edition. cluster.basic: 5.x cluster basic edition cluster.professional: 5.x cluster professional edition
product_id	String	Definition RocketMQ instance flavors. Range c6.4u8g.cluster.small: Max. 2,000 topics and 2,000 consumer groups per broker c6.4u8g.cluster: Max. 4,000 topics and 4,000 consumer groups per broker c6.8u16g.cluster: Max. 8,000 topics and 8,000 consumer groups per broker c6.12u24g.cluster: Max. 12,000 topics and 12,000 consumer groups per broker c6.16u32g.cluster: Max. 16,000 topics and 16,000 consumer groups per broker rocketmq.b1.large.1: RocketMQ 5.x basic edition single-node flavor, instance TPS 500 rocketmq.b2.large.4: RocketMQ 5.x basic edition cluster flavor, instance TPS 2,000 rocketmq.b2.large.8: RocketMQ 5.x basic edition cluster flavor, instance TPS 4,000 rocketmq.b2.large.12: RocketMQ 5.x basic edition cluster flavor, instance TPS 6,000 rocketmq.p1.large.1: RocketMQ 5.x professional edition single-node flavor, instance TPS 500 rocketmq.p2.large.8: RocketMQ 5.x professional edition cluster flavor, instance TPS 4,000 rocketmq.p2.large.12: RocketMQ 5.x professional edition cluster flavor, instance TPS 6,000 rocketmq.p2.large.20: RocketMQ 5.x professional edition cluster flavor, instance TPS 10,000 rocketmq.p2.large.40: RocketMQ 5.x professional edition cluster flavor, instance TPS 20,000 rocketmq.p2.large.100: RocketMQ 5.x professional edition cluster flavor, instance TPS 50,000 rocketmq.p2.large.150: RocketMQ 5.x professional edition cluster flavor, instance TPS 75,000 rocketmq.p2.large.200: RocketMQ 5.x professional edition cluster flavor, instance TPS 100,000 rocketmq.p2.large.300: RocketMQ 5.x professional edition cluster flavor, instance TPS 150,000
ecs_flavor_id	String	Definition ID of an ECS flavor. For details, see the flavor list in the ECS specifications. Range N/A
billing_code	String	Definition CBC flavor code. Range dms.platinum.c6: Huawei Cloud billing mode. dms.platinum.c6.dec: Dedicated cloud billing mode.
arch_types	Array of strings	Definition Supported architectures.
charging_mode	Array of strings	Definition Billing mode.
ios	Array of IOSEntity objects	Definition Supported I/O types. Range N/A
support_features	Array of strings	Definition Supported feature list. Range N/A
properties	properties object	Definition Product features. Range N/A
qingtian_incompatible	Boolean	Definition Whether the instance is a QingTian one. Range true: Yes false: No

**Table 5** IOSEntity
Parameter	Type	Description
available_zones	Array of strings	Definition AZ. Range N/A
unavailable_zones	Array of strings	Definition Unavailability zones. Range N/A
io_spec	String	Definition Storage flavor code. Range dms.physical.storage.high.v2: high I/O disk dms.physical.storage.ultra.v2: ultra-high I/O disk dms.physical.storage.general: general-purpose SSD dms.physical.storage.extreme: extreme SSD
type	String	Definition Service type. Range evs

**Table 6** properties
Parameter	Type	Description
max_topic	String	Definition Maximum number of topics. Range N/A
broker_num	String	Definition Broker quantity. Range N/A
core	String	Definition Number of billing cores of an entire instance. Range N/A
max_consumer	String	Definition Maximum number of consumers in an instance. Range N/A
rcu	String	Definition Traffic unit, rcu * max_tpc_per_rcu = Maximum flavor TPS. Range N/A
max_storage	String	Definition Maximum storage space, in GB. Range N/A
max_storage_per_node	String	Definition Maximum storage space of each node, in GB. Range N/A
product_alias	String	Definition Alias of product_id. Range N/A
max_tps_per_rcu	String	Definition Maximum TPS of each RCU. Range N/A
engine_versions	String	Definition Message engine version. Range 4.8.0 5.x
min_storage	String	Definition Minimum storage space, in GB. Range N/A
min_storage_per_node	String	Definition Minimum storage per node. Unit: GB. Range N/A
max_broker	String	Definition Maximum number of brokers. Range N/A
max_topic_per_broker	String	Definition Maximum number of topics that can be created on each broker. Range N/A
max_consumer_per_broker	String	Definition Maximum number of consumers on each broker. Range N/A
min_broker	String	Definition Minimum number of brokers. Range N/A

Example Requests

GET https://{endpoint}/v2/reliability/products?product_id=rocketmq.b1.large.1

Example Responses

Status code: 200

Successful

{
  "total" : 1,
  "next_offset" : -1,
  "previous_offset" : -1,
  "engine" : "rocketmq",
  "versions" : [ "5.x" ],
  "products" : [ {
    "type" : "single.basic",
    "product_id" : "rocketmq.b1.large.1",
    "ecs_flavor_id" : "c6.large.4",
    "billing_code" : "dms.rocketmq.basic.single.tps",
    "arch_types" : [ "X86" ],
    "charging_mode" : [ "monthly", "hourly" ],
    "ios" : [ {
      "io_spec" : "dms.physical.storage.high.v2",
      "available_zones" : [ "cn-southwest-xxa", "cn-southwest-xxb" ],
      "type" : "evs",
      "unavailable_zones" : [ "cn-southwest-xxc" ]
    }, {
      "io_spec" : "dms.physical.storage.ultra.v2",
      "available_zones" : [ "cn-southwest-xxa", "cn-southwest-xxb" ],
      "type" : "evs",
      "unavailable_zones" : [ "cn-southwest-xxc" ]
    } ],
    "support_features" : [ ],
    "properties" : {
      "max_topic" : 50,
      "broker_num" : 1,
      "core" : 1,
      "max_consumer" : 500,
      "rcu" : 1,
      "max_storage" : 30000,
      "max_storage_per_node" : 90000,
      "min_storage" : 100,
      "product_alias" : "rocketmq.b1.large.1",
      "max_tps_per_rcu" : 500,
      "engine_versions" : "5.x",
      "min_storage_per_node" : 300
    },
    "qingtian_incompatible" : false
  } ]
}

SDK Sample Code

The SDK sample code is as follows.

      
       
         
         
           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 ListEngineProductsSolution {

    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");

        ICredential auth = new BasicCredentials()
                .withAk(ak)
                .withSk(sk);

        RocketMQClient client = RocketMQClient.newBuilder()
                .withCredential(auth)
                .withRegion(RocketMQRegion.valueOf("<YOUR REGION>"))
                .build();
        ListEngineProductsRequest request = new ListEngineProductsRequest();
        request.withEngine("{engine}");
        try {
            ListEngineProductsResponse response = client.listEngineProducts(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 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"]

    credentials = BasicCredentials(ak, sk)

    client = RocketMQClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(RocketMQRegion.value_of("<YOUR REGION>")) \
        .build()

    try:
        request = ListEngineProductsRequest()
        request.engine = "{engine}"
        response = client.list_engine_products(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"
    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")

    auth := basic.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        Build()

    client := rocketmq.NewRocketMQClient(
        rocketmq.RocketMQClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

    request := &model.ListEngineProductsRequest{}
	request.Engine = "{engine}"
	response, err := client.ListEngineProducts(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

          

        

      
     