文档首页> 分布式缓存服务 DCS> API参考（巴黎区域）> API V2（推荐）> 其他接口> 查询产品规格
更新时间：2023-12-13 GMT+08:00
查看PDF

查询产品规格

功能介绍

在创建缓存实例时，需要配置订购的产品规格编码（spec_code），可通过该接口查询产品规格，查询条件不选时默认查询全部。

URI

GET /v2/{project_id}/flavors

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目ID。获取方法请参见获取项目ID。
表2 Query参数

参数

是否必选

参数类型

描述

spec_code

否

String

产品规格编码。

cache_mode

否

String

缓存实例类型。取值范围如下：

  • single：表示单机实例

  • ha：表示主备实例

  • cluster：表示cluster集群实例

  • proxy：表示Proxy集群实例

engine

否

String

缓存引擎类型。取值范围如下：

  • Redis

  • Memcached

engine_version

否

String

缓存版本，当缓存引擎为Redis时，取值范围如下：

  • 3.0

  • 4.0

  • 5.0

  • 6.0

cpu_type

否

String

CPU架构类型。取值范围如下：

  • x86_64：X86架构

  • aarch64：ARM架构

枚举值：

  • x86_64

  • aarch64

capacity

否

String

缓存容量（G Byte）。

  • Redis3.0：单机和主备类型实例取值：2、4、8、16、32、64。Proxy集群实例规格支持64、128、256、512和1024。

  • Redis 4.0、Redis 5.0、Redis 6.0：单机和主备类型实例取值：0.125、0.25、0.5、1、2、4、8、16、32、64。集群实例规格支持4、8、16、24、32、48、64、96、128、192、256、384、512、768、1024。

  • Memcached：单机和主备类型实例取值：2、4、8、16、32、64。

请求参数

无

响应参数

状态码： 200

表3 响应Body参数

参数

参数类型

描述

flavors

Array of FlavorsItems objects

产品规格详情。
表4 FlavorsItems

参数

参数类型

描述

spec_code

String

产品规格编码。

cloud_service_type_code

String

云服务类型编码。

cloud_resource_type_code

String

云资源类型编码。

cache_mode

String

缓存实例类型。取值范围如下：

  • single：表示单机实例

  • ha：表示主备实例

  • cluster：表示cluster集群实例

  • proxy：表示Proxy集群实例

engine

String

缓存引擎类型。

engine_version

String

缓存版本，当缓存引擎为Redis时，取值为。

product_type

String

Redis缓存实例的产品类型。取值当前仅支持： generic：标准类型

cpu_type

String

CPU架构类型。取值范围如下：

  • x86_64：X86架构

  • aarch64: ARM架构

storage_type

String

存储类型，取值当前仅支持： DRAM:内存存储

capacity

Array of strings

缓存容量（G Byte）。

billing_mode

Array of strings

计费模式，取值范围如下：

  • Hourly：按需计费

tenant_ip_count

Integer

租户侧IP数量。

pricing_type

String

定价类型，取值如下：

  • tier: 阶梯定价，一个规格对应多个容量

  • normal: 规格和容量一一对应

is_dec

Boolean

是否支持专属云。

attrs

Array of AttrsObject objects

规格的其他信息。

flavors_available_zones

Array of FlavorAzObject objects

有资源的可用区。

replica_count

Integer

副本数
表5 AttrsObject

参数

参数类型

描述

capacity

String

缓存容量（G Byte）。

name

String

额外信息名，取值范围如下：

  • sharding_num：该规格实例支持的分片数。

  • proxy_num：该规格Proxy实例支持的Proxy节点数量。如果不是Proxy实例，该参数为0。

  • db_number：该规格实例的DB数量。

  • max_memory：实际可使用的最大内存。

  • max_connections：该规格支持的最大连接数。

  • max_clients：该规格支持的最大客户端数，一般等于最大连接数。

  • max_bandwidth：该规格支持的最大带宽。

  • max_in_bandwidth：该规格支持的最大接入带宽，一般等于最大带宽。

value

String

额外信息值。
表6 FlavorAzObject

参数

参数类型

描述

capacity

String

缓存容量数值。

unit

String

缓存容量单位。

available_zones

Array of strings

