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 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	Definition Project ID of a tenant in a region. To obtain this value, see Obtaining a Project ID. Constraints N/A Range The value contains 32 characters. Only letters and digits are allowed. Default Value N/A

**Table 2** Query parameters
Parameter	Mandatory	Type	Description
enterprise_project_id	No	String	Definition Enterprise project ID. Constraints N/A Range The value contains 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 contains 36 characters with a suffix of in07. Only letters and digits are allowed. Default Value N/A
instance_name	No	String	Definition Instance name. Constraints N/A Range The name must start with a letter and consist of 4 to 64 characters. Only letters (case-sensitive), digits, hyphens (-), and underscores (_) are allowed. Default Value N/A
limit	No	String	Definition Number of records to be queried. Constraints The value must be an integer and cannot be a negative number. Range 1–100 Default Value 100
offset	No	String	Definition Index offset. The query starts from the next piece of data indexed by this parameter. Constraints The value must be an integer and cannot be a negative number. Range ≥ 0 Default Value 0

Request Parameters

**Table 3** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	Definition User token. To obtain this value, call the IAM API for obtaining 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
Content-Type	Yes	String	Definition Content type. Constraints N/A Range application/json Default Value application/json
X-Language	No	String	Definition Request language type. Constraints N/A Range en-us zh-cn Default Value en-us

Response Parameters

Status code: 200

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

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

**Table 6** LtsConfig
Parameter	Type	Description
log_type	String	Definition Log type. Range error_log: error logs slow_log: slow query logs
lts_group_id	String	Definition Log group ID. Range N/A
lts_stream_id	String	Definition Log stream ID. Range N/A
enabled	Boolean	Definition Whether LTS configurations are enabled. Range N/A

**Table 7** InstanceLtsBasicInfo
Parameter	Type	Description
id	String	Definition Instance ID. Range N/A
name	String	Definition Instance name. Range N/A
mode	String	Definition Instance type. Range N/A
engine_name	String	Definition Engine name. Range N/A
engine_version	String	Definition Engine version. Range N/A
status	String	Definition Status. Range creating: The instance is being created. normal: The instance is normal. abnormal: The instance is abnormal. createfail: The instance failed to be created.
enterprise_project_id	String	Definition Enterprise project ID. Range N/A
enterprise_project_name	String	Definition Enterprise project name. Range N/A

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

Querying LTS configurations of an instance

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"
    }
  } ]
}

Status Code

For details, see Status Codes.

Error Code

For details, see Error Codes.

Parent topic: Log Management

Previous topic: Obtaining the Temporary Link for Downloading Full SQL

Next topic: Deleting LTS Configurations in Batches