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

查询产品规格列表

功能介绍

查询产品规格列表。

URI

GET /v2/{engine}/products

表1 路径参数

参数

是否必选

参数类型

描述

engine

String

消息引擎的类型。

缺省值:kafka

表2 Query参数

参数

是否必选

参数类型

描述

product_id

String

产品ID。

请求参数

响应参数

状态码: 200

表3 响应Body参数

参数

参数类型

描述

engine

String

分布式消息服务的产品类型。

versions

Array of strings

支持的产品版本类型。

products

Array of ListEngineProductsEntity objects

产品规格的详细信息。

表4 ListEngineProductsEntity

参数

参数类型

描述

type

String

产品类型。当前产品类型有单机和集群。

product_id

String

产品ID。

ecs_flavor_id

String

底层资源类型。

billing_code

String

账单计费类型。

arch_types

Array of strings

CPU架构。

charging_mode

Array of strings

暂未使用。

ios

Array of ListEngineIosEntity objects

支持的磁盘IO类型列表。

support_features

Array of ListEngineSupportFeaturesEntity objects

当前规格实例支持的功能特性列表。

properties

ListEnginePropertiesEntity object

当前规格实例的属性。

表5 ListEngineIosEntity

参数

参数类型

描述

io_spec

String

磁盘IO编码。

type

String

磁盘类型。

available_zones

Array of strings

可用区。

unavailable_zones

Array of strings

不可用区。

表6 ListEngineSupportFeaturesEntity

参数

参数类型

描述

name

String

功能名称。

properties

ListEngineSupportFeaturesPropertiesEntity object

实例支持的功能属性描述。

表7 ListEngineSupportFeaturesPropertiesEntity

参数

参数类型

描述

max_task

String

转储功能的最大任务数。

min_task

String

转储功能的最小任务数。

max_node

String

转储功能的最大节点数。

min_node

String

转储功能的最小节点数。

表8 ListEnginePropertiesEntity

参数

参数类型

描述

max_partition_per_broker

String

每个Broker的最大分区数。

max_broker

String

Broker的最大个数。

max_storage_per_node

String

每个节点的最大存储。单位为GB。

max_consumer_per_broker

String

每个Broker的最大消费者数。

min_broker

String

Broker的最小个数。

max_bandwidth_per_broker

String

每个Broker的最大带宽。

min_storage_per_node

String

每个节点的最小存储。单位为GB。

max_tps_per_broker

String

每个Broker的最大TPS。

product_alias

String

product_id的别名。

请求示例

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

响应示例

状态码: 200

查询产品规格列表成功。

{
  "engine" : "kafka",
  "versions" : [ "1.1.0", "2.3.0" ],
  "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"
    }
  } ]
}

状态码

状态码

描述

200

查询产品规格列表成功。

错误码

请参见错误码