文档首页> 云数据库 GeminiDB> API参考> API v3（推荐）> 接口版本和规格> 查询数据库规格
更新时间：2023-11-21 GMT+08:00
查看PDF
分享

查询数据库规格

功能介绍

查询指定条件下的所有实例规格信息。

接口约束

该接口支持如下数据库实例：

  • GeminiDB Cassandra
  • GeminiDB Mongo
  • GeminiDB Influx
  • GeminiDB Redis

调试

您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。

URI

GET https://{Endpoint}/v3.1/{project_id}/flavors

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

租户在某一region下的project ID。获取方法请参见获取项目ID。
表2 Query参数

参数

是否必选

参数类型

描述

engine_name

否

String

数据库类型。

  • 取值为“cassandra”，表示查询GeminiDB Cassandra数据库实例支持的规格。
  • 取值为“mongodb”，表示查询GeminiDB Mongo数据库实例支持的规格。
  • 取值为“influxdb”，表示查询GeminiDB Influx数据库实例支持的规格。
  • 取值为“redis”，表示查询GeminiDB Redis数据库实例支持的规格。
  • 如果不传该参数，默认为“cassandra”。

offset

否

Integer

索引位置，偏移量。

  • 从第一条数据偏移offset条数据后开始查询，默认为0（偏移0条数据，表示从第一条数据开始查询）。
  • 取值必须为数字，且不能为负数。

limit

否

Integer

查询规格信息上限值。

  • 取值范围：1~100。
  • 不传该参数时，默认查询前100条规格信息。

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

用户Token。

响应参数

状态码： 200

表4 响应Body参数

参数

参数类型

描述

total_count

Integer

总记录数。

flavors

Array of Flavors objects

实例规格信息列表。
表5 Flavors

参数

参数类型

描述

engine_name

String

接口名称。

engine_version

String

接口版本。

vcpus

String

CPU核数。

ram

String

内存大小，单位为兆字节。

spec_code

String

资源规格编码。

例如：geminidb.cassandra.8xlarge.4

说明：
  • “geminidb.cassandra”表示Cassandra数据库产品。
  • “8xlarge.4”表示节点性能规格。

availability_zone

Array of strings

支持该规格的可用区ID。

说明：

该字段已废弃，请不要使用。

az_status

Object

规格在可用区内的状态，包含以下状态：

  • normal，在售。
  • unsupported，暂不支持该规格。
  • sellout，售罄。

请求示例

URI样例 
GET https://gaussdb-nosql.cn-north-4.myhuaweicloud.com/v3.1/375d8d8fad1f43039e23d3b6c0f60a19/flavors?engine_name=cassandra&offset=0&limit=10

响应示例

状态码： 200

Success

{
  "total_count" : 4,
  "flavors" : [ {
    "engine_name" : "cassandra",
    "engine_version" : "3.11",
    "vcpus" : "4",
    "ram" : "16",
    "spec_code" : "geminidb.cassandra.xlarge.4",
    "availability_zone" : [ "az1", "az2" ],
    "az_status" : {
      "az1" : "normal",
      "az2" : "unsupported"
    }
  }, {
    "engine_name" : "cassandra",
    "engine_version" : "3.11",
    "vcpus" : "8",
    "ram" : "32",
    "spec_code" : "geminidb.cassandra.2xlarge.4",
    "availability_zone" : [ "az1", "az2" ],
    "az_status" : {
      "az1" : "unsupported",
      "az2" : "normal"
    }
  }, {
    "engine_name" : "cassandra",
    "engine_version" : "3.11",
    "vcpus" : "16",
    "ram" : "64",
    "spec_code" : "geminidb.cassandra.4xlarge.4",
    "availability_zone" : [ "az1", "az2" ],
    "az_status" : {
      "az1" : "normal",
      "az2" : "sellout"
    }
  }, {
    "engine_name" : "cassandra",
    "engine_version" : "3.11",
    "vcpus" : "32",
    "ram" : "128",
    "spec_code" : "geminidb.cassandra.8xlarge.4",
    "availability_zone" : [ "az1", "az2" ],
    "az_status" : {
      "az1" : "normal",
      "az2" : "normal"
    }
  } ]
}

状态码

请参见状态码。

错误码

请参见错误码。

父主题： 接口版本和规格
分享：

    相关文档

    相关产品