Help Center/ TaurusDB/ API Reference/ APIs (Recommended)/ Log Management/ Querying LTS Configurations of an Instance

Updated on 2024-09-11 GMT+08:00

Online Debugging

CLI Examples

View PDF

Querying LTS Configurations of an Instance

Function

This API is used to query LTS configurations of an instance. Before calling this API:

Learn how to authorize and authenticate it.
Obtain the required region and endpoint.

URI

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

**Table 1** URI parameter
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID of a tenant in a region. To obtain this value, see Obtaining a Project ID.

**Table 2** Query parameters
Parameter	Mandatory	Type	Description
enterprise_project_id	No	String	Enterprise project ID.
instance_id	No	String	Instance ID.
instance_name	No	String	Instance name.
limit	No	String	Number of records to be queried. Value range: 1 to 100. Default value: 10
offset	No	String	Index offset. If offset is set to N, the query starts from the N+1 piece of data. If action is set to filter, offset is 0 by default, indicating that the query starts from the first piece of data.

Request Parameters

**Table 3** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	User token. To obtain the value, call the API for obtaining a user token. The value of X-Subject-Token in the response header is the token value.
Content-Type	Yes	String	Content type. Value: application/json
X-Language	No	String	Request language type. The default value is en-us. Values: en-us zh-cn

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
instance_lts_configs	Array of LtsConfigsV3 objects	LTS configurations of an instance.
total_count	Integer	Total number.

**Table 5** LtsConfigsV3
Parameter	Type	Description
lts_configs	Array of LtsConfig objects	LTS configurations.
instance	InstanceLtsBasicInfo object	Instance information.

**Table 6** LtsConfig
Parameter	Type	Description
log_type	String	Log type.
lts_group_id	String	Log group ID.
lts_stream_id	String	Log stream ID.
enabled	Boolean	Whether LTS configurations are enabled.

**Table 7** InstanceLtsBasicInfo
Parameter	Type	Description
id	String	Instance ID.
name	String	Instance name.
mode	String	Instance type.
engine_name	String	Engine name.
engine_version	String	Engine version.
status	String	Status.
enterprise_project_id	String	Enterprise project ID.
enterprise_project_name	String	Enterprise project name.

Status code: 400

**Table 8** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.

Status code: 500

**Table 9** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.

Example Request

null

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

Example Response

Status code: 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"
    }
  } ]
}