更新时间:2025-12-10 GMT+08:00

查询规格信息

功能介绍

该接口用于查询所有GaussDB(DWS)服务支持的规格信息。

调用方法

请参见如何调用API。

URI

GET /v2/{project_id}/node-types

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释:

项目ID。获取方法请参见获取项目ID。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

请求参数

无

响应参数

状态码:200

表2 响应Body参数

参数

参数类型

描述

node_types

Array of NodeTypes objects

参数解释:

可用的规格列表。

取值范围:

非空对象列表。

count

Integer

参数解释:

规格总数

取值范围:

大于等于0的正整数。

表3 NodeTypes

参数

参数类型

描述

spec_name

String

参数解释:

规格名称。

取值范围:

字母、数字、小数点、下划线、短横线。

detail

Array of Detail objects

参数解释:

规格详细信息。

取值范围:

不涉及。

id

String

参数解释:

规格ID。

取值范围:

一般为UUID。

datastore_type

String

参数解释:

产品类型。

取值范围:

  • dws:云数仓。

  • hybrid:实时数仓。

architecture

String

参数解释:

架构类型。

取值范围:

  • x86。

  • arm。

available_zones

Array of NodeTypeAvailableZones objects

参数解释:

支持的可用区及状态信息。

取值范围:

不涉及。

ram

Integer

参数解释:

内存大小。单位:GB。

取值范围:

大于0的正整数。

vcpus

Integer

参数解释:

CPU数量。

取值范围:

大于0的正整数。

datastores

Array of NodeTypeDatastores objects

参数解释:

内核版本信息。

取值范围:

不涉及。

volume

VolumeResp object

参数解释:

固定存储容量规格的存储容量信息。

取值范围:

如果规格为固定存储容量规格,则该属性为规格典配的存储容量信息,如果为弹性存储规格,则该属性为null。

elastic_volume_specs

Array of NodeTypeElasticVolumeSpecs objects

参数解释:

弹性容量规格的规格容量信息。

取值范围:

如果规格为弹性容量规格,则该属性为规格典配的弹性容量信息,包括存储类型、最小容量、最大容量以及步长信息,如果为固定存储规格,则该属性为null。

表4 Detail

参数

参数类型

描述

type

String

参数解释:

属性类型。

取值范围:

不涉及。

value

String

参数解释:

属性值。

取值范围:

不涉及。

unit

String

参数解释:

属性单位。

取值范围:

不涉及。

表5 NodeTypeAvailableZones

参数

参数类型

描述

code

String

参数解释:

可用区ID。

取值范围:

不涉及。

status

String

参数解释:

规格可用状态。

取值范围:

  • normal:可用

  • sellout:售罄

  • abandon:不可用

表6 NodeTypeDatastores

参数

参数类型

描述

version

String

参数解释:

内核版本号。

取值范围:

数字、小数点,格式一般如 9.1.0、9.1.1.100。

attachments

attachments object

参数解释:

内核版本附加信息。

取值范围:

不涉及。

role

String

参数解释:

版本类型。

取值范围:

  • STABLE:稳定版

  • PREVIEW:预览版

表7 attachments

参数

参数类型

描述

min_cn

Integer

参数解释:

内核版本支持的最小CN。

取值范围:

大于0的正整数。

max_cn

Integer

参数解释:

内核版本支持的最大CN。

取值范围:

大于0的正整数。

表8 VolumeResp

参数

参数类型

描述

type

String

参数解释:

磁盘类型,仅支持SSD。

取值范围:

仅支持SSD。

size

Integer

参数解释:

磁盘可用容量。

取值范围:

仅支持SSD。

表9 NodeTypeElasticVolumeSpecs

参数

参数类型

描述

type

String

参数解释:

云盘存储类型。

取值范围:

不涉及。

step

Integer

参数解释:

云盘容量调整步长。

取值范围:

不涉及。

min_size

Integer

参数解释:

云盘支持的最小容量。

取值范围:

不涉及。

max_size

Integer

参数解释:

云盘支持的最大容量。

取值范围:

不涉及。

请求示例

查询规格信息。

GET https://{Endpoint}/v2/89cd04f168b84af6be287f71730fdb4b/node-types

响应示例

状态码:200

查询规格信息成功。

{
  "node_types" : [ {
    "spec_name" : "dws.d2.xlarge",
    "id" : "ebe532d6-665f-40e6-a4d4-3c51545b6a67",
    "datastore_type" : "dws",
    "architecture" : "x86",
    "available_zones" : [ {
      "code" : "az1",
      "status" : "normal"
    } ],
    "ram" : 32,
    "vcpus" : 4,
    "datastores" : [ {
      "version" : "8.1.3.200",
      "attachments" : {
        "min_cn" : 2,
        "max_cn" : 20
      },
      "role" : "STABLE"
    } ],
    "volume" : {
      "type" : "SSD",
      "size" : 160
    },
    "elastic_volume_specs" : [ {
      "type" : "SSD",
      "step" : 100,
      "min_size" : 100,
      "max_size" : 32000
    } ],
    "detail" : [ {
      "type" : "vCPU",
      "value" : "4"
    }, {
      "value" : "1675",
      "type" : "LOCAL_DISK",
      "unit" : "GB"
    }, {
      "type" : "mem",
      "value" : "32",
      "unit" : "GB"
    } ]
  } ],
  "count" : 1
}

状态码

状态码

描述

200

查询规格信息成功。

400

请求错误。

401

鉴权失败。

403

没有操作权限。

404

找不到资源。

500

服务内部错误。

503

服务不可用。