Adding a Log to Favorites

Function

This API is used to add a log to favorites.

URI

POST /v1.0/{project_id}/lts/favorite

**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. Minimum: 32 Maximum: 32

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.

**Table 3** Request body parameters
Parameter	Mandatory	Type	Description
eps_id	No	String	Enterprise project ID.
favorite_resource_id	Yes	String	Favorite resource ID (log stream ID).
favorite_resource_type	Yes	String	Favorite resource type. The value can be LOG_STREAM.
log_group_id	Yes	String	Log group ID.
log_group_name	No	String	Log group name.
log_stream_id	Yes	String	Log stream ID.
log_stream_name	No	String	Log stream name.
is_global	Yes	Boolean	This parameter must be set to true. Otherwise, logs cannot be added to favorites.

Response Parameters

Status code: 201

**Table 4** Response body parameters
Parameter	Type	Description
create_time	Integer	Creation time.
favorite_resource_id	String	Log stream ID.
favorite_resource_type	String	Favorite resource type. The value can be LOG_STREAM.
log_group_id	String	Log group ID.
log_group_name	String	Log group name.
log_stream_id	String	Log stream ID.
log_stream_name	String	Log stream name.
project_id	String	Project ID.
is_global	Boolean	Whether to support globalization.

Status code: 400

**Table 5** Response body parameters
Parameter	Type	Description
message	ErrorMessagebody object	Error message body.

**Table 6** ErrorMessagebody
Parameter	Type	Description
code	String	Error code.
details	String	Error message.

Status code: 500

**Table 7** Response body parameters
Parameter	Type	Description
message	ErrorMessagebody object	Error message body.

**Table 8** ErrorMessagebody
Parameter	Type	Description
code	String	Error code.
details	String	Error message.

Example Requests

Adding a Log to Favorites

POST /v1.0/2a473356cca5487f8373be891bffc1cf/lts/favorite

{
  "log_group_id" : "d91fff37-9d10-47f1-85de-c2840724908f",
  "log_group_name" : "lts-group-sgq1",
  "log_stream_id" : "f2fb0a2d-d4cd-4bc9-ac12-93c6d255883c",
  "log_stream_name" : "lts-topic-xxxxtest",
  "eps_id" : "0",
  "favorite_resource_id" : "f2fb0a2d-d4cd-4bc9-ac12-93c6d255883c",
  "favorite_resource_type" : "LOG_STREAM",
  "is_global" : true
}

Example Responses

Status code: 201

A log is added to favorites.

{
  "create_time" : 1669018970929,
  "eps_id" : "0",
  "favorite_resource_id" : "f2fb0a2d-d4cd-4bc9-ac12-93c6d255883c",
  "is_global" : true,
  "favorite_resource_type" : "LOG_STREAM",
  "log_group_id" : "d91fff37-9d10-47f1-85de-c2840724908f",
  "log_group_name" : "lts-group-sgq1",
  "log_stream_id" : "f2fb0a2d-d4cd-4bc9-ac12-93c6d255883c",
  "log_stream_name" : "lts-topic-xxxxtest",
  "project_id" : "2a473356cca5487f8373be891bffc1cf"
}

Status code: 400

BadRequest: Invalid request. Modify the request based on the description in details before a retry.

{
  "message" : {
    "code" : "LTS.0603",
    "details" : "group or stream not exist"
  }
}

Status code: 500

The server has received the request but encountered an internal error.

{
  "message" : {
    "code" : "LTS.0203",
    "details" : "Internal Server Error"
  }
}

Status Codes

Status Code	Description
201	A log is added to favorites.
400	BadRequest: Invalid request. Modify the request based on the description in details before a retry.
500	The server has received the request but encountered an internal error.

Error Codes

See Error Codes.

Parent topic: Log Management

Previous topic: Querying the Log Histogram

Next topic: Querying Resources by Time Segment

Feedback

Was this page helpful?

Helpful Not helpful

Provide feedback

Thank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.

The system is busy. Please try again later.

For any further questions, feel free to contact us through the chatbot.

Chatbot