文档首页/ 云数据库 GaussDB(for MySQL)/ API参考/ API（推荐）/ HTAP-标准版/ 获取HTAP实例存储类型
更新时间：2024-09-11 GMT+08:00
在线调试
CLI示例
查看PDF
分享

获取HTAP实例存储类型

功能介绍

获取HTAP实例存储类型。

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

租户在某一Region下的project ID。

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

database

是

String

HTAP数据库名。 取值范围：

  • star-rocks
  • click-house
表2 Query参数

参数

是否必选

参数类型

描述

version_name

是

String

数据库大版本号。

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

用户Token。

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

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

Content-Type

是

String

内容类型。 取值：application/json。

X-Language

否

String

请求语言类型。默认en-us。 取值范围：

  • en-us
  • zh-cn

响应参数

状态码： 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-标准版