文档首页/ 云数据库 TaurusDB/ API参考/ API（推荐）/ HTAP-轻量版/ 查询实例LTS日志配置列表
更新时间：2024-09-11 GMT+08:00
在线调试
CLI示例
查看PDF
分享

查询实例LTS日志配置列表

功能介绍

查询实例LTS日志配置列表。

URI

GET /v3/{project_id}/clickhouse/instances/logs/lts-configs

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

租户在某一Region下的project ID。

获取方法请参见获取项目ID。
表2 Query参数

参数

是否必选

参数类型

描述

instance_id

否

String

ClickHouse实例ID，严格匹配UUID规则。

enterprise_project_id

否

String

企业项目id。

instance_name

否

String

实例名称。

limit

否

Integer

查询记录数，默认10。不能为负数，最小值为1，最大值为100。

offset

否

Integer

索引位置，偏移量，默认0。从第一条数据偏移offset条数据后开始查询（偏移0条数据，表示从第一条数据开始查询），必须为数字，不能为负数。

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

用户Token。

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

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

X-Language

否

String

请求语言类型。默认en-us。

取值范围：

  • en-us
  • zh-cn

响应参数

状态码： 200

表4 响应Body参数

参数

参数类型

描述

instance_lts_configs

Array of ChInstanceLtsConfigs objects

实例LTS配置信息。

total_count

Integer

实例总数。
表5 ChInstanceLtsConfigs

参数

参数类型

描述

lts_configs

Array of ChLtsConfigs objects

实例LTS配置信息。

instance

instance object

htap实例信息。
表6 ChLtsConfigs

参数

参数类型

描述

log_type

String

日志类型。

lts_group_id

String

LTS日志组ID。

lts_stream_id

String

LTS日志流ID。

enabled

String

LTS配置开关状态。
表7 instance

参数

参数类型

描述

id

String

ClickHouse实例ID。

name

String

实例名。

mode

String

实例主备状态。

engine_name

String

引擎类型。

engine_version

String

引擎版本。

status

String

实例状态。

enterprise_project_id

String

企业项目ID。

enterprise_project_name

String

企业项目名称。

状态码： 400

表8 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误描述。

状态码： 500

表9 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误描述。

请求示例

查询实例LTS日志配置列表。

GET https://{endpoint}/v3/619d3e78f61b4be68bc5aa0b59edcf7b/logs/clickhouse/lts-configs?instance_id=faf2cbf7f6cb422d83e61dbcc3e87023in07

响应示例

状态码： 200

Success.

{
  "instance_lts_configs" : [ {
    "lts_configs" : [ {
      "log_type" : "slow_log",
      "lts_group_id" : "460d8437-9dcb-47d0-8c56-5758f2042272",
      "lts_stream_id" : "bad1ca5d-e347-437f-be89-f2e08ce117b8",
      "enabled" : false
    } ],
    "instance" : {
      "id" : "4c2614fe03ae4ec28184a277b8c00c03in07",
      "name" : "gauss-8c01",
      "mode" : "Cluster",
      "engine_name" : "clickhouse",
      "engine_version" : "2.0.48",
      "status" : "normal",
      "enterprise_project_id" : "0",
      "enterprise_project_name" : "string"
    }
  } ],
  "total_count" : 1
}

状态码

状态码

描述

200

Success.

400

Client error.

500

Server error.

错误码

请参见错误码。

父主题： HTAP-轻量版