Help Center/ Simple Message Notification/ API Reference/ APIs/ Cloud Logs/ Binding a Cloud Log to a Topic
Updated on 2025-08-22 GMT+08:00
View PDF

Binding a Cloud Log to a Topic

Function

This API is used to bind a cloud log to a specified topic to record information such as the message sending status of the topic.

Calling Method

For details, see Calling APIs.

URI

POST /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.
Table 3 Request body parameters

Parameter

Mandatory

Type

Description

log_group_id

Yes

String

Specifies the LTS log group ID.

log_stream_id

Yes

String

Specifies the LTS log stream ID.

Response Parameters

Status code: 201

Table 4 Response body parameters

Parameter

Type

Description

request_id

String

Specifies the unique ID of a request.

id

String

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

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

Unique request ID.

code

String

Service error code.

message

String

Service error description.

error_code

String

Service error code.

error_msg

String

Service error description.

encoded_authorization_message

String

Encrypted detailed reason for rejection.

details

OpenAPIFailedDetails object

Details of the error message obtained by the cloud service when it calls the dependent service.
Table 7 OpenAPIFailedDetails

Parameter

Type

Description

error_code

String

Error code in the response of the dependent service called by the cloud service.

error_msg

String

Error message in the response of the dependent service called by the cloud service.

Status code: 404

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.

Status code: 500

Table 9 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

Binding a cloud log to a topic

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

{
  "log_group_id" : "d1b6c352-ee45-4196-9230-c74b7894e356",
  "log_stream_id" : "114960b4-1c26-48dd-93c2-4caae24aec49"
}

Example Responses

Status code: 201

OK

{
  "request_id" : "42f3b0cd1c894e87aa0275ce33305b21",
  "id" : "4ea80c8a68b840e19b4efd3a8f0d62ed"
}

Status Codes

Status Code

Description

201

OK

400

Bad Request

403

Unauthorized

404

Not Found

500

Internal Server Error

Error Codes

See Error Codes.

Parent topic: Cloud Logs