Querying Product Information for Instance Specification Modification

Function

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

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 about how to obtain it, see Obtaining a Project ID.
instance_id	Yes	String	Instance ID.

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
type	No	String	Type of a product. advanced: DMS for RocketMQ

Request Parameters

None

Response Parameters

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
total	Number	Total.
next_offset	Integer	Offset of the next page.
previous_offset	Integer	Offset of the previous page.
engine	String	Definition Message engine type. Range rocketmq: RocketMQ message engine. reliability: RocketMQ message engine alias.
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	Definition Instance 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	ECS flavor used by the product.
billing_code	String	Definition Billing mode. Range Billing mode. dms.rocketmq.basic.single.tps: single-node RocketMQ 5.x basic edition. dms.rocketmq.basic.cluster.tps: cluster RocketMQ 5.x basic edition. dms.rocketmq.pro.single.tps: single-node RocketMQ 5.x professional edition. dms.rocketmq.pro.cluster.tps: cluster RocketMQ 5.x professional edition.
arch_types	Array of strings	Supported CPU architectures.
charging_mode	Array of strings	Supported billing modes.
ios	Array of RocketMQExtendProductIosEntity objects	Disk I/O object 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 sold out.
support_features	Array of RocketMQProductSupportFeaturesEntity objects	Supported feature list.
qingtian_incompatible	Boolean	Definition Whether the instance is a QingTian one. Range true: Yes false: No

**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	Definition I/O type. Range evs: Disk type.
unavailable_zones	Array of strings	AZs where resources are sold out.

**Table 6** RocketMQExtendProductPropertiesEntity
Parameter	Type	Description
max_broker	String	Maximum number of brokers (displayed only for RocketMQ 4.8.0).
max_topic_per_broker	String	Maximum number of topics that can be created on each node (displayed only for RocketMQ 4.8.0).
max_consumer_per_broker	String	Maximum number of consumers on each node (displayed only for RocketMQ 4.8.0).
min_broker	String	Minimum number of brokers (displayed only for RocketMQ 4.8.0).
engine_versions	String	Definition Message engine version. Range 4.8.0 5.x
max_storage_per_node	String	Maximum storage space of each broker. Unit: GB.
min_storage_per_node	String	Minimum storage space of each broker. The unit is GB.
product_alias	String	Alias of product_id.
feature	String	Feature switch of the specification. (This field is available only for RocketMQ 5.x instances.)
max_topic	String	Maximum number of topics in an instance (displayed only for RocketMQ 5.x).
broker_num	String	Number of brokers (displayed only for RocketMQ 5.x).
core	String	Number of billing cores in an instance (displayed only for RocketMQ 5.x).
max_consumer	String	Maximum number of consumers in an instance (displayed only for RocketMQ 5.x).
rcu	String	Traffic unit, rcu × max_tpc_per_rcu = Maximum flavor TPS (displayed only for RocketMQ 5.x).
max_storage	String	Maximum storage space (displayed only for RocketMQ 5.x).
min_storage	String	Minimum storage space (displayed only for RocketMQ 5.x).
max_tps_per_rcu	String	Maximum TPS per RCU (displayed only for RocketMQ 5.x).
elastic_tps	String	Elastic TPS (displayed only for RocketMQ 5.x).

**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.

{
  "total" : 1,
  "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" : "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
  } ]
}