Help Center/ GaussDB(for MySQL)/ API Reference/ APIs (Recommended)/ HTAP (Lightweight Edition)/ Querying Node Information in Error Logs or Slow Query Logs
Updated on 2024-09-11 GMT+08:00

Querying Node Information in Error Logs or Slow Query Logs

Function

This API is used to query node information in error logs or slow query logs. Before calling this API:

URI

GET /v3/{project_id}/instances/{instance_id}/clickhouse/nodes

Table 1 URI parameters

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.

instance_id

Yes

String

ClickHouse instance ID, which is compliant with the UUID format.

Request Parameters

Table 2 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 3 Response body parameter

Parameter

Type

Description

node_list

Array of node_list objects

ClickHouse instance nodes.

Table 4 node_list

Parameter

Type

Description

node_id

String

ID of a ClickHouse instance node.

node_name

String

Name of a ClickHouse instance node.

role

String

Node role.

Status code: 400

Table 5 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Status code: 500

Table 6 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Example Request

Querying node information in error logs or slow query logs

GET https://{endpoint}/v3/619d3e78f61b4be68bc5aa0b59edcf7b/instances/28f61af50fc9452aa0ed5ea25c3cc3d3/clickhouse/nodes

Example Response

Status code: 200

Success.

{
  "node_list" : [ {
    "node_id" : "f1a5641d62f44803ac38ffefed0e4736no07",
    "node_name" : "gauss-htap-node01",
    "role" : "slave"
  } ]
}

Status Code

Status Code

Description

200

Success.

400

Client error.

500

Server error.

Error Code

For details, see Error Codes.