文档首页/ 分布式消息服务RocketMQ版/ API参考/ API V2(推荐)/ 其他接口/ 查询产品规格列表 - ListEngineProducts
更新时间:2025-12-11 GMT+08:00
分享

查询产品规格列表 - ListEngineProducts

功能介绍

查询相应引擎的产品规格列表。

调用方法

请参见如何调用API

授权信息

账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。

  • 如果使用角色与策略授权,具体权限要求请参见权限和授权项
  • 如果使用身份策略授权,当前API调用无需身份策略权限。

URI

GET /v2/{engine}/products

表1 路径参数

参数

是否必选

参数类型

描述

engine

String

参数解释

消息引擎的类型。

约束限制

不涉及。

取值范围

  • rocketmq:RocketMQ消息引擎。

  • reliability:RocketMQ消息引擎别称。

默认取值

rocketmq。

表2 Query参数

参数

是否必选

参数类型

描述

type

String

参数解释

产品类型。

约束限制

不涉及。

取值范围

  • advanced:华为云服务类型。

  • dec:专属云服务类型。

默认取值

不涉及。

product_id

String

参数解释

RocketMQ实例规格。

约束限制

不涉及。

取值范围

  • c6.4u8g.cluster:单个代理最大Topic数4000,单个代理最大消费组数4000

  • c6.8u16g.cluster:单个代理最大Topic数8000,单个代理最大消费组数8000

  • c6.12u24g.cluster:单个代理最大Topic数12000,单个代理最大消费组数12000

  • c6.16u32g.cluster:单个代理最大Topic数16000,单个代理最大消费组数16000

  • rocketmq.b1.large.1:RocketMQ 5.x 基础版单机规格,实例TPS 500

  • rocketmq.b2.large.4:RocketMQ 5.x 基础版集群规格,实例TPS 2000

  • rocketmq.b2.large.8:RocketMQ 5.x 基础版集群规格,实例TPS 4000

  • rocketmq.b2.large.12:RocketMQ 5.x 基础版集群规格,实例TPS 6000

  • rocketmq.p1.large.1:RocketMQ 5.x 专业版单机规格,实例TPS 500

  • rocketmq.p2.large.8:RocketMQ 5.x 专业版集群规格,实例TPS 4000

  • rocketmq.p2.large.12:RocketMQ 5.x 专业版集群规格,实例TPS 6000

  • rocketmq.p2.large.20:RocketMQ 5.x 专业版集群规格,实例TPS 10000

  • rocketmq.p2.large.40:RocketMQ 5.x 专业版集群规格,实例TPS 20000

  • rocketmq.p2.large.100:RocketMQ 5.x 专业版集群规格,实例TPS 50000

  • rocketmq.p2.large.150:RocketMQ 5.x 专业版集群规格,实例TPS 75000

  • rocketmq.p2.large.200:RocketMQ 5.x 专业版集群规格,实例TPS 100000

  • rocketmq.p2.large.300:RocketMQ 5.x 专业版集群规格,实例TPS 150000

默认取值

不涉及。

请求参数

响应参数

状态码:200

表3 响应Body参数

参数

参数类型

描述

total

Number

参数解释

总数。

取值范围

大于等于0。

next_offset

Integer

参数解释

下个分页的offset。

取值范围

大于等于0。

previous_offset

Integer

参数解释

上个分页的offset。

取值范围

大于等于0。

engine

String

参数解释

引擎类型。

取值范围

  • rocketmq:RocketMQ消息引擎。

  • reliability:RocketMQ消息引擎别称。

versions

Array of strings

参数解释

支持的版本。

products

Array of ProductEntity objects

参数解释

产品详情列表。

表4 ProductEntity

参数

参数类型

描述

type

String

参数解释

产品类型。

取值范围

  • single:4.8.0单机。

  • cluster:4.8.0集群。

  • single.basic:5.x单机基础版。

  • cluster.basic:5.x集群基础版。

  • cluster.professional:5.x集群专业版。

product_id

String

参数解释

RocketMQ实例规格。

