更新时间:2023-08-16 GMT+08:00

查询产品规格列表

当前页面API为历史版本API,未来可能停止维护。

功能介绍

在创建kafka实例时,需要配置订购的产品ID(即product_id),可通过该接口查询产品规格。

URI

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

参数说明见表1

表1 参数说明

参数

类型

必选

说明

engine

String

消息引擎的类型。

请求消息

请求参数

无。

请求示例

GET https://{dms_endpoint}/v1.0/products?engine={engine}

响应消息

响应参数

Hourly的参数说明见表2

表2 参数说明

参数

类型

说明

name

String

消息引擎的名称,该字段显示为kafka。

version

String

消息引擎的版本,当前支持1.1.0、2.3.0和2.7。

values

Array

产品规格列表。具体参数,请参见表3

表3 values参数说明

参数

类型

说明

detail

Array

规格详情。具体参数,请参见表4

name

String

实例类型。

unavailable_zones

Array

资源售罄的可用区。

available_zones

Array

有可用资源的可用区。

表4 Kafka实例的detail参数说明

参数

类型

说明

tps

String

单位时间内的消息量最大值。

storage

String

消息存储空间。

partition_num

String

Kafka实例的最大Topic数。

product_id

String

产品ID。

spec_code

String

规格ID。

io

Array

IO信息。具体参数,请参见表5

bandwidth

String

Kafka实例的基准带宽。

available_zones

Array

实例资源未售罄的可用区。

ecs_flavor_id

String

该产品规格对应的虚拟机规格。

arch_type

String

实例规格架构类型。当前仅支持X86。

表5 io参数说明

参数

类型

说明

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": "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"]
		}]
	}]
}

状态码

操作成功的状态码如表6所示,其他响应见状态码

表6 状态码

状态码

描述

200

查询规格列表成功。