Querying Product Specifications List

Function

This API is used to query the product specifications list.

Calling Method

For details, see Calling APIs.

URI

GET /v2/{engine}/products

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
engine	Yes	String	Definition: Engine type. Constraints: N/A Range: kafka Default Value: N/A

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
product_id	No	String	Definition Product ID. Constraints N/A Range s6.2u4g.single.small: flavor kafka.2u4g.single.small c6.2u4g.single: flavor kafka.2u4g.single s6.2u4g.cluster.small: flavor kafka.2u4g.cluster.small c6.2u4g.cluster: flavor kafka.2u4g.cluster c6.4u8g.cluster: flavor kafka.4u8g.cluster c6.8u16g.cluster: flavor kafka.8u16g.cluster c6.12u24g.cluster: flavor kafka.12u24g.cluster c6.16u32g.cluster: flavor kafka.16u32g.cluster Default Value N/A

Request Parameters

None

Response Parameters

Status code: 200

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

**Table 4** ListEngineProductsEntity
Parameter	Type	Description
type	String	Definition Product type. Range single: single-node cluster: cluster
product_id	String	Definition: Product ID. Range: N/A
ecs_flavor_id	String	Definition: ECS flavor. Range: N/A
billing_code	String	Definition: Billing mode. Range: N/A
arch_types	Array of strings	Definition: CPU architecture.
charging_mode	Array of strings	Definition: Billing mode.
ios	Array of ListEngineIosEntity objects	Definition: List of supported disk I/O types.
support_features	Array of ListEngineSupportFeaturesEntity objects	Definition: List of features supported by instances of the current specifications.
properties	ListEnginePropertiesEntity object	Definition: Attribute of instances of the current specifications.

**Table 5** ListEngineIosEntity
Parameter	Type	Description
io_spec	String	Definition: Disk I/O code. Range: dms.physical.storage.high.v2: High I/O dms.physical.storage.ultra.v2: Ultra-high I/O
type	String	Definition: Disk type. Range: evs
available_zones	Array of strings	Definition: AZ.
unavailable_zones	Array of strings	Definition: Unavailable AZs.

**Table 6** ListEngineSupportFeaturesEntity
Parameter	Type	Description
name	String	Definition: Feature name. Range: N/A
properties	ListEngineSupportFeaturesPropertiesEntity object	Definition: Description of the features supported by the instance.

**Table 7** ListEngineSupportFeaturesPropertiesEntity
Parameter	Type	Description
max_task	String	Definition: Maximum number of Smart Connect tasks. Range: N/A
min_task	String	Definition: Minimum number of Smart Connect tasks. Range: N/A
max_node	String	Definition: Maximum number of Smart Connect nodes. Range: N/A
min_node	String	Definition: Minimum number of Smart Connect nodes. Range: N/A

**Table 8** ListEnginePropertiesEntity
Parameter	Type	Description
max_partition_per_broker	String	Definition: Maximum number of partitions per broker. Range: N/A
max_broker	String	Definition: Maximum number of brokers. Range: N/A
max_storage_per_node	String	Definition: Maximum storage per node. Unit: GB. Range: N/A
max_consumer_per_broker	String	Definition: Maximum number of consumers of each broker. Range: N/A
min_broker	String	Definition: Minimum number of brokers. Range: N/A
max_bandwidth_per_broker	String	Definition: Maximum bandwidth of each broker. Range: N/A
min_storage_per_node	String	Definition: Minimum storage per node. Unit: GB. Range: N/A
max_tps_per_broker	String	Definition: Maximum TPS of each broker. Range: N/A
product_alias	String	Definition: Alias of product_id. Range: N/A

Example Requests

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

Example Responses

Status code: 200

The product specifications are listed successfully.

