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

Querying Cloud Logs

Function

This API is used to query cloud logs bound to a specified topic.

Calling Method

For details, see Calling APIs.

URI

GET /v2/{project_id}/notifications/topics/{topic_urn}/logtanks

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Specifies the project ID. For details about how to obtain the project ID, see Obtaining the Project ID.

topic_urn

Yes

String

Specifies the resource identifier of the topic, which is unique. To obtain the identifier, see Querying Topics.

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

Specifies a user token.

It can be obtained by calling an IAM API. The value of X-Subject-Token in the response header is the user token.

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

request_id

String

Specifies the unique ID of a request.

count

Integer

Specifies the number of cloud logs.

logtanks

Array of LogtankItem objects

Specifies cloud logs.

Table 4 LogtankItem

Parameter

Type

Description

id

String

Specifies the resource identifier of the cloud log, which is unique.

log_group_id

String

Specifies the LTS log group ID.

log_stream_id

String

Specifies the LTS log stream ID.

create_time

String

Specifies the creation time. The UTC time is in YYYY-MM-DDTHH:MM:SSZ format.

update_time

String

Specifies the update time. The UTC time is in YYYY-MM-DDTHH:MM:SSZ format.

Status code: 400

Table 5 Response body parameters

Parameter

Type

Description

request_id

String

Specifies the unique ID of a request.

error_code

String

Specifies the error code.

error_msg

String

Specifies the error message.

Status code: 403

Table 6 Response body parameters

Parameter

Type

Description

request_id

String

Specifies the unique ID of a request.

error_code

String

Specifies the error code.

error_msg

String

Specifies the error message.

Status code: 404

Table 7 Response body parameters

Parameter

Type

Description

request_id

String

Specifies the unique ID of a request.

error_code

String

Specifies the error code.

error_msg

String

Specifies the error message.

Status code: 500

Table 8 Response body parameters

Parameter

Type

Description

request_id

String

Specifies the unique ID of a request.

error_code

String

Specifies the error code.

error_msg

String

Specifies the error message.

Example Requests

Querying cloud logs

GET https://{SMN_Endpoint}/v2/{project_id}/notifications/topics/urn:smn:regionId:f96188c7ccaf4ffba0c9aa149ab2bd57:test_topic_v2/logtanks

null

Example Responses

Status code: 200

OK

{
  "request_id" : "f5c05cb70d264ca58d1080202ceba284",
  "count" : 1,
  "logtanks" : [ {
    "id" : "4ea80c8a68b840e19b4efd3a8f0d62ed",
    "log_group_id" : "d1b6c352-ee45-4196-9230-c74b7894e356",
    "log_stream_id" : "114960b4-1c26-48dd-93c2-4caae24aec49",
    "create_time" : "2022-10-10T09:00:00Z",
    "update_time" : "2022-10-10T09:00:00Z"
  } ]
}

Status Codes

Status Code

Description

200

OK

400

Bad Request

403

Unauthorized

404

Not Found

500

Internal Server Error

Error Codes

See Error Codes.