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}/clickhouse/instances/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
instance_id	No	String	ClickHouse instance ID, which is compliant with the UUID format.
enterprise_project_id	No	String	Enterprise project ID.
instance_name	No	String	Instance name.
limit	No	Integer	Number of records to be queried. The default value is 10. The value cannot be a negative number. The minimum value is 1 and the maximum value is 100.
offset	No	Integer	Index offset. The default value is 0. If offset is set to N, the resource query starts from the N+1 piece of data. If the value is set to 0, indicating that the query starts from the first piece of data. The value must be a number but cannot be a negative number.

Request Parameters

**Table 3** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	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.
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 ChInstanceLtsConfigs objects	LTS configurations of an instance.
total_count	Integer	Total number of instances.

**Table 5** ChInstanceLtsConfigs
Parameter	Type	Description
lts_configs	Array of ChLtsConfigs objects	LTS configurations of an instance.
instance	instance object	HTAP instance information.

**Table 6** ChLtsConfigs
Parameter	Type	Description
log_type	String	Log type.
lts_group_id	String	LTS log group ID.
lts_stream_id	String	LTS log stream ID.
enabled	String	Whether to enable LTS configurations.

**Table 7** instance
Parameter	Type	Description
id	String	ClickHouse instance ID.
name	String	Instance name.
mode	String	Primary/standby role of an instance.
engine_name	String	Engine type.
engine_version	String	Engine version.
status	String	Instance 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

Querying LTS configurations of an instance

GET https://{endpoint}/v3/619d3e78f61b4be68bc5aa0b59edcf7b/logs/clickhouse/lts-configs?instance_id=faf2cbf7f6cb422d83e61dbcc3e87023in07

Example Response

Status code: 200

Success.

{
  "instance_lts_configs" : [ {
    "lts_configs" : [ {
      "log_type" : "slow_log",
      "lts_group_id" : "460d8437-9dcb-47d0-8c56-5758f2042272",
      "lts_stream_id" : "bad1ca5d-e347-437f-be89-f2e08ce117b8",
      "enabled" : false
    } ],
    "instance" : {
      "id" : "4c2614fe03ae4ec28184a277b8c00c03in07",
      "name" : "gauss-8c01",
      "mode" : "Cluster",
      "engine_name" : "clickhouse",
      "engine_version" : "2.0.48",
      "status" : "normal",
      "enterprise_project_id" : "0",
      "enterprise_project_name" : "string"
    }
  } ],
  "total_count" : 1
}