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	Message engine, which is rocketmq.
project_id	Yes	String	Project ID. For details, see Obtaining a Project ID.
instance_id	Yes	String	Instance ID.

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
type	No	String	Product edition. advanced: premium edition

Request Parameters

None

Response Parameters

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
engine	String	Message Engine
versions	Array of strings	Versions supported by the message engine.
products	Array of RocketMQExtendProductInfoEntity objects	Product information for specification modification.

**Table 4** RocketMQExtendProductInfoEntity
Parameter	Type	Description
type	String	Instance type.
product_id	String	Product ID.
ecs_flavor_id	String	ECS flavor used by the product.
billing_code	String	Billing mode.
arch_types	Array of strings	Supported CPU architectures.
charging_mode	Array of strings	Supported billing modes.
ios	Array of RocketMQExtendProductIosEntity objects	Disk I/O information.
properties	RocketMQExtendProductPropertiesEntity object	Key-value pair of a feature.
available_zones	Array of strings	AZs where there are available resources.
unavailable_zones	Array of strings	AZs where resources are unavailable.
support_features	Array of RocketMQProductSupportFeaturesEntity objects	Supported features.
qingtian_incompatible	Boolean	Indicates whether the instance is a QingTian instance.

**Table 5** RocketMQExtendProductIosEntity
Parameter	Type	Description
io_spec	String	Storage I/O specification.
available_zones	Array of strings	AZs where there are available resources.
type	String	I/O type.
unavailable_zones	Array of strings	AZs where resources are unavailable.

**Table 6** RocketMQExtendProductPropertiesEntity
Parameter	Type	Description
max_broker	String	Maximum number of brokers.
max_topic_per_broker	String	Maximum number of topics that can be created on each broker.
max_consumer_per_broker	String	Maximum number of consumers of each broker.
max_storage_per_node	String	Maximum storage space of each broker. Unit: GB.
min_broker	String	Minimum number of brokers.
engine_versions	String	Version of the message engine.
min_storage_per_node	String	Minimum storage space of each broker. Unit: GB.
product_alias	String	Alias of product_id.

**Table 7** RocketMQProductSupportFeaturesEntity
Parameter	Type	Description
name	String	Feature name.
properties	Map<String,String>	Key-value pair of a feature.

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.

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

          

        

      
     

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

          

        

      
     

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

          

        

      
     