Removing a Resource from Favorites

Function

This API is used to remove a specified resource from favorites.

URI

DELETE /v1.0/{project_id}/lts/favorite/{fav_res_id}

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

fav_res_id

Yes

String

ID of a favorite resource, including its log group or stream.

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.

Minimum: 1

Maximum: 10000

Content-Type

Yes

String

Set this parameter to application/json;charset=UTF-8.

Minimum: 30

Maximum: 30

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

message

ErrorMessagebody object

Error message body.

Table 4 ErrorMessagebody

Parameter

Type

Description

code

String

Error code.

details

String

Error message.

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

Removing from Favorites

DELETE /v1.0/{project_id}/lts/favorite/{fav_res_id}

Example Responses

Status code: 200

Removed from favorites.

none

Status code: 400

Invalid request. Modify the request based on the description in error_msg before a retry.

{
  "message" : {
    "code" : "LTS.0009",
    "details" : "update favorite failed"
  }
}

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

200

Removed from favorites.

400

Invalid request. Modify the request based on the description in error_msg before a retry.

500

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

Error Codes

See Error Codes.