Help Center/ GaussDB/ API Reference/ APIs (Recommended)/ LTS Logs/ Viewing LTS Log Configurations

Updated on 2025-10-22 GMT+08:00

View PDF

Viewing LTS Log Configurations

Function

This API is used to view LTS log configurations. Before calling this API:

Learn how to authenticate this API.
Obtain the required region and endpoint.

Debugging

You can debug this API in API Explorer.

URI

GET /v3/{project_id}/instances/logs/lts-config

**Table 1** URI parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Definition Project ID of a tenant in a region. To obtain the value, see Obtaining a Project ID. Constraints N/A Range The value can contain 32 characters. Only letters and digits are allowed. Default Value N/A
instance_id	No	String	Definition Instance ID, which uniquely identifies an instance. Constraints N/A Range The value can contain 36 characters. Only letters and digits are allowed. Default Value N/A
instance_mode	No	String	Definition Instance type. Constraints N/A Range Ha: centralized type Independent: independent deployment Combined: combined deployment Default Value N/A
instance_name	No	String	Definition Instance name. Constraints N/A Range The value can contain 36 characters. Only letters and digits are allowed. Default Value N/A
enterprise_project_id	No	String	Definition Enterprise project ID. This parameter is suitable only for enterprise tenants. Constraints N/A Range N/A Default Value N/A
limit	No	Integer	Definition Number of records returned by a query. For example, if this parameter is set to 10, a maximum of 10 records can be displayed. Constraints N/A Range [1, 50] Default Value 50
offset	No	Integer	Definition Index offset. The query starts from the next piece of data indexed by this parameter. For example, if this parameter is set to 1 and limit is set to 10, only the 2nd to 11th records are displayed. Constraints N/A Range [0, 2^31-1] Default Value 0: The query starts from the first data record.

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	Definition User token. You can obtain the token by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is the token value. Constraints N/A Range N/A Default Value N/A
X-Language	No	String	Definition Language. Constraints N/A Range zh-cn en-us Default Value en-us

Response Parameters

**Table 3** Response body parameters
Parameter	Type	Description
total_count	Integer	Definition Total number of records. Range N/A
instance_lts_configs	Array of Table 4 objects	Definition LTS log details of an instance.

**Table 4** Gaussdbv5InstanceLtsConfig
Parameter	Type	Description
instance	Table 6 objects	Definition Basic instance information.
lts_configs	Array of Table 5 objects	Definition LTS-related information.

**Table 5** InstanceLtsConfig
Parameter	Type	Description
log_type	String	Definition Log type. Range audit_log: audit log
lts_group_id	String	Definition ID of the LTS log group. If enabled is set to false, this parameter indicates the ID of the latest associated LTS log group. Range N/A
lts_stream_id	String	Definition ID of the LTS log stream. If enabled is set to false, this parameter indicates the ID of the latest associated LTS log stream. Range N/A
enabled	Boolean	Definition Whether the configuration is enabled. Range true: enabled false: disabled

**Table 6** InstanceLtsDetail
Parameter	Type	Description
id	String	Definition Instance ID. Range N/A
name	String	Definition Alarm severity name. Range N/A
mode	String	Definition Instance type. Range Ha: centralized type Independent: independent deployment Combined: combined deployment
status	String	Definition Instance status. Range normal: The instance is normal. abnormal: The instance is abnormal. creating: The instance is being created. frozen: The instance has been frozen. data_disk_full: The instance storage is full. createfail: The instance failed to be created. shutdown: The instance has been stopped. deleted: The instance has been deleted. enlargefail: Instance nodes failed to be added.
datastore	Table 7 objects	Definition Database information.
frozen_flag	Integer	Definition Whether the instance is frozen. Range N/A
enterprise_project_id	String	Definition Enterprise project ID. Range N/A
actions	Array of objects	Definition Actions that are being executed on an instance.

**Table 7** InstanceLtsDataStore
Parameter	Type	Description
type	String	Definition Database engine. Range N/A
version	String	Definition Instance version. Range N/A

Example Request

Viewing LTS log configurations

GET https://gaussdb-opengauss.ap-southeast-1.myhuaweicloud.com/v3/9a29cc53af2f499cb48a6d81839264cb/instances/logs/lts-config?instance_id=6eb077d8e2cb4ddf8588f6acc39b7dc6in14

Example Response

[
  {
    "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": []
  }
]