更新时间:2024-12-20 GMT+08:00

创建日志收藏

功能介绍

创建日志流收藏

调用方法

请参见如何调用API

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

项目ID,获取方式请参见:获取项目ID,获取账号ID,日志组ID、日志流ID

最小长度:32

最大长度:32

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

从IAM服务获取的用户Token,获取方式请参见:获取用户Token

Content-Type

String

该字段填为:application/json;charset=utf8。

表3 请求Body参数

参数

是否必选

参数类型

描述

eps_id

String

企业项目id

favorite_resource_id

String

收藏资源id

favorite_resource_type

String

收藏资源类型

log_group_id

String

日志组id

log_group_name

String

日志组名称,日志组名称有误时按照日志组id创建日志收藏

log_stream_id

String

日志流id

log_stream_name

String

日志流名称,日志流名称有误时按照日志流id创建日志收藏

is_global

Boolean

是否支持全局化,必填true,否则创建不了日志收藏

响应参数

状态码: 201

表4 响应Body参数

参数

参数类型

描述

create_time

Integer

创建时间

eps_id

String

企业项目id

favorite_resource_id

String

收藏资源id

favorite_resource_type

String

收藏资源类型,资源类型为LOG_STREAM。

log_group_id

String

日志组id

log_group_name

String

日志组名称

log_stream_id

String

日志流id

log_stream_name

String

日志流名称

project_id

String

项目id

is_global

Boolean

是否开启日志收藏

状态码: 400

表5 响应Body参数

参数

参数类型

描述

message

ErrorMessagebody object

错误信息body体

表6 ErrorMessagebody

参数

参数类型

描述

code

String

错误码

最小长度:8

最大长度:36

details

String

错误描述

最小长度:2

最大长度:512

状态码: 500

表7 响应Body参数

参数

参数类型

描述

message

ErrorMessagebody object

错误信息body体

表8 ErrorMessagebody

参数

参数类型

描述

code

String

错误码

最小长度:8

最大长度:36

details

String

错误描述

最小长度:2

最大长度:512

请求示例

创建日志收藏

/v1.0/{project_id}/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
}

响应示例

状态码: 201

创建日志收藏成功

{
  "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"
}

状态码: 400

BadRequest 非法请求建议根据error_msg直接修改该请求

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

状态码: 500

表明服务端能被请求访问到,但是服务内部出错

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

SDK代码示例

SDK代码示例如下。

创建日志收藏

 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());
        }
    }
}

创建日志收藏

 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)

创建日志收藏

 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)
    }
}

更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。

状态码

状态码

描述

201

创建日志收藏成功

400

BadRequest 非法请求建议根据error_msg直接修改该请求

500

表明服务端能被请求访问到,但是服务内部出错

错误码

请参见错误码