文档首页/ 云日志服务 LTS/ API参考/ API说明/ 日志转储/ 创建日志转储(旧版)
更新时间:2024-10-21 GMT+08:00
分享

创建日志转储(旧版)

功能介绍

该接口用于将指定的一个或多个日志流的日志转储到OBS服务。

调用方法

请参见如何调用API

URI

POST /v2/{project_id}/log-dump/obs

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

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

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

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

Content-Type

String

该字段填为:application/json;charset=UTF-8。

表3 请求Body参数

参数

是否必选

参数类型

描述

log_group_id

String

日志组id。

log_stream_ids

Array of strings

日志流id列表, 可以指定一个或多个日志流进行obs周期性转储

obs_bucket_name

String

obs 桶名称。

type

String

周期性转储, 必须填 cycle。

storage_format

String

转储格式 RAW/JSON, 默认为 RAW。

最小长度:3

最大长度:4

switch_on

Boolean

是否开启转储 true/false, 默认为 true

prefix_name

String

转储至OBS桶中的日志文件前缀。

dir_prefix_name

String

自定义文件夹路径。

period

Integer

转储周期的长度

period_unit

String

转储周期的单位。> period与period_unit拼接后必须在该列表中["2min","5min","30min","1hour","3hour","6hour","12hour"]

响应参数

状态码: 201

表4 响应Body参数

参数

参数类型

描述

log_dump_obs_id

String

转储id。

状态码: 400

表5 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

调用失败响应信息描述。

状态码: 403

表6 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

调用失败响应信息描述。

状态码: 500

表7 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

调用失败响应信息描述。

请求示例

创建日志转储

POST https://{endpoint}/v2/{project_id}/log-dump/obs

{
  "log_group_id" : "d9dba9f3-xxxx-48bd-xxxx-xxxxa24a8053",
  "log_stream_ids" : [ "45e7f609-xxxx-4cd3-835b-xxxx4a124718" ],
  "obs_bucket_name" : "lts-test",
  "type" : "cycle",
  "storage_format" : "RAW",
  "switch_on" : "true",
  "prefix_name" : "fileprefixname",
  "dir_prefix_name" : "dirprefixname",
  "period" : 5,
  "period_unit" : "min"
}

响应示例

状态码: 200

请求响应成功。

  • 当前日志组不存在。

    {
      "error_code" : "LTS.0201",
      "error_msg" : "The log group does not existed"
    }
  • 当前日志流不存在。

    {
      "error_code" : "LTS.0208",
      "error_msg" : "Log stream id does not exist: 632b9bdc-5afd-4666-a5de-2579f8b80314-"
    }
  • 当前OBS桶不存在。

    {
      "error_code" : "LTS.0416",
      "error_msg" : "obs bucket does not exist: zhuanchu"
    }
  • 转储时日志流ID已经被关联。

    {
      "error_code" : "LTS.0207",
      "error_msg" : "Log stream id is associated by transfer: 632b9bdc-5afd-4666-a5de-2579f8b80314"
    }
  • 转储类型没有在列表中。

    {
      "error_code" : "LTS.1901",
      "error_msg" : "type is not in the list [cycle]"
    }
  • 转储格式没有在列表中。

    {
      "error_code" : "LTS.1901",
      "error_msg" : "storage_format is not in the list [RAW, JSON]"
    }
  • 转储周期没有在列表中。

    {
      "error_code" : "LTS.1901",
      "error_msg" : "period+period_unit is not in the list [2min, 5min, 30min, 1hour, 3hour, 6hour, 12hour]"
    }
  • 转储单位没有在列表中。

    {
      "error_code" : "LTS.1901",
      "error_msg" : "period_unit is not in the list [min, hour]"
    }
  • 转储日志文件前缀无效,请确认是否按要求提供。

    {
      "error_code" : "LTS.1902",
      "error_msg" : "prefix_name is invalid, please verify if it's provided as required"
    }
  • 自定义转储路径名前缀无效,请确认是否按要求提供。

    {
      "error_code" : "LTS.1902",
      "error_msg" : "dir_prefix_name is invalid, please verify if it's provided as required"
    }

状态码: 201

请求响应成功。

{
  "log_dump_obs_id" : "45fdc36b-xxxx-4567-xxxx-559xxxxdf968"
}