取值范围

  • c6.4u8g.cluster:单个代理最大Topic数4000,单个代理最大消费组数4000

  • c6.8u16g.cluster:单个代理最大Topic数8000,单个代理最大消费组数8000

  • c6.12u24g.cluster:单个代理最大Topic数12000,单个代理最大消费组数12000

  • c6.16u32g.cluster:单个代理最大Topic数16000,单个代理最大消费组数16000

  • rocketmq.b1.large.1:RocketMQ 5.x 基础版单机规格,实例TPS 500

  • rocketmq.b2.large.4:RocketMQ 5.x 基础版集群规格,实例TPS 2000

  • rocketmq.b2.large.8:RocketMQ 5.x 基础版集群规格,实例TPS 4000

  • rocketmq.b2.large.12:RocketMQ 5.x 基础版集群规格,实例TPS 6000

  • rocketmq.p1.large.1:RocketMQ 5.x 专业版单机规格,实例TPS 500

  • rocketmq.p2.large.8:RocketMQ 5.x 专业版集群规格,实例TPS 4000

  • rocketmq.p2.large.12:RocketMQ 5.x 专业版集群规格,实例TPS 6000

  • rocketmq.p2.large.20:RocketMQ 5.x 专业版集群规格,实例TPS 10000

  • rocketmq.p2.large.40:RocketMQ 5.x 专业版集群规格,实例TPS 20000

  • rocketmq.p2.large.100:RocketMQ 5.x 专业版集群规格,实例TPS 50000

  • rocketmq.p2.large.150:RocketMQ 5.x 专业版集群规格,实例TPS 75000

  • rocketmq.p2.large.200:RocketMQ 5.x 专业版集群规格,实例TPS 100000

  • rocketmq.p2.large.300:RocketMQ 5.x 专业版集群规格,实例TPS 150000

ecs_flavor_id

String

参数解释

ECS的Flavor ID。

取值范围

不涉及。

billing_code

String

参数解释

CBC的规格码。

取值范围

  • dms.platinum.c6:华为云账单计费类型。

  • dms.platinum.c6.dec:专属云账单计费类型。

arch_types

Array of strings

参数解释

支持的架构类型。

charging_mode

Object

参数解释

计费模式。

取值范围

不涉及。

ios

Array of IOSEntity objects

参数解释

支持的io类型。

取值范围

不涉及。

support_features

Array of strings

参数解释

支持的特性功能列表。

取值范围

不涉及。

properties

properties object

参数解释

产品特性。

取值范围

不涉及。

qingtian_incompatible

Boolean

参数解释

是否为擎天实例。

取值范围

  • true:是

  • false:否

表5 IOSEntity

参数

参数类型

描述

available_zones

Array of strings

参数解释

可用分区。

unavailable_zones

Array of strings

参数解释

不可用分区。

ios_spec

String

参数解释

存储类型规格编码。

取值范围

  • dms.physical.storage.high.v2:高IO类型磁盘

  • dms.physical.storage.ultra.v2:超高IO类型磁盘

  • dms.physical.storage.general:使用通用型SSD的磁盘类型。

  • dms.physical.storage.extreme:使用极速型SSD的磁盘类型。

type

String

参数解释

服务类型。

取值范围

evs。

表6 properties

参数

参数类型

描述

max_topic

String

参数解释

最大topic数。

取值范围

不涉及。

broker_num

String

参数解释

broker数量。

取值范围

不涉及。

core

String

参数解释

整个实例的计费核数。

取值范围

不涉及。

max_consumer

String

参数解释

实例消费者的最大数。

取值范围

不涉及。

rcu

String

参数解释

流量单元,rcu * max_tpc_per_rcu = 规格最大TPS。

取值范围

不涉及。

max_storage

String

参数解释

最大存储空间,单位为GB。

取值范围

不涉及。

max_storage_per_node

String

参数解释

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

取值范围

不涉及。

product_alias

String

参数解释

product_id的别名。

取值范围

不涉及。

max_tps_per_rcu

String

参数解释

单个rcu最大TPS。

取值范围

不涉及。

engine_versions

String

参数解释

消息引擎版本。

取值范围

  • 4.8.0

  • 5.x

min_storage

String

参数解释

最小存储空间,单位为GB。

取值范围

不涉及。

min_storage_per_node

String

参数解释

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

取值范围

不涉及。

请求示例

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

响应示例

状态码:200

查询产品规格列表成功。

{
  "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代码示例

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

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

状态码

状态码

描述

200

查询产品规格列表成功。

错误码

请参见错误码

相关文档