可用区信息。

az_codes

Array of strings

有资源的可用区编码。

状态码： 400

表7 响应Body参数

参数

参数类型

描述

error_msg

String

错误信息

最大长度：1024

error_code

String

错误码

最大长度：9

error_ext_msg

String

扩展错误信息(暂未使用，赋值为null)

最大长度：1024

状态码： 401

表8 响应Body参数

参数

参数类型

描述

error_msg

String

错误信息

最大长度：1024

error_code

String

错误码

最大长度：9

error_ext_msg

String

扩展错误信息(暂未使用，赋值为null)

最大长度：1024

状态码： 403

表9 响应Body参数

参数

参数类型

描述

error_msg

String

错误信息

最大长度：1024

error_code

String

错误码

最大长度：9

error_ext_msg

String

扩展错误信息(暂未使用，赋值为null)

最大长度：1024

状态码： 404

表10 响应Body参数

参数

参数类型

描述

error_msg

String

错误信息

最大长度：1024

error_code

String

错误码

最大长度：9

error_ext_msg

String

扩展错误信息(暂未使用，赋值为null)

最大长度：1024

状态码： 500

表11 响应Body参数

参数

参数类型

描述

error_msg

String

错误信息

最大长度：1024

error_code

String

错误码

最大长度：9

error_ext_msg

String

扩展错误信息(暂未使用，赋值为null)

最大长度：1024

请求示例

GET https://{dcs_endpoint}/v2/flavors?cache_mode={cache_mode}&engine={engine}&engine_version={engine_version}&cpu_type={cpu_type}&capacity={capacity}

响应示例

状态码： 200

查询产品规格成功。

{
  "flavors" : [ {
    "spec_code" : "redis.single.au1.large.1",
    "cloud_service_type_code" : "hws.resource.type.dcs3",
    "cloud_resource_type_code" : "hws.resource.type.dcs3",
    "cache_mode" : "single",
    "engine" : "redis",
    "engine_version" : "4.0;5.0",
    "product_type" : "generic",
    "cpu_type" : "aarch64",
    "storage_type" : "DRAM",
    "capacity" : [ "1" ],
    "billing_mode" : [ "Hourly" ],
    "tenant_ip_count" : 1,
    "pricing_type" : "normal",
    "is_dec" : false,
    "attrs" : [ {
      "capacity" : "1",
      "name" : "max_memory",
      "value" : "1"
    }, {
      "capacity" : "1",
      "name" : "max_connections",
      "value" : "10000"
    }, {
      "capacity" : "1",
      "name" : "sharding_num",
      "value" : "1"
    }, {
      "capacity" : "1",
      "name" : "proxy_num",
      "value" : "0"
    }, {
      "capacity" : "1",
      "name" : "db_number",
      "value" : "256"
    }, {
      "capacity" : "1",
      "name" : "max_clients",
      "value" : "10000"
    }, {
      "capacity" : "1",
      "name" : "max_bandwidth",
      "value" : "80"
    } ],
    "flavors_available_zones" : [ {
      "capacity" : "1",
      "unit" : "GB",
      "available_zones" : [ "d539378ec1324c85b76fefa3f7071458" ],
      "az_codes" : [ "region01" ]
    } ],
    "replica_count" : 1
  } ]
}

状态码： 400

非法请求。

{
  "error_code" : "DCS.1004",
  "error_msg" : "Project ID does not match the token."
}

状态码： 401

认证信息非法。

{
  "error_code" : "DCS.1001",
  "error_msg" : "Invalid token."
}

状态码： 403

请求被拒绝访问。

{
  "error_code" : "DCS.2003",
  "error_msg" : "This role does not have the permission to perform this operation."
}

状态码： 404

所请求的资源不存在。

{
  "error_code" : "DCS.4001",
  "error_msg" : "The requested URL does not exist."
}

状态码： 500

内部服务错误

{
  "error_code" : "DCS.5000",
  "error_msg" : "Internal service error."
}

状态码

状态码

描述

200

查询产品规格成功。

400

非法请求。

401

认证信息非法。

403

请求被拒绝访问。

404

所请求的资源不存在。

500

内部服务错误

错误码

请参见错误码。

父主题： 其他接口