
# 查询产品规格列表
![](https://support.huaweicloud.com/api-kafka/public_sys-resources/note_3.0-zh-cn.png)
当前页面API为历史版本API，未来可能停止维护。请使用[查询产品规格列表](https://support.huaweicloud.com/api-kafka/ListEngineProducts.html)。
#### 功能介绍
在创建kafka实例时，需要配置订购的产品ID（即product_id），可通过该接口查询产品规格。
例如，要订购按需计费、基准带宽为100MB的kafka实例，可从接口响应消息中，查找Hourly的消息体，然后找到bandwidth为100MB的记录对应的product_id，该product_id的值即是创建上述kafka实例时需要配置的产品ID。
同时，unavailable_zones字段表示资源不足的可用区列表，如果为空，则表示所有可用区都有资源，如果不为空，则表示字段值的可用区没有资源。所以必须确保您购买的资源所在的可用区有资源，不在该字段列表内。
#### URI
GET /v1.0/products?engine={engine}
参数说明见[表1]。
 表1参数说明 
| 参数     | 类型     | 必选 | 说明       |
|:---|:---|:---|:---|
| engine | String | 是  | 消息引擎的类型。 |
   
#### 请求消息
**请求参数**
无。
**请求示例**
```
GET https://{dms_endpoint}/v1.0/products?engine={engine}
```
#### 响应消息
**响应参数**
Hourly或者Monthly的参数说明见[表3]。
表2参数说明 
| 参数      | 类型    | 说明                                     |
|:---|:---|:---|
| Hourly  | Array | 表示按需付费的产品列表。                           |
| Monthly | Array | 表示包年包月的产品列表。当前暂不支持通过API创建包年包月的kafka实例。 |
   
 表3参数说明 
| 参数      | 类型     | 说明                                                                                    |
|:---|:---|:---|
| name    | String | 消息引擎的名称，该字段显示为kafka。                                                                  |
| version | String | 消息引擎的版本。                                                                              |
| values  | Array  | 产品规格列表。具体参数，请参见[表4]。 |
   
 表4values参数说明 
| 参数                | 类型     | 说明                                                                                 |
|:---|:---|:---|
| detail            | Array  | 规格详情。具体参数，请参见[表5]。 |
| name              | String | 实例类型。                                                                              |
| unavailable_zones | Array  | 资源售罄的可用区。                                                                          |
| available_zones   | Array  | 有可用资源的可用区。                                                                         |
   
 表5Kafka实例的detail参数说明 
| 参数              | 类型     | 说明                                                                                  |
|:---|:---|:---|
| tps             | String | 单位时间内的消息量最大值。                                                                       |
| storage         | String | 消息存储空间。                                                                             |
| partition_num   | String | Kafka实例的最大Topic数。                                                                   |
| product_id      | String | 产品ID。                                                                               |
| spec_code       | String | 规格ID。                                                                               |
| io              | Array  | IO信息。具体参数，请参见[表6]。 |
| bandwidth       | String | Kafka实例的基准带宽。                                                                       |
| available_zones | Array  | 实例资源未售罄的可用区。                                                                        |
| ecs_flavor_id   | String | 该产品规格对应的虚拟机规格。                                                                      |
| arch_type       | String | 实例规格架构类型。                                                                           |
   
 表6io参数说明 
| 参数                | 类型               | 说明            |
|:---|:---|:---|
| io_type           | String           | IO类型。         |
| storage_spec_code | String           | IO规格。         |
| available_zones   | Array            | IO未售罄的可用区。    |
| unavailable_zones | Array of strings | IO已售罄的不可用区列表。 |
| volume_type       | String           | 磁盘类型。         |
   
**响应示例**
```
{
"Hourly": [{
"name": "kafka",
"version": "XXX",
"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",
"volume_type": "SAS"
},
{
"io_type": "ultra",
"storage_spec_code": "dms.physical.storage.ultra",
"volume_type": "SSD"
}],
"bandwidth": "100MB",
"unavailable_zones": [],
"ecs_flavor_id": "c3.large.2"
},
{
"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",
"volume_type": "SAS"
},
{
"io_type": "ultra",
"storage_spec_code": "dms.physical.storage.ultra",
"volume_type": "SSD"
}],
"bandwidth": "300MB",
"unavailable_zones": [],
"ecs_flavor_id": "c3.xlarge.2"
},
{
"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",
"volume_type": "SSD"
}],
"bandwidth": "600MB",
"unavailable_zones": [],
"ecs_flavor_id": "c3.2xlarge.2"
},
{
"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",
"volume_type": "SSD"
}],
"bandwidth": "1200MB",
"unavailable_zones": [],
"ecs_flavor_id": "c3ne.2xlarge.2"
}],
"name": "cluster",
"unavailable_zones": []
}]
}],
"Monthly": [{
"name": "kafka",
"version": "XXX",
"values": [{
"detail": [{
"tps": "50000",
"storage": "600",
"partition_num": "300",
"product_id": "00300-30309-0--0",
"spec_code": "dms.instance.kafka.cluster.c3.mini",
"io": [{
"io_type": "high",
"storage_spec_code": "dms.physical.storage.high",
"volume_type": "SAS"
},
{
"io_type": "ultra",
"storage_spec_code": "dms.physical.storage.ultra",
"volume_type": "SSD"
}],
"bandwidth": "100MB",
"unavailable_zones": [],
"ecs_flavor_id": "c3.large.2"
},
{
"tps": "100000",
"storage": "1200",
"partition_num": "900",
"product_id": "00300-30311-0--0",
"spec_code": "dms.instance.kafka.cluster.c3.small.2",
"io": [{
"io_type": "high",
"storage_spec_code": "dms.physical.storage.high",
"volume_type": "SAS"
},
{
"io_type": "ultra",
"storage_spec_code": "dms.physical.storage.ultra",
"volume_type": "SSD"
}],
"bandwidth": "300MB",
"unavailable_zones": [],
"ecs_flavor_id": "c3.xlarge.2"
},
{
"tps": "200000",
"storage": "2400",
"partition_num": "1800",
"product_id": "00300-30313-0--0",
"spec_code": "dms.instance.kafka.cluster.c3.middle.2",
"io": [{
"io_type": "ultra",
"storage_spec_code": "dms.physical.storage.ultra",
"volume_type": "SSD"
}],
"bandwidth": "600MB",
"unavailable_zones": [],
"ecs_flavor_id": "c3.2xlarge.2"
},
{
"tps": "300000",
"storage": "4800",
"partition_num": "1800",
"product_id": "00300-30315-0--0",
"spec_code": "dms.instance.kafka.cluster.c3.high.2",
"io": [{
"io_type": "ultra",
"storage_spec_code": "dms.physical.storage.ultra",
"volume_type": "SSD"
}],
"bandwidth": "1200MB",
"unavailable_zones": [],
"ecs_flavor_id": "c3ne.2xlarge.2"
}],
"name": "cluster",
"unavailable_zones": []
}]
}]
}
```
#### 状态码
操作成功的状态码如[表7]所示，其他响应见[状态码](https://support.huaweicloud.com/api-kafka/kafka-api-0034672261.html)。
 表7状态码 
| 状态码 | 描述        |
|:---|:---|
| 200 | 查询规格列表成功。 |
   