{
  "engine" : "kafka",
  "versions" : [ "1.1.0", 2.7, "3.x" ],
  "products" : [ {
    "type" : "cluster",
    "product_id" : "c6.2u4g.cluster",
    "ecs_flavor_id" : "c6.large.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", "xxx" ],
      "unavailable_zones" : [ "xxx", "xxx" ]
    }, {
      "io_spec" : "dms.physical.storage.ultra.v2",
      "type" : "evs",
      "available_zones" : [ "xxx", "xxx" ],
      "unavailable_zones" : [ "xxx", "xxx" ]
    } ],
    "support_features" : [ {
      "name" : "connector_obs",
      "properties" : {
        "max_task" : "10",
        "max_node" : "10",
        "min_task" : "1",
        "min_node" : "2"
      }
    } ],
    "properties" : {
      "max_partition_per_broker" : "250",
      "max_broker" : "30",
      "max_storage_per_node" : "10000",
      "max_consumer_per_broker" : "4000",
      "min_broker" : "3",
      "max_bandwidth_per_broker" : "100",
      "min_storage_per_node" : "200",
      "max_tps_per_broker" : "30000",
      "product_alias" : "kafka.2u4g.cluster"
    }
  }, {
    "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", "xxx" ],
      "unavailable_zones" : [ "xxx", "xxx" ]
    }, {
      "io_spec" : "dms.physical.storage.ultra.v2",
      "type" : "evs",
      "available_zones" : [ "xxx", "xxx" ],
      "unavailable_zones" : [ "xxx", "xxx" ]
    } ],
    "support_features" : [ {
      "name" : "connector_obs",
      "properties" : {
        "max_task" : "10",
        "max_node" : "10",
        "min_task" : "1",
        "min_node" : "2"
      }
    } ],
    "properties" : {
      "max_partition_per_broker" : "500",
      "max_broker" : "30",
      "max_storage_per_node" : "20000",
      "max_consumer_per_broker" : "4000",
      "min_broker" : "3",
      "max_bandwidth_per_broker" : "100",
      "min_storage_per_node" : "400",
      "max_tps_per_broker" : "100000",
      "product_alias" : "kafka.4u8g.cluster"
    }
  }, {
    "type" : "cluster",
    "product_id" : "c6.8u16g.cluster",
    "ecs_flavor_id" : "c6.2xlarge.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", "xxx" ],
      "unavailable_zones" : [ "xxx", "xxx" ]
    }, {
      "io_spec" : "dms.physical.storage.ultra.v2",
      "type" : "evs",
      "available_zones" : [ "xxx", "xxx" ],
      "unavailable_zones" : [ "xxx", "xxx" ]
    } ],
    "support_features" : [ {
      "name" : "connector_obs",
      "properties" : {
        "max_task" : "10",
        "max_node" : "10",
        "min_task" : "1",
        "min_node" : "2"
      }
    } ],
    "properties" : {
      "max_partition_per_broker" : "1000",
      "max_broker" : "30",
      "max_storage_per_node" : "30000",
      "max_consumer_per_broker" : "4000",
      "min_broker" : "3",
      "max_bandwidth_per_broker" : "100",
      "min_storage_per_node" : "800",
      "max_tps_per_broker" : "150000",
      "product_alias" : "kafka.8u16g.cluster"
    }
  }, {
    "type" : "cluster",
    "product_id" : "c6.12u24g.cluster",
    "ecs_flavor_id" : "c6.3xlarge.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", "xxx" ],
      "unavailable_zones" : [ "xxx", "xxx" ]
    }, {
      "io_spec" : "dms.physical.storage.ultra.v2",
      "type" : "evs",
      "available_zones" : [ "xxx", "xxx" ],
      "unavailable_zones" : [ "xxx", "xxx" ]
    } ],
    "support_features" : [ {
      "name" : "connector_obs",
      "properties" : {
        "max_task" : "10",
        "max_node" : "10",
        "min_task" : "1",
        "min_node" : "2"
      }
    } ],
    "properties" : {
      "max_partition_per_broker" : "1500",
      "max_broker" : "30",
      "max_storage_per_node" : "30000",
      "max_consumer_per_broker" : "4000",
      "min_broker" : "3",
      "max_bandwidth_per_broker" : "100",
      "min_storage_per_node" : "1200",
      "max_tps_per_broker" : "200000",
      "product_alias" : "kafka.12u24g.cluster"
    }
  }, {
    "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",
      "type" : "evs",
      "available_zones" : [ "xxx", "xxx" ],
      "unavailable_zones" : [ "xxx", "xxx" ]
    }, {
      "io_spec" : "dms.physical.storage.ultra.v2",
      "type" : "evs",
      "available_zones" : [ "xxx", "xxx" ],
      "unavailable_zones" : [ "xxx", "xxx" ]
    } ],
    "support_features" : [ {
      "name" : "connector_obs",
      "properties" : {
        "max_task" : "10",
        "max_node" : "10",
        "min_task" : "1",
        "min_node" : "2"
      }
    } ],
    "properties" : {
      "max_partition_per_broker" : "2000",
      "max_broker" : "30",
      "max_storage_per_node" : "30000",
      "max_consumer_per_broker" : "4000",
      "min_broker" : "3",
      "max_bandwidth_per_broker" : "100",
      "min_storage_per_node" : "1600",
      "max_tps_per_broker" : "250000",
      "product_alias" : "kafka.16u32g.cluster"
    }
  } ]
}