doc-exports/docs/dms_rocketmq/api-ref/ShowEngineInstanceExtendProductInfoForRocketMq.html

Querying Product Information for Instance Specification Modification

Function

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

URI

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

Table 1 Path Parameters

Parameter	Mandatory	Type	Description
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 advanced
limit	No	Integer	Definition Number of records to query. Constraints N/A Range N/A Default Value 10
offset	No	Integer	Definition Offset, which is the position where the query starts. The value must be greater than or equal to 0. Constraints N/A Range N/A Default Value 0

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.basic: 5.x single-node basic edition. cluster.basic: 5.x cluster basic edition Default Value N/A
product_id	String	Definition RocketMQ instance flavors. Constraints N/A Range If type is single.basic, select single-node flavors. If type is cluster.basic, select cluster flavors. 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 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.rocketmq.basic.single.tps: single-node RocketMQ 5.x basic edition. dms.rocketmq.basic.cluster.tps: cluster RocketMQ 5.x basic edition. 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. For RocketMQ 5.x basic edition: Select one AZ for a single-node instance and one or two AZs for a cluster one. 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. For RocketMQ 5.x basic edition: Select one AZ for a single-node instance and one or two AZs for a cluster one. Constraints N/A Range N/A Default Value N/A
type	String	Definition I/O type. Constraints N/A Range evs: 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
engine_versions	String	Definition Message engine version. Constraints N/A Range 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

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 an instance scaling list

GET https://{endpoint}/v2/{project_id}/rocketmq/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" : [ "5.x" ],
  "products" : [ {
    "type" : "single.basic",
    "product_id" : "rocketmq.b1.large.1",
    "ecs_flavor_id" : "c6.large.2",
    "arch_types" : [ "X86" ],
    "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" : [ ],
    "billing_code" : "dms.rocketmq.basic.single.tps",
    "charging_mode" : [ "monthly", "hourly" ],
    "properties" : {
      "broker_num" : 1,
      "core" : 1,
      "engine_versions" : "5.x",
      "max_consumer" : 500,
      "max_storage" : "30000",
      "max_storage_per_node" : "30000",
      "max_topic" : 50,
      "max_tps_per_rcu" : 500,
      "min_storage" : 100,
      "min_storage_per_node" : 100,
      "product_alias" : "rocketmq.b1.large.1",
      "rcu" : 1,
      "max_topic_per_broker" : 50
    },
    "available_zones" : [ "xxx" ],
    "unavailable_zones" : [ "xxx" ],
    "qingtian_incompatible" : false
  } ]
}

Status Codes

Status Code	Description
200	Product information for instance specification modification queried.

Error Codes

See Error Codes.

Parent topic: Managing Specification Changes