Querying Product Specifications

Function

This API is used to query the product specifications to configure the product ID.

URI

GET /v1.0/products?engine={engine}

Table 1 describes the parameter.

**Table 1** Parameters
Parameter	Type	Mandatory	Description
engine	String	Yes	Message engine.

Request

Request parameters

None.

Example request

None.

Response

Response parameters

Table 2 describes the response parameters.

**Table 2** Response parameters
Parameter	Type	Description
name	String	Message engine, which is kafka.
version	String	Version of the message engine. Currently, only 1.1.0 and 2.3.0 are supported.
values	Array	List of product specifications. For details, see Table 3.

**Table 3** values parameter description
Parameter	Type	Description
detail	Array	Specification details. For details, see Table 4.
name	String	Instance type.
unavailable_zones	Array	AZs where resources are sold out.
available_zones	Array	AZs where there are available resources.

**Table 4** detail parameter description
Parameter	Type	Description
tps	String	Maximum number of messages per unit time.
storage	String	Message storage space.
partition_num	String	Maximum number of topics in a Kafka instance.
product_id	String	Product ID.
spec_code	String	Specification ID.
io	Array	I/O information. For details, see Table 5.
bandwidth	String	Bandwidth of a Kafka instance.
available_zones	Array	AZs where there are available resources.
ecs_flavor_id	String	Flavors of the corresponding ECS.
arch_type	String	Instance architecture type. Currently, only x86 is supported.

**Table 5** io parameter description
Parameter	Type	Description
io_type	String	I/O type.
storage_spec_code	String	I/O specification.
available_zones	Array	List of AZs where there are available I/O resources.
unavailable_zones	Array of strings	List of AZs where I/O resources are sold out.
volume_type	String	Disk type.

Example response

{
	"Hourly": [{
		"name": "kafka",
		"version": "2.3.0",
		"values": [{
			"detail": [{
				"tps": "50000",
				"storage": "600",
				"partition_num": "300",
				"product_id": "00300-30308-0--0",
				"spec_code": "dms.instance.kafka.cluster.c3.mini",
				"io": [{
					"io_type": "high",
					"storage_spec_code": "dms.physical.storage.high",
					"available_zones": ["XXX",
					"XXX"],
					"volume_type": "SAS"
				},
				{
					"io_type": "ultra",
					"storage_spec_code": "dms.physical.storage.ultra",
					"available_zones": ["XXX",
					"XXX"],
					"volume_type": "SSD"
				}],
				"bandwidth": "100MB",
				"unavailable_zones": ["XXX"],
				"available_zones": ["XXX"],
				"ecs_flavor_id": "c4.large.2",
				"arch_type": "X86"
			},
			{
				"tps": "100000",
				"storage": "1200",
				"partition_num": "900",
				"product_id": "00300-30310-0--0",
				"spec_code": "dms.instance.kafka.cluster.c3.small.2",
				"io": [{
					"io_type": "high",
					"storage_spec_code": "dms.physical.storage.high",
					"available_zones": ["XXX",
					"XXX"],
					"volume_type": "SAS"
				},
				{
					"io_type": "ultra",
					"storage_spec_code": "dms.physical.storage.ultra",
					"available_zones": ["XXX",
					"XXX"],
					"volume_type": "SSD"
				}],
				"bandwidth": "300MB",
				"unavailable_zones": ["XXX"],
				"available_zones": ["XXX"],
				"ecs_flavor_id": "c4.xlarge.2",
				"arch_type": "X86"
			},
			{
				"tps": "200000",
				"storage": "2400",
				"partition_num": "1800",
				"product_id": "00300-30312-0--0",
				"spec_code": "dms.instance.kafka.cluster.c3.middle.2",
				"io": [{
					"io_type": "ultra",
					"storage_spec_code": "dms.physical.storage.ultra",
					"available_zones": ["XXX",
					"XXX"],
					"volume_type": "SSD"
				}],
				"bandwidth": "600MB",
				"unavailable_zones": ["XXX"],
				"available_zones": ["XXX"],
				"ecs_flavor_id": "c4.2xlarge.2",
				"arch_type": "X86"
			},
			{
				"tps": "300000",
				"storage": "4800",
				"partition_num": "1800",
				"product_id": "00300-30314-0--0",
				"spec_code": "dms.instance.kafka.cluster.c3.high.2",
				"io": [{
					"io_type": "ultra",
					"storage_spec_code": "dms.physical.storage.ultra",
					"available_zones": ["XXX",
					"XXX"],
					"volume_type": "SSD"
				}],
				"bandwidth": "1200MB",
				"unavailable_zones": ["XXX"],
				"available_zones": ["XXX"],
				"ecs_flavor_id": "c4.2xlarge.2",
				"arch_type": "X86"
			}],
			"name": "cluster",
			"unavailable_zones": ["XXX"],
			"available_zones": ["XXX"]
		}]
	}]
}