更新时间:2024-09-11 GMT+08:00

查询实例LTS日志配置列表

功能介绍

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

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

租户在某一Region下的project ID。

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

表2 Query参数

参数

是否必选

参数类型

描述

enterprise_project_id

String

企业项目ID。

instance_id

String

实例ID。

instance_name

String

实例名称。

limit

String

查询记录数,默认值为10,最小为1,最大为100。

offset

String

索引位置,偏移量。从第一条数据偏移offset条数据后开始查询,默认为0(偏移0条数据,表示从第一条数据开始查询)。

请求参数

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

参数

参数类型

描述

instance_lts_configs

Array of LtsConfigsV3 objects

实例LTS日志配置列表。

total_count

Integer

总数。

表5 LtsConfigsV3

参数

参数类型

描述

lts_configs

Array of LtsConfig objects

LTS配置列表。

instance

InstanceLtsBasicInfo object

实例信息。

表6 LtsConfig

参数

参数类型

描述

log_type

String

日志类型。

lts_group_id

String

日志组ID。

lts_stream_id

String

日志流ID。

enabled

Boolean

是否开启。

表7 InstanceLtsBasicInfo

参数

参数类型

描述

id

String

实例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

错误消息。

请求示例

null

GET https://{endpoint}/v3/0483b6b16e954cb88930a360d2c4e663//logs/lts-configs

响应示例

状态码: 200

Success.

{
  "total_count" : 1,
  "instance_lts_configs" : [ {
    "lts_configs" : [ {
      "log_type" : "error_log",
      "lts_group_id" : "c3dd5233-24a1-443c-6b40-310b3ad85382",
      "lts_stream_id" : "9b476e31-b745-4e76-8d78-2081168651f7",
      "enabled" : true
    } ],
    "instance" : {
      "id" : "61a4ea66210545909d74a05c27a7179ein07",
      "name" : "gaussdb-mysql-instance01",
      "mode" : "ha",
      "engine_name" : "gaussdb-mysql",
      "engine_version" : 2.0,
      "status" : "normal",
      "enterprise_project_id" : 0,
      "enterprise_project_name" : "eps"
    }
  } ]
}

状态码

状态码

描述

200

Success.

400

Client error.

500

Server error.

错误码

请参见错误码