# 查看LTS日志配置信息 - ViewingLTSLogConfigurations #### 功能介绍 查看LTS日志配置信息。 - 调用接口前，您需要了解API [认证鉴权](https://support.huaweicloud.com/api-gaussdb/gaussdb_api_011.html)。 - 调用接口前，您需要提前获取到[地区和终端节点](https://developer.huaweicloud.com/endpoint)。 #### 调试 您可以在[API Explorer](https://apiexplorer.developer.huaweicloud.com/apiexplorer/doc?product=GaussDBforopenGauss&api=ListLtsConfigs)中调试该接口。 #### URI GET /v3/{project_id}/instances/logs/lts-config 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 是 | String | **参数解释：** 租户在某一Region下的项目ID。 获取方法请参见[获取项目ID](https://support.huaweicloud.com/api-gaussdb/gaussdb_api_196.html)。 **约束限制：** 不涉及。 **取值范围：** 只能由英文字母、数字组成，且长度为32个字符。 **默认取值**： 不涉及。 | | instance_id | 否 | String | **参数解释：** 实例ID，此参数是用户创建实例的唯一标识。请参考[查询数据库实例列表 - QueryingDBInstances](https://support.huaweicloud.com/api-gaussdb/gaussdb_api_328.html)接口获取实例ID。 **约束限制：** 不涉及。 **取值范围：** 只能由英文字母、数字组成，且长度为36个字符。 **默认取值** **：** 不涉及。 | | instance_mode | 否 | String | **参数解释** **：** 实例类型。 **约束限制：** 不涉及。 **取值范围** **：** - Ha：集中式类型。 - Independent：独立部署类型。 - Combined：混合部署类型。 **默认取值** **：** 不涉及。 | | instance_name | 否 | String | **参数解释：** 实例名称。 **约束限制：** 不涉及。 **取值范围：** 只能由英文字母、数字组成，且长度为36个字符。 **默认取值** **：** 不涉及。 | | enterprise_project_id | 否 | String | **参数解释：** 企业项目ID。只有企业租户时该参数才生效。 使用请参考《企业管理 API参考》的"[查询企业项目列表](https://support.huaweicloud.com/api-em/zh-cn_topic_0121230880.html)"响应消息表"enterprise_project字段数据结构说明"的"id"。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值**： 不涉及。 | | limit | 否 | Integer | **参数解释：** 查询记录数。例如该参数设定为10，则查询结果最多只显示10条记录。 **约束限制：** 不涉及。 **取值范围：** \[1, 50\] **默认取值**： 50 | | offset | 否 | Integer | **参数解释：** 索引位置，偏移量。从第一条数据偏移offset条数据后开始查询。例如：该参数指定为1，limit指定为10，则只展示第2\~11条数据。 **约束限制：** 不涉及。 **取值范围：** \[0, 2147483647\] **默认取值**： 默认为0（偏移0条数据，表示从第一条数据开始查询）。 | #### 请求参数 表2请求Header参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | X-Auth-Token | 是 | String | **参数解释：** 用户Token。 通过调用IAM服务[获取用户Token](https://support.huaweicloud.com/api-iam/iam_30_0001.html)接口获取。 请求响应成功后在响应消息头中包含的"X-Subject-Token"的值即为Token值。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值** **：** 不涉及。 | | X-Language | 否 | String | **参数解释：** 指定接口返回信息的语言类型。 **约束限制：** 不涉及。 **取值范围：** - **zh-cn**：中文 - **en-us**：英文 **默认取值** **：** **en-us** | #### 响应参数 表3响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | total_count | Integer | **参数解释：** 日志总记录数。单位：条。 **取值范围：** 不涉及。 | | instance_lts_configs | Array of [表4] objects | **参数解释：** 实例下LTS明细列表。 | 表4Gaussdbv5InstanceLtsConfig | 参数 | 参数类型 | 描述 | |:---|:---|:---| | instance | [表6 InstanceLtsDetail] objects | **参数解释：** 实例基本信息。 | | lts_configs | Array of [表5] objects | **参数解释：** LTS相关信息。 | 表5InstanceLtsConfig | 参数 | 参数类型 | 描述 | |:---|:---|:---| | log_type | String | **参数解释：** 日志类型。 **取值范围：** audit_log：审计日志。 | | lts_group_id | String | **参数解释：** 关联的LTS日志组ID，若enabled为false，表示最近一次关联的LTS日志组ID。 **取值范围：** 不涉及。 | | lts_stream_id | String | **参数解释：** 关联的LTS日志流ID，若enabled为false，表示最近一次关联的LTS日志流ID。 **取值范围：** 不涉及。 | | enabled | Boolean | **参数解释：** 是否启用。 **取值范围：** - true：启用。 - false：关闭。 | 表6InstanceLtsDetail | 参数 | 参数类型 | 描述 | |:---|:---|:---| | id | String | **参数解释：** 实例ID。 **取值范围：** 不涉及。 | | name | String | **参数解释：** 实例名称。 **取值范围：** 不涉及。 | | mode | String | **参数解释：** 实例类型。 **取值范围：** - Ha：集中式类型。 - Independent：独立部署类型。 - Combined：混合部署类型。 | | status | String | **参数解释：** 实例状态。 **取值范围：** - normal：实例正常。 - abnormal：实例异常。 - creating：实例创建中。 - frozen： 实例被冻结。 - data_disk_full： 实例磁盘已满。 - createfail：实例创建失败。 - shutdown：实例已关机。 - deleted：实例已删除。 - enlargefail： 实例扩容节点个数失败。 | | datastore | [表7] objects | **参数解释：** 数据库信息。 | | frozen_flag | Integer | **参数解释：** 实例冻结状态标识。 **取值范围：** - 0：业务正常运行。 - 1：欠费冻结。 - 2：待删除。 | | enterprise_project_id | String | **参数解释：** 企业项目ID。 **取值范围：** 不涉及。 | | actions | Array of objects | **参数解释：** 实例正在执行的动作。 | 表7InstanceLtsDataStore | 参数 | 参数类型 | 描述 | |:---|:---|:---| | type | String | **参数解释：** 数据库引擎。 **取值范围：** 不涉及。 | | version | String | **参数解释：** 实例的版本。 **取值范围：** 不涉及。 | #### 请求示例 查看LTS日志配置信息。 ``` GET https://gaussdb-opengauss.cn-north-4.myhuaweicloud.com/v3/9a29cc53af2f499cb48a6d81839264cb/instances/logs/lts-config?instance_id=6eb077d8e2cb4ddf8588f6acc39b7dc6in14 ``` #### 响应示例 ``` { "total_count": 0, "instance_lts_configs": [ { "instance": { "actions": [], "id": "6eb077d8e2cb4ddf8588f6acc39b7dc6in14", "name": "gauss-wxx-ies-euler", "mode": "Ha", "status": "normal", "datastore": { "type": "gauss-wxx-ies-euler", "version": "" }, "frozen_flag": 0, "enterprise_project_id": "0" }, "lts_configs": [ { "log_type": "audit_log", "lts_group_id": "6eb077d8e2cb4ddf8588f6acc39b7dc6csa", "lts_stream_id": "6eb077d8e2cb4ddf8588f6acc39b7dc6derf", "enabled": true } ] } ] } ``` #### 状态码 - 正常 200 - 异常 请参见[状态码](https://support.huaweicloud.com/api-gaussdb/gaussdb_api_194.html)。 #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-gaussdb/gaussdb_api_195.html)。