Listing Product Specifications¶
Function¶
This API is used to query the product specifications to configure the product ID (product_id).For example, to create a pay-per-use Kafka instance with 100 MB/s bandwidth, locate the section where the value of bandwidth is 100MB under "Hourly" in the response message. Then, the value of product_id in the same section is the product ID that should be configured for the Kafka instance.unavailable_zones indicates AZs where there are no available resources. If the value is empty, all AZs are available. Otherwise, the AZs listed in the value do not have sufficient resources. Ensure that the AZs where you want to create the instance are not listed here.
URI¶
GET /v2/products
Parameter | Mandatory | Type | Description |
|---|---|---|---|
engine | Yes | String | Message engine. Currently, only Kafka is supported. |
Request Parameters¶
None
Response Parameters¶
Status code: 200
Parameter | Type | Description |
|---|---|---|
Hourly | Array of Hourly objects | List of pay-per-use products. |
Monthly | Array of Monthly objects | List of products in yearly/monthly billing mode. Currently, you cannot create yearly/monthly Kafka instances by calling APIs. |
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 is supported. |
values | Array of values objects | Product specifications. |
Parameter | Type | Description |
|---|---|---|
detail | Array of detail objects | Specification details. |
name | String | Instance type. |
unavailable_zones | Array of strings | AZs where resources are sold out. |
available_zones | Array of strings | List of AZs where there are available resources. |
Parameter | Type | Description |
|---|---|---|
tps | String | Maximum number of messages per unit time. |
storage_space | String | Message storage space. |
partition_num | String | Number of partitions in a Kafka instance. |
product_id | String | Product ID. |
spec_code | String | Specification ID. |
io | Array of io objects | I/O information. |
bandwidth | String | Bandwidth of a Kafka instance. |
unavailable_zones | Array of strings | AZs where resources are sold out. |
available_zones | Array of strings | List of AZs where there are available resources. |
ecs_flavor_id | String | Flavor of the corresponding ECS. |
arch_type | String | Instance architecture type. Currently, only x86 is supported. |
Parameter | Type | Description |
|---|---|---|
io_type | String | I/O type. |
storage_spec_code | String | I/O specifications. |
available_zones | Array of strings | 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. |
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 is supported. |
values | Array of values objects | Product specifications. |
Parameter | Type | Description |
|---|---|---|
detail | Array of detail objects | Specification details. |
name | String | Instance type. |
unavailable_zones | Array of strings | AZs where resources are sold out. |
available_zones | Array of strings | List of AZs where there are available resources. |
Parameter | Type | Description |
|---|---|---|
tps | String | Maximum number of messages per unit time. |
storage_space | String | Message storage space. |
partition_num | String | Number of partitions in a Kafka instance. |
product_id | String | Product ID. |
spec_code | String | Specification ID. |
io | Array of io objects | I/O information. |
bandwidth | String | Bandwidth of a Kafka instance. |
unavailable_zones | Array of strings | AZs where resources are sold out. |
available_zones | Array of strings | List of AZs where there are available resources. |
ecs_flavor_id | String | Flavor of the corresponding ECS. |
arch_type | String | Instance architecture type. Currently, only x86 is supported. |
Parameter | Type | Description |
|---|---|---|
io_type | String | I/O type. |
storage_spec_code | String | I/O specifications. |
available_zones | Array of strings | 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 Requests¶
GET https://{endpoint}/v2/products?engine=kafka
Example Responses¶
Status code: 200
The product specifications are listed successfully.
{
"Hourly" : [ {
"name" : "kafka",
"version" : "1.1.0",
"values" : [ {
"detail" : [ {
"tps" : "50000",
"storage_space" : "200",
"partition_num" : "300",
"product_id" : "00300-30308-0--0",
"spec_code" : "dms.instance.kafka.cluster.c3.mini",
"io" : [ {
"io_type" : "normal",
"storage_spec_code" : "dms.physical.storage.normal",
"available_zones" : [ "xxx", "xxx" ],
"volume_type" : "SATA"
}, {
"io_type" : "high",
"storage_spec_code" : "dms.physical.storage.high",
"unavailable_zones" : [ "xxx", "xxx" ],
"available_zones" : [ ],
"volume_type" : "SAS"
}, {
"io_type" : "ultra",
"storage_spec_code" : "dms.physical.storage.ultra",
"unavailable_zones" : [ "xxx", "xxx" ],
"available_zones" : [ ],
"volume_type" : "SSD"
} ],
"bandwidth" : "100MB",
"unavailable_zones" : [ "xxx", "xxx" ],
"available_zones" : [ "xxx" ],
"ecs_flavor_id" : "s6.large.2",
"arch_type" : "X86"
}, {
"tps" : "100000",
"storage_space" : "1200",
"partition_num" : "900",
"product_id" : "00300-30310-0--0",
"spec_code" : "dms.instance.kafka.cluster.c3.small.2",
"io" : [ {
"io_type" : "normal",
"storage_spec_code" : "dms.physical.storage.normal",
"available_zones" : [ "xxx", "xxx" ],
"volume_type" : "SATA"
}, {
"io_type" : "high",
"storage_spec_code" : "dms.physical.storage.high",
"unavailable_zones" : [ "xxx", "xxx" ],
"available_zones" : [ ],
"volume_type" : "SAS"
}, {
"io_type" : "ultra",
"storage_spec_code" : "dms.physical.storage.ultra",
"unavailable_zones" : [ "xxx", "xxx" ],
"available_zones" : [ ],
"volume_type" : "SSD"
} ],
"bandwidth" : "300MB",
"unavailable_zones" : [ "xxx", "xxx" ],
"available_zones" : [ "xxx" ],
"ecs_flavor_id" : "c3.medium.2",
"arch_type" : "X86"
} ],
"name" : "cluster",
"unavailable_zones" : [ "xxx", "xxx" ],
"available_zones" : [ "xxx" ]
} ]
} ],
"Monthly" : [ {
"name" : "kafka",
"version" : "1.1.0",
"values" : [ {
"detail" : [ {
"tps" : "50000",
"storage_space" : "200",
"partition_num" : "300",
"product_id" : "00300-30309-0--0",
"spec_code" : "dms.instance.kafka.cluster.c3.mini",
"io" : [ {
"io_type" : "normal",
"storage_spec_code" : "dms.physical.storage.normal",
"available_zones" : [ "xxx", "xxx" ],
"volume_type" : "SATA"
}, {
"io_type" : "high",
"storage_spec_code" : "dms.physical.storage.high",
"unavailable_zones" : [ "xxx", "xxx" ],
"available_zones" : [ ],
"volume_type" : "SAS"
}, {
"io_type" : "ultra",
"storage_spec_code" : "dms.physical.storage.ultra",
"unavailable_zones" : [ "xxx", "xxx" ],
"available_zones" : [ ],
"volume_type" : "SSD"
} ],
"bandwidth" : "100MB",
"unavailable_zones" : [ "xxx", "xxx" ],
"available_zones" : [ "xxx" ],
"ecs_flavor_id" : "s6.large.2",
"arch_type" : "X86"
}, {
"tps" : "100000",
"storage_space" : "1200",
"partition_num" : "900",
"product_id" : "00300-30311-0--0",
"spec_code" : "dms.instance.kafka.cluster.c3.small.2",
"io" : [ {
"io_type" : "normal",
"storage_spec_code" : "dms.physical.storage.normal",
"available_zones" : [ "xxx", "xxx" ],
"volume_type" : "SATA"
}, {
"io_type" : "high",
"storage_spec_code" : "dms.physical.storage.high",
"unavailable_zones" : [ "xxx", "xxx" ],
"available_zones" : [ ],
"volume_type" : "SAS"
}, {
"io_type" : "ultra",
"storage_spec_code" : "dms.physical.storage.ultra",
"unavailable_zones" : [ "xxx", "xxx" ],
"available_zones" : [ ],
"volume_type" : "SSD"
} ],
"bandwidth" : "300MB",
"unavailable_zones" : [ "xxx", "xxx" ],
"available_zones" : [ "xxx" ],
"ecs_flavor_id" : "c3.medium.2",
"arch_type" : "X86"
} ],
"name" : "cluster",
"unavailable_zones" : [ "xxx", "xxx" ],
"available_zones" : [ "xxx" ]
} ]
} ]
}
Status Codes¶
Status Code | Description |
|---|---|
200 | The product specifications are listed successfully. |
Error Codes¶
See Error Codes.