# 查询LTS日志配置信息 - QueryingLTSLogConfigurations #### 功能介绍 查询实例的LTS配置。 #### 接口约束 - 该接口支持如下数据库实例的慢日志配置： - GeminiDB Redis - 该接口支持如下数据库实例的审计日志配置： - GeminiDB Redis经典部署模式Proxy集群版 - GeminiDB Redis经典部署模式主备版 - GeminiDB Redis云原生部署模式 - GeminiDB兼容DynamoDB - GeminiDB Mongo #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。 - 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-nosql/nosql_05_0023.html)。 - 如果使用身份策略授权，需具备如下身份策略权限。 | 授权项 | 访问级别 | 资源类型（\*为必须） | 条件键 | 别名 | 依赖的授权项 | |:---|:---|:---|:---|:---|:---| | gaussdbfornosql:instance:setLogConfigs | Write | - | - | nosql:instances:saveLtsStreams | - | #### URI GET /v3/{project_id}/instances/logs/lts-configs 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 是 | String | **参数解释：** 租户在某一region下的project ID。获取方法请参见[获取项目ID](https://support.huaweicloud.com/api-nosql/nosql_projectid.html)。 **约束限制：** 不涉及。 **取值范围：** 长度为32个字符，仅由英文字母和数字组成。 **默认取值：** 不涉及。 | 表2Query参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | offset | 否 | Integer | **参数解释：** 索引位置偏移量。 **约束限制：** 不涉及。 **取值范围：** 不能为负数。 **默认取值：** 从第一条数据偏移offset条数据后开始查询，默认为0（偏移0条数据，表示从第一条数据开始查询）。 | | limit | 否 | Integer | **参数解释：** 查询个数上限值。 **约束限制：** 不涉及。 **取值范围：** 1\~100。 **默认取值：** 不传该参数时，默认查询前100条信息。 | | instance_id | 否 | String | **参数解释：** 根据实例ID精确搜索。可以调用[查询实例列表和详情 - QueryingInstancesandDetails](https://support.huaweicloud.com/api-nosql/nosql_05_0016.html)接口获取。如果未申请实例，可以调用[创建实例 - CreatinganInstance](https://support.huaweicloud.com/api-nosql/nosql_05_0014.html)接口创建。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | | instance_name | 否 | String | **参数解释：** 根据实例名称模糊搜索。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | | enterprise_project_id | 否 | String | **参数解释：** 企业项目ID。 **约束限制：** - 对于未开通企业多项目服务的用户，不传该参数。 - 对于已开通企业多项目服务的用户，不传该参数时，表示为default企业项目。获取方式请参见《企业管理API参考》的"[查询企业项目列表](https://support.huaweicloud.com/api-em/zh-cn_topic_0121230880.html)"响应参数"enterprise_projects"。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | #### 请求参数 表3请求Header参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | X-Auth-Token | 是 | String | **参数解释：** 用户Token。 通过调用IAM服务[获取用户Token](https://support.huaweicloud.com/api-iam/iam_30_0001.html)接口获取。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | | X-Language | 否 | String | **参数解释：** 语言。 **约束限制：** 不涉及。 **取值范围：** - zh-cn：表示中文语言。 - en-us：表示英文语言。 **默认取值：** 不涉及。 | #### 响应参数 **状态码： 200** 表4响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | total_count | Integer | **参数解释：** 实例总记录数。 **取值范围：** 不涉及。 | | instance_lts_configs | Array of [表5] objects | **参数解释：** 实例的LTS日志配置信息列表。 | 表5InstanceLogConfig | 参数 | 参数类型 | 描述 | |:---|:---|:---| | instance | [表6] object | **参数解释：** 实例信息。详情请参考[表6]。 | | lts_configs | Array of [表8] objects | **参数解释：** LTS日志配置明细。若未设置LTS日志流，不返回该字段。 | 表6LogInstanceInfo | 参数 | 参数类型 | 描述 | |:---|:---|:---| | id | String | **参数解释** **：** 实例ID，可以调用[查询实例列表和详情 - QueryingInstancesandDetails](https://support.huaweicloud.com/api-nosql/nosql_05_0016.html)接口获取。如果未申请实例，可以调用[创建实例 - CreatinganInstance](https://support.huaweicloud.com/api-nosql/nosql_05_0014.html)接口创建。 **取值范围** **：** 不涉及。 | | name | String | **参数解释：** 实例名称。 **取值范围：** 不涉及。 | | status | String | **参数解释：** 实例状态。 **取值范围：** - normal：表示实例正常。 - abnormal：表示实例异常。 - creating：表示实例创建中。 - frozen：表示实例被冻结。 - data_disk_full：表示实例磁盘已满。 - createfail：表示实例创建失败。 - enlargefail：表示实例扩容节点失败。 | | mode | String | **参数解释：** 实例类型。 **取值范围：** - 取值为"Cluster"，表示GeminiDB Redis经典部署模式Proxy集群实例类型、GeminiDB兼容DynamoDB经典部署模式集群实例类型。 - 取值为"RedisCluster"，表示GeminiDB Redis经典部署模式Cluster集群实例类型。 - 取值为"CloudNativeCluster"，表示GeminiDB Redis云原生部署模式集群实例类型、GeminiDB兼容DynamoDB云原生部署模式集群实例类型。 - 取值为"RedisReplication"，表示GeminiDB Redis主备实例类型。 - 取值为"ReplicaSet"，表示GeminiDB MongoDB副本集实例类型。 | | datastore | [表7] object | **参数解释：** 数据库信息。 | | actions | Array of strings | **参数解释：** 实例正在执行的动作。 | | enterprise_project_id | String | **参数解释：** 企业项目ID。 **取值范围：** 不涉及。 | | supported_log_types | Array of strings | **参数解释：** 日志类型。 - slow_log：表示慢日志。 - audit_log：表示审计日志。 | 表7InstancesDatastoreResult | 参数 | 参数类型 | 描述 | |:---|:---|:---| | type | String | **参数解释：** 数据库接口。 **取值范围：** - mongodb：表示GeminiDB Mongo接口类型。 - redis：表示查询GeminiDB Redis接口类型。 - dynamodb：表示查询GeminiDB兼容DynamoDB接口类型。 | | version | String | **参数解释：** 数据库版本号。 **取值范围：** 不涉及。 | 表8InstanceLogConfigDetail | 参数 | 参数类型 | 描述 | |:---|:---|:---| | log_type | String | **参数解释：** 日志类型。 **取值范围：** - slow_log：表示慢日志。 - audit_log：表示审计日志。 | | lts_group_id | String | **参数解释：** 关联的LTS日志组ID，若enabled为false，表示最近一次关联的LTS日志组ID。 **取值范围：** 不涉及。 | | lts_stream_id | String | **参数解释：** 关联的LTS日志流ID，若enabled为false，表示最近一次关联的LTS日志流ID。 **取值范围：** 不涉及。 | | enabled | Boolean | **参数解释：** 关联的LTS日志流是否启用。 **取值范围：** - true：表示已启用。 - false：表示未启用。 | #### 请求示例 ``` GET https://{Endpoint}/v3/0549b4a43100d4f32f51c01c2fe4acdb/instances/logs/lts-configs?limit=10&offset=0&instance_id=362b42f769ff45d884e1866f8ee00bb4in12&instance_name=c316&enterprise_project_id=0 ``` #### 响应示例 **状态码： 200** Success ``` { "total_count" : 1, "instance_lts_configs" : [ { "instance" : { "id" : "362b42f769ff45d884e1866f8ee00bb4in12", "name" : "nosql-c316", "mode" : "RedisCluster", "datastore" : { "version" : "5.0", "type" : "redis" }, "status" : "normal", "actions" : [ "GROWING" ], "enterprise_project_id" : "0", "supported_log_types" : [ "slow_log", "audit_log" ] }, "lts_configs" : [ { "log_type" : "slow_log", "lts_group_id" : "65442dd4-b8de-4e9f-8a80-b60aa0698354", "lts_stream_id" : "5992dd29-fd11-4228-a852-5f6e578789c5", "enabled" : true } ] } ] } ``` #### 状态码 请参见[状态码](https://support.huaweicloud.com/api-nosql/nosql_status_code.html)。 #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-nosql/nosql_error_code.html)。