Querying Product Specifications

Updated on 2023-07-20 GMT+08:00

View PDF

Function

This API is used to query the product specifications.

URI

GET /v2/{engine}/products

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
engine	Yes	String	Message engine. Default: rabbitmq

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
product_id	No	String	Product ID.

Request Parameters

None

Response Parameters

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
engine	String	Message engine of DMS.
versions	Array of strings	Supported versions.
products	Array of ListEngineProductsEntity objects	Product specification details.

**Table 4** ListEngineProductsEntity
Parameter	Type	Description
type	String	Product type. Currently, single-node and cluster types are supported.
product_id	String	Product ID.
ecs_flavor_id	String	ECS flavor.
billing_code	String	Billing mode.
arch_types	Array of strings	CPU architecture.
charging_mode	Array of strings	Billing mode. monthly: yearly/monthly hourly: pay-per-use
ios	Array of ListEngineIosEntity objects	List of supported disk I/O types.
support_features	Array of objects	List of features supported by instances of the current specifications.
properties	ListEnginePropertiesEntity object	Attribute of instances of the current specifications.

**Table 5** ListEngineIosEntity
Parameter	Type	Description
io_spec	String	Disk I/O code.
type	String	Disk type.
available_zones	Array of strings	AZs.
unavailable_zones	Array of strings	Unavailable AZs.

**Table 6** ListEnginePropertiesEntity
Parameter	Type	Description
step_length	String	Node quantity increase step.
max_queue_per_broker	String	Maximum number of queues on each broker.
max_connection_per_broker	String	Maximum number of connections on each broker.
max_partition_per_broker	String	Maximum number of partitions of each broker.
max_broker	String	Maximum number of brokers.
max_storage_per_node	String	Maximum storage space of each broker. Unit: GB.
max_consumer_per_broker	String	Maximum number of consumers of each broker.
min_broker	String	Minimum number of brokers.
max_bandwidth_per_broker	String	Maximum bandwidth of each broker.
min_storage_per_node	String	Minimum storage space of each broker. Unit: GB
max_tps_per_broker	String	Maximum TPS of each broker.

Example Requests

GET https://{endpoint}/v2/rabbitmq/products

Example Responses

Status code: 200

Product specifications are queried successfully.

{
  "engine" : "rabbitmq",
  "versions" : [ "3.8.35" ],
  "products" : [ {
    "type" : "single",
    "product_id" : "c6.2u4g.single",
    "ecs_flavor_id" : "c6.large.2",
    "billing_code" : "dms.platinum.c6",
    "arch_types" : [ "X86" ],
    "charging_mode" : [ "monthly", "hourly" ],
    "ios" : [ {
      "io_spec" : "dms.physical.storage.ultra.v2",
      "type" : "evs",
      "available_zones" : [ "xxx" ],
      "unavailable_zones" : [ "xxx" ]
    }, {
      "io_spec" : "dms.physical.storage.high.v2",
      "type" : "evs",
      "available_zones" : [ "xxx" ],
      "unavailable_zones" : [ "xxx" ]
    } ],
    "support_features" : [ ],
    "properties" : {
      "max_connection_per_broker" : "2000",
      "max_broker" : "1",
      "max_queue_per_broker" : "100",
      "max_storage_per_node" : "30000",
      "min_broker" : "1",
      "step_length" : "0",
      "min_storage_per_node" : "200"
    }
  }, {
    "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.high.v2",
      "type" : "evs",
      "available_zones" : [ "xxx" ],
      "unavailable_zones" : [ "xxx" ]
    }, {
      "io_spec" : "dms.physical.storage.ultra.v2",
      "type" : "evs",
      "available_zones" : [ "xxx" ],
      "unavailable_zones" : [ "xxx" ]
    } ],
    "support_features" : [ ],
    "properties" : {
      "max_connection_per_broker" : "3000",
      "max_broker" : "7",
      "max_queue_per_broker" : "200",
      "max_storage_per_node" : "30000",
      "min_broker" : "3",
      "step_length" : "2",
      "min_storage_per_node" : "200"
    }
  } ]
}