文档首页/ 云数据库 TaurusDB/ API参考/ API（推荐）/ HTAP-标准版/ HTAP查询规格信息- ListHtapFlavor
更新时间：2025-10-21 GMT+08:00
在线调试
CLI示例
查看PDF
分享

HTAP查询规格信息 - ListHtapFlavor

功能介绍

HTAP查询规格信息。

调用方法

请参见如何调用API。

授权信息

账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。

  • 如果使用角色与策略授权，具体权限要求请参见权限和授权项。
  • 如果使用身份策略授权，需具备如下身份策略权限。

    授权项

    访问级别

    资源类型（*为必须）

    条件键

    别名

    依赖的授权项

    gaussdbformysql:instance:listSpec

    List

    -

    -

    gaussdb:instance:list

    -

URI

GET /v3/{project_id}/htap/flavors/{engine_name}

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释：

租户在某一Region下的project ID。

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

约束限制：

不涉及。

取值范围：

只能由英文字母、数字组成，且长度为32个字符。

默认取值：

不涉及。

engine_name

是

String

参数解释：

HTAP引擎类型。

约束限制：

不涉及。

取值范围：

  • star-rocks

  • click-house

默认取值：

star-rocks。
表2 Query参数

参数

是否必选

参数类型

描述

availability_zone_mode

否

String

参数解释：

可用区模式。

约束限制：

不涉及。

取值范围：

仅支持single。

默认取值：

single。

spec_code

否

String

参数解释：

规格码，提供后仅查询指定规格码规格信息。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

version_name

否

String

参数解释：

HTAP数据库版本号。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

3.1.6.0。

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

参数解释：

用户Token。 通过调用IAM服务获取用户Token接口获取。

请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

Content-Type

是

String

参数解释：

内容类型。

约束限制：

不涉及。

取值范围：

application/json。

默认取值：

application/json。

X-Language

否

String

参数解释：

请求语言类型。

约束限制：

不涉及。

取值范围：

  • en-us

  • zh-cn

默认取值：

en-us。

响应参数

状态码： 200

表4 响应Body参数

参数

参数类型

描述

flavors

Array of flavors objects

参数解释：

规格信息。

取值范围：

不涉及。
表5 flavors

参数

参数类型

描述

type

String

参数解释：

规格类型。

取值范围：

  • arm：独享型arm规格。
  • x86：独享型x86规格。
  • generalX86：通用型X86规格。

vcpus

String

参数解释：

CPU大小。例如：1表示1U。

取值范围：

不涉及。

ram

String

参数解释：

内存大小，单位为GB。

取值范围：

不涉及。

id

String

参数解释：

规格ID，该字段唯一。

取值范围：

不涉及。

spec_code

String

参数解释：

资源规格编码，同创建指定的flavor_ref。例如：gaussdb.sr-be.xlarge.x86.4。

“gaussdb.sr”代表产品。

“xlarge” 代表计算规格为4U。

“x86” 代表CPU架构为x86。

“4” 表示vCPU和内存为1:4。

取值范围：

不涉及。

version_name

String

参数解释：

数据库版本号。

取值范围：

不涉及。

instance_mode

String

参数解释：

实例类型。目前仅支持Cluster、Single。

取值范围：

不涉及。

az_status

Map<String,String>

参数解释：

规格所在AZ的状态。

取值范围：

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

状态码： 400

表6 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误消息。

状态码： 500

表7 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误消息。

请求示例

查询StarRocks规格信息

GET https://{endpoint}/v3/23a50154cf494ec9ad6883979a12db0a/htap/flavors/star-rocks?availability_zone_mode=single

响应示例

状态码： 200

Success.

