更新时间:2024-08-29 GMT+08:00

创建接入规则

功能介绍

该接口用于创建AOM容器日志接入LTS的接入规则。

调用方法

请参见如何调用API

URI

POST /v2/{project_id}/lts/aom-mapping

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

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

表2 Query参数

参数

是否必选

参数类型

描述

isBatch

Boolean

是否使用自动映射,填写为true的话,可以不用填写容器名、日志流相关参数。

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

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

Content-Type

String

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

表4 请求Body参数

参数

是否必选

参数类型

描述

rule_name

String

接入规则名称

缺省值:None

rule_info

AomMappingRuleInfo object

规则详情

project_id

String

项目ID,获取方式请参见:10.3-获取账号租户ID、项目资源集ID、日志组ID、日志流ID。

缺省值:None

rule_id

String

接入规则id

表5 AomMappingRuleInfo

参数

是否必选

参数类型

描述

cluster_id

String

集群id

cluster_name

String

集群名称。

deployments_prefix

String

日志流前缀。当参数isBatch=true且填写此参数时,则与参数“deployments”拼接为日志流名称,拼接后的日志流名称长度不超过64位。

deployments

Array of strings

工作负载(选全部工作负载使用“ALL_DEPLOYMENTS”)。

说明:

自动映射时需要罗列出每个工作负载。

namespace

String

命名空间

files

Array of CreateAomMappingfilesInfo objects

日志详细(全部日志使用“ALL_FILES”)。

container_name

String

容器名称

表6 CreateAomMappingfilesInfo

参数

是否必选

参数类型

描述

file_name

String

路径名称。

匹配规则:^/[A-Za-z0-9.*_/-]+|stdout.log|

最多两个**

log_stream_info

CreateAomMappingLogStreamInfo object

日志流信息日志详细

表7 CreateAomMappingLogStreamInfo

参数

是否必选

参数类型

描述

target_log_group_id

String

日志组ID。

缺省值:None

target_log_group_name

String

日志组名称。

target_log_stream_id

String

日志流ID。

缺省值:None

target_log_stream_name

String

日志流名称。

响应参数

状态码: 201

表8 响应Body参数

参数

参数类型

描述

[数组元素]

Array<Array<CreateAomMappingRuleResp>>

请求响应成功, 成功创建接入配置。

表9 CreateAomMappingRuleResp

参数

参数类型

描述

project_id

String

项目id

rule_name

String

接入规则名称

rule_id

String

接入规则id

rule_info

AomMappingRuleInfoRespBody object

接入规则详情

表10 AomMappingRuleInfoRespBody

参数

参数类型

描述

cluster_id

String

集群id

cluster_name

String

集群名称

deployments_prefix

String

日志流前缀

deployments

Array of strings

工作负载

namespace

String

命名空间

container_name

String

容器名称

files

Array of AomMappingfilesInfos objects

接入规则详情

表11 AomMappingfilesInfos

参数

参数类型

描述

file_name

String

路径名

log_stream_info

AomMappingLogStreamInfos object

接入规则详情。

表12 AomMappingLogStreamInfos

参数

参数类型

描述

target_log_group_id

String

日志组id

target_log_group_name

String

目标日志组名称

target_log_stream_id

String

日志流id

target_log_stream_name

String

目标日志流名称

状态码: 400

表13 响应Body参数

参数

参数类型

描述

code

String

错误码。

details

String

调用失败响应信息描述。

状态码: 401

表14 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

调用失败响应信息描述。

状态码: 403

表15 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

调用失败响应信息描述。

状态码: 500

表16 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

调用失败响应信息描述。

请求示例

创建接入规则

POST https://{endpoint}/v2/{project_id}/lts/aom-mapping

{
  "rule_name" : "abcde",
  "project_id" : "2a473356cca5487f8373be891bffc1cf",
  "rule_info" : {
    "cluster_id" : "4fae3587-0202-11eb-9ba9-0255ac100b02",
    "cluster_name" : "testdiskrate",
    "deployments_prefix" : "deployments_prefix",
    "deployments" : [ "__ALL_DEPLOYMENTS__" ],
    "namespace" : "default",
    "container_name" : "container-0",
    "files" : [ {
      "file_name" : "__ALL_FILES__",
      "log_stream_info" : {
        "target_log_group_id" : "8c9dcda6-d048-43a7-989b-c76c34b0ac85",
        "target_log_group_name" : "lts-group-wb28",
        "target_log_stream_id" : "2c228bd1-cbf1-41fb-b563-0ca2769202b2",
        "target_log_stream_name" : "mysql"
      }
    } ]
  }
}

响应示例

状态码: 201

请求响应成功, 成功创建接入配置。

[ {
  "project_id" : "",
  "rule_id" : "",
  "rule_info" : {
    "cluster_id" : "",
    "cluster_name" : "",
    "container_name" : "",
    "deployments_prefix" : "deployments_prefix",
    "deployments" : [ "" ],
    "files" : [ {
      "file_name" : "",
      "log_stream_info" : {
        "target_log_group_id" : "",
        "target_log_group_name" : "",
        "target_log_stream_id" : "",
        "target_log_stream_name" : ""
      }
    } ],
    "namespace" : ""
  },
  "rule_name" : ""
} ]

状态码: 400

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

{
  "errorCode" : "LTS.0014",
  "errorMessage" : "Operation DB failed"
}

状态码: 401

AuthFailed。鉴权失败, 请确认token后再次请求 。

