查询数据库规格

接口说明

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

调试

您可以在API Explorer中调试该接口。

URI

• URI格式

  GET https://{Endpoint}/v3.1/{project_id}/flavors?engine_name={engine_name}&engine_version={engine_version}&offset={offset}&limit={limit}

• URI样例

  https://dds.cn-north-1.myhuaweicloud.com/v3.1/0549b4a43100d4f32f51c01c2fe4acdb/flavors?engine_name=DDS-Community&engine_version=3.4&offset=1&limit=20

请求消息

响应消息

• 参数说明

  表2 参数说明

  名称	参数类型	是否必选	描述
  flavors	Array of objects	是	实例规格信息列表。详情请参见表3。
  total_count	Integer	是	总记录数。

  表3 flavors字段数据结构说明

  名称	参数类型	是否必选	描述
  engine_name	String	是	引擎名称。
  type	String	是	节点类型。文档数据库包含以下几种节点类型： mongos shard config replica single readonly
  vcpus	String	是	CPU核数。
  ram	String	是	内存大小，单位为GB。
  spec_code	String	是	资源规格编码。 示例：dds.mongodb.c6.xlarge.2.shard 说明： “dds”表示文档数据库服务产品。 “dds.mongodb”表示文档数据库服务产品。 “c6.xlarge.2”表示节点性能规格，为高内存类型。 “shard”表示节点类型。 查询规格时，注意区分是否为同系列的规格。规格系列包括：通用型（s6）、增强型（c3）、增强Ⅱ型（c6）。 示例： dds.mongodb.s6.large.4.mongos和dds.mongodb.s6.large.4.config是同一规格系列。 dds.mongodb.s6.large.4.mongos和dds.mongodb.c3.large.4.config不是同一规格系列。
  az_status	Map<String,String>	是	其中key是可用区编号，value是规格所在az的状态，包含以下状态： normal，在售。 unsupported，暂不支持该规格类型。 sellout，售罄。
  engine_versions	Array of strings	是	数据库版本号列表。 针对DDS引擎的mongos节点，例如：{"3.4", "4.0"}

响应示例中“az_status”字段下可用区的值为示例值。

• 响应示例

  {
      "total_count":5,
      "flavors": [
          {
              "engine_name": "DDS-Community",
              "type": "mongos",
              "vcpus": "1",
              "ram": "4",
              "spec_code": "dds.mongodb.c6.medium.4.mongos",
              "engine_versions":["3.4","4.0"],
              "az_status": {
                  "cn-north-1a": "unsupported",
                  "cn-north-1b": "normal",
                  "cn-north-1c": "normal",
                  "cn-north-1a,cn-north-1b,cn-north-1c": "unsupported"
              }
          },
  {
              "engine_name": "DDS-Community",
              "type": "shard",
              "vcpus": "4",
              "ram": "8",
              "spec_code": "dds.mongodb.c6.xlarge.2.shard",
              "engine_versions":["3.4","4.0"],
              "az_status": {
                  "cn-north-1a": "sellout",
                  "cn-north-1b": "normal",
                  "cn-north-1c": "normal",
                  "cn-north-1a,cn-north-1b,cn-north-1c": "unsupported"
              }
          },
    {
              "engine_name": "DDS-Community",
              "type": "config",
              "vcpus": "2",
              "ram": "4",
              "spec_code": "dds.mongodb.c6.large.2.config",
              "engine_versions":["3.4"],
              "az_status": {
                  "cn-north-1a": "normal",
                  "cn-north-1b": "normal",
                  "cn-north-1c": "normal",
                  "cn-north-1a,cn-north-1b,cn-north-1c": "normal"
              }
          },
  {
              "engine_name": "DDS-Community",
              "type": "replica",
              "vcpus": "1",
              "ram": "4",
              "spec_code": "dds.mongodb.c6.medium.4.repset",
              "engine_versions":["3.4","4.0"],
              "az_status": {
                  "cn-north-1a": "normal",
                  "cn-north-1b": "normal",
                  "cn-north-1c": "normal",
                  "cn-north-1a,cn-north-1b,cn-north-1c": "normal"
              }
          },
  {
              "engine_name": "DDS-Community",
              "type": "single",
              "vcpus": "16",
              "ram": "64",
              "spec_code": "dds.mongodb.c6.4xlarge.4.single",
              "engine_versions":["3.4","4.0"],
              "az_status": {
                  "cn-north-1a": "normal",
                  "cn-north-1b": "normal",
                  "cn-north-1c": "normal",
                  "cn-north-1a,cn-north-1b,cn-north-1c": "normal"
              }
          }
      ]
  }

SDK

单击文档数据库服务 DDS SDK，下载SDK或查看SDK文档。SDK的安装、认证方式等在SDK文档中对应语言类型的【使用】目录下。

状态码

详情请参见状态码。

错误码

详情请参见错误码。