文档首页/ 云数据库 TaurusDB/ API参考/ API（推荐）/ HTAP-标准版/ HTAP引擎资源查询
更新时间：2024-09-11 GMT+08:00
在线调试
CLI示例
查看PDF
分享

HTAP引擎资源查询

功能介绍

HTAP引擎资源查询。

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

租户在某一Region下的project ID。

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

engine_name

是

String

HTAP引擎名。 取值范围：

  • star-rocks
  • click-house

请求参数

表2 请求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

表3 响应Body参数

参数

参数类型

描述

datastores

Array of datastores objects

数据库信息列表。
表4 datastores

参数

参数类型

描述

id

String

数据库版本ID，该字段不会有重复。

name

String

数据库版本号，只返回两位数的大版本号。

kernel_version

String

数据库内核版本号，返回完整的四位版本号。

状态码： 400

表5 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误消息。

状态码： 500

表6 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误消息。

请求示例

查询StarRocks数据库版本信息

GET https://{endpoint}/v3/23a50154cf494ec9ad6883979a12db0a/htap/datastores/star-rock

响应示例

状态码： 200

Success.

{
  "datastores" : [ {
    "id" : "38197973-8895-36ed-b853-52daeefb6d3a",
    "name" : "3.1",
    "kernel_version" : "3.1.6.0"
  } ]
}

状态码： 400

Client error.

{
  "error_msg" : "Invalid database type.",
  "error_code" : "DBS.280235"
}

状态码

请参见状态码。

错误码

请参见错误码。

父主题： HTAP-标准版