Updated on 2024-08-29 GMT+08:00

Adding a Log to Favorites

Function

This API is used to add a log to favorites.

Calling Method

For details, see Calling APIs.

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.

No default value.

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.

favorite_resource_type

Yes

String

Favorite resource type.

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

Whether global favorites are supported. 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.

eps_id

String

Enterprise project ID.

favorite_resource_id

String

Favorite resource ID.

favorite_resource_type

String

Favorite resource type: 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 enable the function of adding logs to favorites.

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 description.

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 description.

Example Requests

Adding a Log to Favorites

/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

Invalid request. Modify the request based on the description in error_msg 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"
  }
}

SDK Sample Code

The SDK sample code is as follows.

Adding a Log to Favorites

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
package com.huaweicloud.sdk.test;

import com.huaweicloud.sdk.core.auth.ICredential;
import com.huaweicloud.sdk.core.auth.BasicCredentials;
import com.huaweicloud.sdk.core.exception.ConnectionException;
import com.huaweicloud.sdk.core.exception.RequestTimeoutException;
import com.huaweicloud.sdk.core.exception.ServiceResponseException;
import com.huaweicloud.sdk.lts.v2.region.LtsRegion;
import com.huaweicloud.sdk.lts.v2.*;
import com.huaweicloud.sdk.lts.v2.model.*;


public class CreatefavoriteSolution {

    public static void main(String[] args) {
        // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
        // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
        String ak = System.getenv("CLOUD_SDK_AK");
        String sk = System.getenv("CLOUD_SDK_SK");
        String projectId = "{project_id}";

        ICredential auth = new BasicCredentials()
                .withProjectId(projectId)
                .withAk(ak)
                .withSk(sk);

        LtsClient client = LtsClient.newBuilder()
                .withCredential(auth)
                .withRegion(LtsRegion.valueOf("<YOUR REGION>"))
                .build();
        CreatefavoriteRequest request = new CreatefavoriteRequest();
        CreatefavoriteReqbody body = new CreatefavoriteReqbody();
        body.withIsGlobal(true);
        body.withLogStreamName("lts-topic-xxxxtest");
        body.withLogStreamId("f2fb0a2d-d4cd-4bc9-ac12-93c6d255883c");
        body.withLogGroupName("lts-group-sgq1");
        body.withLogGroupId("d91fff37-9d10-47f1-85de-c2840724908f");
        body.withFavoriteResourceType("log_stream");
        body.withFavoriteResourceId("f2fb0a2d-d4cd-4bc9-ac12-93c6d255883c");
        body.withEpsId("0");
        request.withBody(body);
        try {
            CreatefavoriteResponse response = client.createfavorite(request);
            System.out.println(response.toString());
        } catch (ConnectionException e) {
            e.printStackTrace();
        } catch (RequestTimeoutException e) {
            e.printStackTrace();
        } catch (ServiceResponseException e) {
            e.printStackTrace();
            System.out.println(e.getHttpStatusCode());
            System.out.println(e.getRequestId());
            System.out.println(e.getErrorCode());
            System.out.println(e.getErrorMsg());
        }
    }
}

Adding a Log to Favorites

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
# coding: utf-8

import os
from huaweicloudsdkcore.auth.credentials import BasicCredentials
from huaweicloudsdklts.v2.region.lts_region import LtsRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdklts.v2 import *

if __name__ == "__main__":
    # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak = os.environ["CLOUD_SDK_AK"]
    sk = os.environ["CLOUD_SDK_SK"]
    projectId = "{project_id}"

    credentials = BasicCredentials(ak, sk, projectId)

    client = LtsClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(LtsRegion.value_of("<YOUR REGION>")) \
        .build()

    try:
        request = CreatefavoriteRequest()
        request.body = CreatefavoriteReqbody(
            is_global=True,
            log_stream_name="lts-topic-xxxxtest",
            log_stream_id="f2fb0a2d-d4cd-4bc9-ac12-93c6d255883c",
            log_group_name="lts-group-sgq1",
            log_group_id="d91fff37-9d10-47f1-85de-c2840724908f",
            favorite_resource_type="log_stream",
            favorite_resource_id="f2fb0a2d-d4cd-4bc9-ac12-93c6d255883c",
            eps_id="0"
        )
        response = client.createfavorite(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)

Adding a Log to Favorites

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
package main

import (
	"fmt"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic"
    lts "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/lts/v2"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/lts/v2/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/lts/v2/region"
)

func main() {
    // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak := os.Getenv("CLOUD_SDK_AK")
    sk := os.Getenv("CLOUD_SDK_SK")
    projectId := "{project_id}"

    auth := basic.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        WithProjectId(projectId).
        Build()

    client := lts.NewLtsClient(
        lts.LtsClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

    request := &model.CreatefavoriteRequest{}
	logStreamNameCreatefavoriteReqbody:= "lts-topic-xxxxtest"
	logGroupNameCreatefavoriteReqbody:= "lts-group-sgq1"
	epsIdCreatefavoriteReqbody:= "0"
	request.Body = &model.CreatefavoriteReqbody{
		IsGlobal: true,
		LogStreamName: &logStreamNameCreatefavoriteReqbody,
		LogStreamId: "f2fb0a2d-d4cd-4bc9-ac12-93c6d255883c",
		LogGroupName: &logGroupNameCreatefavoriteReqbody,
		LogGroupId: "d91fff37-9d10-47f1-85de-c2840724908f",
		FavoriteResourceType: "log_stream",
		FavoriteResourceId: "f2fb0a2d-d4cd-4bc9-ac12-93c6d255883c",
		EpsId: &epsIdCreatefavoriteReqbody,
	}
	response, err := client.Createfavorite(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

For SDK sample code of more programming languages, see the Sample Code tab in API Explorer. SDK sample code can be automatically generated.

Status Codes

Status Code

Description

201

A log is added to 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.