文档首页/文档数据库服务 DDS/API参考（联盟区域）/API v3（推荐）/查询所有实例规格信息
更新时间：2026-01-07 GMT+08:00
查看PDF
分享

查询所有实例规格信息

接口说明

查询指定区域下的所有实例规格信息。

URI

  • URI格式

    GET https://{Endpoint}/v3/{project_id}/flavors?region={region}&engine_name={engine_name}

请求参数

表1 请求参数

名称

类型

IN

是否必选

描述

X-Auth-Token

string

header

是

用户Token。

project_id

string

path

是

租户在某一region下的project ID。请参考获取项目ID章节获取项目编号。

region

string

query

否

实例所在区域。

实例所在区域。

取值：

非空，请参见地区和终端节点。

engine_name

string

query

否

数据库版本类型。取值为“DDS-Community”。

响应参数

表2 参数说明

名称

参数类型

描述

flavors

Array of objects

实例规格信息列表。详情请参见表3。

表3 flavors字段数据结构说明

名称

参数类型

描述

engine_name

String

引擎名称。

type

String

节点类型。文档数据库包含以下几种节点类型：

  • mongos
  • shard
  • config
  • replica
  • single

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

Object

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

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

响应示例中“az_status”字段下可用区“az1”、“az2”、“az3”均为示例值。

  • 响应示例 
    {
    "flavors": [
        {
            "engine_name": "DDS-Community",
            "type": "mongos",
            "vcpus": "1",
            "ram": "4",
            "spec_code": "dds.mongodb.c6.medium.4.mongos",
            "az_status": {
                "az1": "normal",
                "az2": "normal",
                "az3": "normal"
            }
        },
{
            "engine_name": "DDS-Community",
            "type": "shard",
            "vcpus": "4",
            "ram": "8",
            "spec_code": "dds.mongodb.c6.xlarge.2.shard",
            "az_status": {
                "az1": "normal",
                "az2": "normal",
                "az3": "normal"
            }
        },
{
            "engine_name": "DDS-Community",
            "type": "config",
            "vcpus": "2",
            "ram": "4",
            "spec_code": "dds.mongodb.c6.large.2.config",
            "az_status": {
                "az1": "normal",
                "az2": "normal",
                "az3": "normal"
            }
        },
{
            "engine_name": "DDS-Community",
            "type": "replica",
            "vcpus": "1",
            "ram": "4",
            "spec_code": "dds.mongodb.c6.medium.4.repset",
            "az_status": {
                "az1": "normal",
                "az2": "normal",
                "az3": "normal"
            }
        }
    ]
}

状态码

详情请参见状态码。

错误码

详情请参见错误码。

父主题：API v3（推荐）