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

查询HTAP实例LTS日志配置列表 - ShowLTSConfig

功能介绍

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

调用方法

请参见如何调用API。

授权信息

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

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

    授权项

    访问级别

    资源类型（*为必须）

    条件键

    别名

    依赖的授权项

    gaussdbformysql:log:listLtsConfig

    List

    -

    -
    • gaussdb:log:listLtsConfig

    -

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释：

租户在某一Region下的project ID。

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

约束限制：

不涉及。

取值范围：

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

默认取值：

不涉及。
表2 Query参数

参数

是否必选

参数类型

描述

instance_id

否

String

参数解释：

HTAP标准版实例ID，此参数是实例的唯一标识。

约束限制：

不涉及。

取值范围：

只能由英文字母、数字组成，后缀为in17，长度为36个字符。

默认取值：

不涉及。

enterprise_project_id

否

String

参数解释：

企业项目ID。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

instance_name

否

String

参数解释：

HTAP标准版实例名称。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

limit

否

Integer

参数解释：

查询记录数。

约束限制：

不涉及。

取值范围：

0-100。

默认取值：

10。

offset

否

Integer

参数解释：

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

约束限制：

不涉及。

取值范围：

0-10000。

默认取值：

0。

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

参数解释：

用户Token。

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

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

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

X-Language

是

String

参数解释：

请求语言类型。

约束限制：

不涉及。

取值范围：

  • en-us

  • zh-cn

默认取值：

en-us。

响应参数

状态码：200

表4 响应Body参数

参数

参数类型

描述

instance_lts_configs

Array of instance_lts_configs objects

参数解释：

实例LTS配置信息。

约束限制：

不涉及。

total_count

Integer

参数解释：

实例数。

取值范围：

不涉及。
表5 instance_lts_configs

参数

参数类型

描述

lts_configs

Array of lts_configs objects

参数解释：

LTS配置信息。

约束限制：

不涉及。

instance

instance object

参数解释：

HTAP标准版实例信息。

约束限制：

不涉及。
表6 lts_configs

参数

参数类型

描述

log_type

String

参数解释：

日志类型。

取值范围：

  • error_log：错误日志。

  • slow_log：慢日志。

lts_group_id

String

参数解释：

LTS日志组ID。

取值范围：

不涉及。

lts_stream_id

String

参数解释：

LTS日志流ID。

取值范围：

不涉及。

enabled

String

参数解释：

LTS配置开关状态。

取值范围：

  • true：开启。

  • false：关闭。
表7 instance

参数

参数类型

描述

id

String

参数解释：

HTAP标准版实例ID，此参数是实例的唯一标识。

取值范围：

只能由英文字母、数字组成，后缀为in17，长度为36个字符。

name

String

参数解释：

HTAP标准版实例名称。

取值范围：

不涉及。

mode

String

参数解释：

HTAP标准版实例模式。

取值范围：

  • Cluster：集群模式。

  • Single：单机模式。

engine_name

String

参数解释：

HTAP引擎类型名字。

取值范围：

不涉及。

engine_version

String

参数解释：

引擎版本。

取值范围：

不涉及。

status

String

参数解释：

HTAP标准版实例状态。

取值范围：

  • normal：正常。

  • abnormal：异常。

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

错误消息。

请求示例

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

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

响应示例

状态码：200

Success

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

状态码：400

Error response

{
  "error_code" : "DBS.200022",
  "error_msg" : "实例不存在"
}

状态码

状态码

描述

200

Success

400

Error response

500

Server error.

错误码

请参见错误码。

父主题： HTAP-标准版

相关文档