{
  "error_code" : "LTS.0414",
  "error_msg" : "Invalid token"
}

状态码: 403

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

{
  "error_code" : "LTS.0003",
  "error_msg" : "parse_token_failed"
}

状态码: 500

InternalServerError。

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

{
  "error_code" : "LTS.0102",
  "error_msg" : "ServiceUnavailable."
}

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
64
65
66
67
68
69
70
71
72
73
74
75
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 CreateAomMappingRulesSolution {

    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();
        CreateAomMappingRulesRequest request = new CreateAomMappingRulesRequest();
        AomMappingRequestInfo body = new AomMappingRequestInfo();
        AomMappingLogStreamInfo logStreamInfoFiles = new AomMappingLogStreamInfo();
        logStreamInfoFiles.withTargetLogGroupId("8c9dcda6-d048-43a7-989b-c76c34b0ac85")
            .withTargetLogGroupName("lts-group-wb28")
            .withTargetLogStreamId("2c228bd1-cbf1-41fb-b563-0ca2769202b2")
            .withTargetLogStreamName("mysql");
        List<AomMappingfilesInfo> listRuleInfoFiles = new ArrayList<>();
        listRuleInfoFiles.add(
            new AomMappingfilesInfo()
                .withFileName("__ALL_FILES__")
                .withLogStreamInfo(logStreamInfoFiles)
        );
        List<String> listRuleInfoDeployments = new ArrayList<>();
        listRuleInfoDeployments.add("__ALL_DEPLOYMENTS__");
        AomMappingRuleInfo ruleInfobody = new AomMappingRuleInfo();
        ruleInfobody.withClusterId("4fae3587-0202-11eb-9ba9-0255ac100b02")
            .withClusterName("testdiskrate")
            .withDeploymentsPrefix("deployments_prefix")
            .withDeployments(listRuleInfoDeployments)
            .withNamespace("default")
            .withContainerName("container-0")
            .withFiles(listRuleInfoFiles);
        body.withRuleInfo(ruleInfobody);
        body.withRuleName("abcde");
        body.withProjectId("2a473356cca5487f8373be891bffc1cf");
        request.withBody(body);
        try {
            CreateAomMappingRulesResponse response = client.createAomMappingRules(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
47
48
49
50
51
52
53
54
55
56
57
58
59
60
# 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 = CreateAomMappingRulesRequest()
        logStreamInfoFiles = AomMappingLogStreamInfo(
            target_log_group_id="8c9dcda6-d048-43a7-989b-c76c34b0ac85",
            target_log_group_name="lts-group-wb28",
            target_log_stream_id="2c228bd1-cbf1-41fb-b563-0ca2769202b2",
            target_log_stream_name="mysql"
        )
        listFilesRuleInfo = [
            AomMappingfilesInfo(
                file_name="__ALL_FILES__",
                log_stream_info=logStreamInfoFiles
            )
        ]
        listDeploymentsRuleInfo = [
            "__ALL_DEPLOYMENTS__"
        ]
        ruleInfobody = AomMappingRuleInfo(
            cluster_id="4fae3587-0202-11eb-9ba9-0255ac100b02",
            cluster_name="testdiskrate",
            deployments_prefix="deployments_prefix",
            deployments=listDeploymentsRuleInfo,
            namespace="default",
            container_name="container-0",
            files=listFilesRuleInfo
        )
        request.body = AomMappingRequestInfo(
            rule_info=ruleInfobody,
            rule_name="abcde",
            project_id="2a473356cca5487f8373be891bffc1cf"
        )
        response = client.create_aom_mapping_rules(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
56
57
58
59
60
61
62
63
64
65
66
67
68
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.CreateAomMappingRulesRequest{}
	logStreamInfoFiles := &model.AomMappingLogStreamInfo{
		TargetLogGroupId: "8c9dcda6-d048-43a7-989b-c76c34b0ac85",
		TargetLogGroupName: "lts-group-wb28",
		TargetLogStreamId: "2c228bd1-cbf1-41fb-b563-0ca2769202b2",
		TargetLogStreamName: "mysql",
	}
	var listFilesRuleInfo = []model.AomMappingfilesInfo{
        {
            FileName: "__ALL_FILES__",
            LogStreamInfo: logStreamInfoFiles,
        },
    }
	var listDeploymentsRuleInfo = []string{
        "__ALL_DEPLOYMENTS__",
    }
	deploymentsPrefixRuleInfo:= "deployments_prefix"
	containerNameRuleInfo:= "container-0"
	ruleInfobody := &model.AomMappingRuleInfo{
		ClusterId: "4fae3587-0202-11eb-9ba9-0255ac100b02",
		ClusterName: "testdiskrate",
		DeploymentsPrefix: &deploymentsPrefixRuleInfo,
		Deployments: listDeploymentsRuleInfo,
		Namespace: "default",
		ContainerName: &containerNameRuleInfo,
		Files: listFilesRuleInfo,
	}
	request.Body = &model.AomMappingRequestInfo{
		RuleInfo: ruleInfobody,
		RuleName: "abcde",
		ProjectId: "2a473356cca5487f8373be891bffc1cf",
	}
	response, err := client.CreateAomMappingRules(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

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

状态码

状态码

描述

201

请求响应成功, 成功创建接入配置。

400

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

401

AuthFailed。鉴权失败, 请确认token后再次请求 。

403

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

500

InternalServerError。

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

503

ServiceUnavailable。

被请求的服务无效,服务不可用。

错误码

请参见错误码