文档首页/ 云数据库 TaurusDB/ API参考/ API（推荐）/ HTAP-标准版/ 获取HTAP实例存储类型- ListHtapStorageType
更新时间：2025-10-21 GMT+08:00
在线调试
CLI示例
查看PDF
分享

获取HTAP实例存储类型 - ListHtapStorageType

功能介绍

获取HTAP实例存储类型。

调用方法

请参见如何调用API。

授权信息

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

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

    授权项

    访问级别

    资源类型（*为必须）

    条件键

    别名

    依赖的授权项

    gaussdbformysql:htapInstance:list

    List

    -

    -

    gaussdb:htapInstance:list

    -

URI

GET /v3/{project_id}/htap/storage-type/{database}

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释：

租户在某一Region下的project ID。

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

约束限制：

不涉及。

取值范围：

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

默认取值：

不涉及。

database

是

String

参数解释：

HTAP数据引擎类型。

约束限制：

不涉及。

取值范围：

  • star-rocks

  • click-house

默认取值：

star-rocks。
表2 Query参数

参数

是否必选

参数类型

描述

version_name

是

String

参数解释：

HTAP数据库大版本号。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

请求参数

表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参数

参数

参数类型

描述

storage_type

Array of storage_type objects

参数解释：

存储类型。

取值范围：

不涉及。
表5 storage_type

参数

参数类型

描述

name

String

参数解释：

存储介质名。

取值范围：

不涉及。

az_status

Map<String,String>

参数解释：

可支持可用区信息。

取值范围：

不涉及。

min_volume_size

Integer

参数解释：

最小可提供磁盘大小。

取值范围：

不涉及。

状态码： 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/storage-type/star-rocks?version_name=3.1.6.0

响应示例

状态码： 200

Success.

{
  "storage_type" : [ {
    "name" : "ULTRAHIGH",
    "az_status" : {
      "cn-southwest-244d" : "normal",
      "cn-southwest-244c" : "normal",
      "cn-southwest-244b" : "normal",
      "cn-southwest-244a" : "normal"
    },
    "min_volume_size" : 50
  }, {
    "name" : "ESSD",
    "az_status" : {
      "cn-southwest-244d" : "unsupported",
      "cn-southwest-244c" : "unsupported",
      "cn-southwest-244b" : "normal",
      "cn-southwest-244a" : "normal"
    },
    "min_volume_size" : 40
  } ]
}

状态码： 400

Client error.

{
    "error_msg": "The DB engine or version is not supported.",
    "error_code": "DBS.280238"
}

状态码

请参见状态码。

错误码

请参见错误码。

父主题： HTAP-标准版