状态码: 400

BadRequest。非法请求。 建议根据error_msg直接修改该请求,不要重试该请求。

BadRequest。非法请求。建议根据error_msg直接修改该请求,不要重试该请求。
{     
  "error_code": "LTS.0007",     
  "error_msg": "The request body format must be json" 
}

状态码: 403

Forbidden。请求被拒绝访问。返回该状态码,表明请求能够到达服务端,且服务端能够理解用户请求,但是拒绝做更多的事情,因为该请求被设置为拒绝访问,建议直接修改该请求,不要重试该请求。

{
  "error_code" : "LTS.0001",
  "error_msg" : "Invalid projectId"
}

状态码: 500

InternalServerError。

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

InternalServerError。表明服务端能被请求访问到,但是服务内部出错。
{    
  "error_code": "LTS.0010",    
  "error_msg": "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
58
59
60
61
62
63
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.*;

import java.util.List;
import java.util.ArrayList;

public class CreateLogDumpObsSolution {

    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();
        CreateLogDumpObsRequest request = new CreateLogDumpObsRequest();
        CreateLogDumpObsRequestBody body = new CreateLogDumpObsRequestBody();
        List<String> listbodyLogStreamIds = new ArrayList<>();
        listbodyLogStreamIds.add("45e7f609-xxxx-4cd3-835b-xxxx4a124718");
        body.withPeriodUnit("min");
        body.withPeriod(5);
        body.withDirPrefixName("dirprefixname");
        body.withPrefixName("fileprefixname");
        body.withSwitchOn(true);
        body.withStorageFormat("RAW");
        body.withType("cycle");
        body.withObsBucketName("lts-test");
        body.withLogStreamIds(listbodyLogStreamIds);
        body.withLogGroupId("d9dba9f3-xxxx-48bd-xxxx-xxxxa24a8053");
        request.withBody(body);
        try {
            CreateLogDumpObsResponse response = client.createLogDumpObs(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
42
43
44
45
46
# 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 = CreateLogDumpObsRequest()
        listLogStreamIdsbody = [
            "45e7f609-xxxx-4cd3-835b-xxxx4a124718"
        ]
        request.body = CreateLogDumpObsRequestBody(
            period_unit="min",
            period=5,
            dir_prefix_name="dirprefixname",
            prefix_name="fileprefixname",
            switch_on=True,
            storage_format="RAW",
            type="cycle",
            obs_bucket_name="lts-test",
            log_stream_ids=listLogStreamIdsbody,
            log_group_id="d9dba9f3-xxxx-48bd-xxxx-xxxxa24a8053"
        )
        response = client.create_log_dump_obs(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
51
52
53
54
55
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.CreateLogDumpObsRequest{}
	var listLogStreamIdsbody = []string{
        "45e7f609-xxxx-4cd3-835b-xxxx4a124718",
    }
	dirPrefixNameCreateLogDumpObsRequestBody:= "dirprefixname"
	prefixNameCreateLogDumpObsRequestBody:= "fileprefixname"
	switchOnCreateLogDumpObsRequestBody:= true
	request.Body = &model.CreateLogDumpObsRequestBody{
		PeriodUnit: "min",
		Period: int32(5),
		DirPrefixName: &dirPrefixNameCreateLogDumpObsRequestBody,
		PrefixName: &prefixNameCreateLogDumpObsRequestBody,
		SwitchOn: &switchOnCreateLogDumpObsRequestBody,
		StorageFormat: "RAW",
		Type: "cycle",
		ObsBucketName: "lts-test",
		LogStreamIds: listLogStreamIdsbody,
		LogGroupId: "d9dba9f3-xxxx-48bd-xxxx-xxxxa24a8053",
	}
	response, err := client.CreateLogDumpObs(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

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

状态码

状态码

描述

200

请求响应成功。

201

请求响应成功。

400

BadRequest。非法请求。 建议根据error_msg直接修改该请求,不要重试该请求。

403

Forbidden。请求被拒绝访问。返回该状态码,表明请求能够到达服务端,且服务端能够理解用户请求,但是拒绝做更多的事情,因为该请求被设置为拒绝访问,建议直接修改该请求,不要重试该请求。

500

InternalServerError。

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

错误码

请参见错误码

相关文档