Help Center/ Distributed Message Service for RocketMQ/ API Reference/ APIs V2 (Recommended)/ Specification Change Management/ Querying Product Information for Instance Specification Modification
Updated on 2026-02-06 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

Querying Product Information for Instance Specification Modification

Function

This API is used to query the product information for instance specification modification.

Calling Method

For details, see Calling APIs.

URI

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

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

engine

Yes

String

Definition

Message engine type. rocketmq is available.

Constraints

N/A

Range

N/A

Default Value

N/A

project_id

Yes

String

Definition

Project ID. For details about how to obtain it, see Obtaining a Project ID.

Constraints

N/A

Range

N/A

Default Value

N/A

instance_id

Yes

String

Definition

Instance ID. You can call the API for querying all instances to obtain the instance ID. The instance ID is in the response body.

Constraints

N/A

Range

N/A

Default Value

N/A
Table 2 Query Parameters

Parameter

Mandatory

Type

Description

type

No

String

Definition

Product type. advanced: premium edition.

Constraints

N/A

Range

N/A

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.

Constraints

N/A

Range

N/A

Default Value

N/A

next_offset

Integer

Definition

Offset of the next page.

Constraints

N/A

Range

N/A

Default Value

N/A

previous_offset

Integer

Definition

Offset of the previous page.

Constraints

N/A

Range

N/A

Default Value

N/A

engine

String

Definition

Message engine type.

Constraints

N/A

Range

  • rocketmq: RocketMQ message engine.

  • reliability: RocketMQ message engine alias.

Default Value

N/A

versions

Array of strings

Definition

Versions supported by the message engine.

Constraints

N/A

Range

N/A

Default Value

N/A

products

Array of RocketMQExtendProductInfoEntity objects

Definition

Product information for specification modification.

Constraints

N/A

Range

N/A

Default Value

N/A
Table 4 RocketMQExtendProductInfoEntity

Parameter

Type

Description

type

String

Definition

Instance type.

Constraints

N/A

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

Default Value

N/A

product_id

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

ecs_flavor_id

String

Definition

ID of an ECS flavor. The specifications list of ECS can be referred. DMS can be adapted with general computing-plus C6 series and later. RocketMQ 5.x CPU/memory ratio is 1:4.

Constraints

N/A

Range

N/A

Default Value

N/A

billing_code

String

Definition

Billing mode.

Constraints

N/A

Range

  • dms.platinum.c6: Huawei Cloud billing mode.

  • dms.rocketmq.pro.single.tps: single-node RocketMQ 5.x professional edition.

  • dms.rocketmq.pro.cluster.tps: cluster RocketMQ 5.x professional edition.

  • dms.platinum.c6.dec: Dedicated cloud billing mode.

Default Value

N/A

arch_types

Array of strings

Definition

Supported CPU architectures.

Constraints

N/A

Range

N/A

Default Value

N/A

charging_mode

Array of strings

Definition

Supported billing modes.

Constraints

N/A

Range

N/A

Default Value

N/A

ios

Array of RocketMQExtendProductIosEntity objects

Definition

Disk I/O object information.

Constraints

N/A

Range

N/A

Default Value

N/A

properties

RocketMQExtendProductPropertiesEntity object

Definition

Key-value pair of a feature.

Constraints

N/A

Range

N/A

Default Value

N/A

available_zones

Array of strings

Definition

AZ list.

Constraints

N/A

Range

N/A

Default Value

N/A

unavailable_zones

Array of strings

Definition

Unavailable AZ list.

Constraints

N/A

Range

N/A

Default Value

N/A

support_features

Array of RocketMQProductSupportFeaturesEntity objects

Definition

Supported feature list.

Constraints

N/A

Range

N/A

Default Value

N/A

qingtian_incompatible

Boolean

Definition

Whether the instance is a QingTian one.

Constraints

N/A

Range

  • true: Yes

  • false: No

Default Value

N/A
Table 5 RocketMQExtendProductIosEntity

Parameter

Type

Description

io_spec

String

Definition

Storage I/O flavor.

Constraints

N/A

Range

N/A

Default Value

N/A

available_zones

Array of strings

Definition

AZ list.

Constraints

N/A

Range

N/A

Default Value

