Help Center/ Log Tank Service/ API Reference/ APIs/ Multi-Account Log Aggregation/ Obtaining the Log Aggregation Switch Status
Updated on 2024-08-29 GMT+08:00

Obtaining the Log Aggregation Switch Status

Function

This API can be called only by administrators or delegated administrators to obtain the status of the log aggregation switch.

Calling Method

For details, see Calling APIs.

URI

GET /v1/{project_id}/lts/log-converge-config/switch

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID. For details about how to obtain a project ID, see Obtaining the Project ID, Account ID, Log Group ID, and Log Stream ID.

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

User token obtained from IAM. For details about how to obtain a user token, see Obtaining a User Token.

Content-Type

Yes

String

Set this parameter to application/json;charset=utf8.

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

log_converge_switch

Boolean

Log aggregation switch.

Status code: 400

Table 4 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error description.

Example Requests

Obtain the log aggregation switch status.

GET https://{endpoint}/v1/{project_id}/lts/log-converge-config/switch

/v1/{project_id}/lts/log-converge-config/switch

Example Responses

Status code: 200

Query succeeded.

{
  "log_converge_switch" : true
}

Status Codes

Status Code

Description

200

Query succeeded.

400

Error response

Error Codes

See Error Codes.