{
  "flavors" : [ {
    "type" : "x86",
    "vcpus" : "4",
    "ram" : "16",
    "id" : "de565db8-0a96-37ea-9388-61167624712c",
    "spec_code" : "gaussdb.sr-be.xlarge.x86.4",
    "version_name" : "8.0",
    "instance_mode" : "Cluster",
    "az_status" : {
      "az1" : "normal",
      "az2" : "normal",
      "az3" : "normal",
      "az4" : "unsupported"
    }
  }, {
    "type" : "x86",
    "vcpus" : "4",
    "ram" : "16",
    "id" : "afef3bfd-ac7c-32e1-ba44-c388acbb196a",
    "spec_code" : "gaussdb.sr-fe.xlarge.x86.4",
    "version_name" : "8.0",
    "instance_mode" : "Cluster",
    "az_status" : {
      "az1" : "normal",
      "az2" : "normal",
      "az3" : "normal",
      "az4" : "unsupported"
    }
  }, {
    "type" : "x86",
    "vcpus" : "8",
    "ram" : "32",
    "id" : "c50e8e15-f2fc-3b40-aca6-c98f07ce2ce0",
    "spec_code" : "gaussdb.sr-be.2xlarge.x86.4",
    "version_name" : "8.0",
    "instance_mode" : "Cluster",
    "az_status" : {
      "az1" : "normal",
      "az2" : "normal",
      "az3" : "normal",
      "az4" : "unsupported"
    }
  }, {
    "type" : "x86",
    "vcpus" : "8",
    "ram" : "32",
    "id" : "24059750-4280-3ee5-a44b-488b924633b4",
    "spec_code" : "gaussdb.sr-fe.2xlarge.x86.4",
    "version_name" : "8.0",
    "instance_mode" : "Cluster",
    "az_status" : {
      "az1" : "normal",
      "az2" : "normal",
      "az3" : "normal",
      "az4" : "unsupported"
    }
  }, {
    "type" : "x86",
    "vcpus" : "16",
    "ram" : "64",
    "id" : "a48c63dc-5563-3813-9e13-39d3301e56f4",
    "spec_code" : "gaussdb.sr-be.4xlarge.x86.4",
    "version_name" : "8.0",
    "instance_mode" : "Cluster",
    "az_status" : {
      "az1" : "normal",
      "az2" : "normal",
      "az3" : "normal",
      "az4" : "unsupported"
    }
  }, {
    "type" : "x86",
    "vcpus" : "16",
    "ram" : "64",
    "id" : "0ef44c01-f7a1-30f5-9f05-9e47094e8c1f",
    "spec_code" : "gaussdb.sr-fe.4xlarge.x86.4",
    "version_name" : "8.0",
    "instance_mode" : "Cluster",
    "az_status" : {
      "az1" : "normal",
      "az2" : "normal",
      "az3" : "normal",
      "az4" : "unsupported"
    }
  }, {
    "type" : "x86",
    "vcpus" : "32",
    "ram" : "128",
    "id" : "2bf6aa50-50da-3f27-91af-a8c873070537",
    "spec_code" : "gaussdb.sr-fe.8xlarge.x86.4",
    "version_name" : "8.0",
    "instance_mode" : "Cluster",
    "az_status" : {
      "az1" : "normal",
      "az2" : "normal",
      "az3" : "normal",
      "az4" : "normal"
    }
  }, {
    "type" : "x86",
    "vcpus" : "32",
    "ram" : "128",
    "id" : "9f52a065-aa93-371a-9975-959fedf6e24f",
    "spec_code" : "gaussdb.sr-be.8xlarge.x86.4",
    "version_name" : "8.0",
    "instance_mode" : "Cluster",
    "az_status" : {
      "az1" : "normal",
      "az2" : "normal",
      "az3" : "normal",
      "az4" : "normal"
    }
  }, {
    "type" : "x86",
    "vcpus" : "64",
    "ram" : "256",
    "id" : "709822e4-567f-3e85-b4af-cb099206c8e2",
    "spec_code" : "gaussdb.sr-fe.16xlarge.x86.4",
    "version_name" : "8.0",
    "instance_mode" : "Cluster",
    "az_status" : {
      "az1" : "normal",
      "az2" : "normal",
      "az3" : "normal",
      "az4" : "unsupported"
    }
  }, {
    "type" : "x86",
    "vcpus" : "64",
    "ram" : "256",
    "id" : "4e56e208-0226-34bb-b84d-035ab0497824",
    "spec_code" : "gaussdb.sr-be.16xlarge.x86.4",
    "version_name" : "8.0",
    "instance_mode" : "Cluster",
    "az_status" : {
      "az1" : "normal",
      "az2" : "normal",
      "az3" : "normal",
      "az4" : "unsupported"
    }
  } ]
}

状态码： 400

Client error.

{
  "error_msg" : "Invalid specification code.",
  "error_code" : "DBS.280434"
}

状态码

请参见状态码。

错误码

请参见错误码。

父主题： HTAP-标准版