N/A

type

String

Definition

I/O type.

Constraints

N/A

Range

  • evs: Huawei Cloud disk type.

  • dss: Dedicated cloud disk type.

Default Value

N/A

unavailable_zones

Array of strings

Definition

Unavailable AZ list.

Constraints

N/A

Range

N/A

Default Value

N/A
Table 6 RocketMQExtendProductPropertiesEntity

Parameter

Type

Description

max_broker

String

Definition

Maximum number of brokers (displayed only for RocketMQ 4.8.0).

Constraints

N/A

Range

N/A

Default Value

N/A

max_topic_per_broker

String

Definition

Maximum number of topics that can be created on each node (displayed only for RocketMQ 4.8.0).

Constraints

N/A

Range

N/A

Default Value

N/A

max_consumer_per_broker

String

Definition

Maximum number of consumers on each node (displayed only for RocketMQ 4.8.0).

Constraints

N/A

Range

N/A

Default Value

N/A

min_broker

String

Definition

Minimum number of brokers (displayed only for RocketMQ 4.8.0).

Constraints

N/A

Range

N/A

Default Value

N/A

engine_versions

String

Definition

Message engine version.

Constraints

N/A

Range

  • 4.8.0

  • 5.x

Default Value

N/A

max_storage_per_node

String

Definition

Maximum storage space of each broker. Unit: GB.

Constraints

N/A

Range

N/A

Default Value

N/A

min_storage_per_node

String

Definition

Minimum storage per node. Unit: GB.

Constraints

N/A

Range

N/A

Default Value

N/A

product_alias

String

Definition

Alias of product_id.

Constraints

N/A

Range

N/A

Default Value

N/A

feature

String

Definition

Feature switch of the specification. (This field is displayed only for RocketMQ 5.x.)

Constraints

N/A

Range

N/A

Default Value

N/A

max_topic

String

Definition

Maximum number of topics in an instance (displayed only for RocketMQ 5.x).

Constraints

N/A

Range

N/A

Default Value

N/A

broker_num

String

Definition

Number of brokers (displayed only for RocketMQ 5.x).

Constraints

N/A

Range

N/A

Default Value

N/A

core

String

Definition

Number of billing cores in an instance (displayed only for RocketMQ 5.x).

Constraints

N/A

Range

N/A

Default Value

N/A

max_consumer

String

Definition

Maximum number of consumers in an instance (displayed only for RocketMQ 5.x).

Constraints

N/A

Range

N/A

Default Value

N/A

rcu

String

Definition

Traffic unit, rcu × max_tpc_per_rcu = Maximum flavor TPS (displayed only for RocketMQ 5.x).

Constraints

N/A

Range

N/A

Default Value

N/A

max_storage

String

Definition

Maximum storage space (displayed only for RocketMQ 5.x).

Constraints

N/A

Range

N/A

Default Value

N/A

min_storage

String

Definition

Minimum storage space (displayed only for RocketMQ 5.x).

Constraints

N/A

Range

N/A

Default Value

N/A

max_tps_per_rcu

String

Definition

Maximum TPS per RCU (displayed only for RocketMQ 5.x).

Constraints

N/A

Range

N/A

Default Value

N/A

elastic_tps

String

Definition

Elastic TPS (displayed only for RocketMQ 5.x).

Constraints

N/A

Range

N/A

Default Value

N/A
Table 7 RocketMQProductSupportFeaturesEntity

Parameter

Type

Description

name

String

Definition

Feature name.

Constraints

N/A

Range

N/A

Default Value

N/A

properties

Map<String,String>

Definition

Key-value pair of a feature.

Constraints

N/A

Range

N/A

Default Value

N/A

Example Requests

Querying the product information for instance modification

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

Example Responses

Status code: 200

Product information for instance specification modification queried.

{
  "total" : 5,
  "next_offset" : -1,
  "previous_offset" : -1,
  "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" : "c6.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 Sample Code

The SDK sample code is as follows.

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

For SDK sample code of more programming languages, see the Sample Code tab in API Explorer. SDK sample code can be automatically generated.

Status Codes

Status Code

Description

200

Product information for instance specification modification queried.

Error Codes

See Error Codes.

Parent Topic: Specification Change Management