Updated on 2024-06-13 GMT+08:00

Creating an Ingestion Rule

Function

This API is used to create a rule of ingesting container logs from AOM to LTS.

Calling Method

For details, see Calling APIs.

URI

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

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.

Default: None

Minimum: 32

Maximum: 32

Table 2 Query Parameters

Parameter

Mandatory

Type

Description

isBatch

Yes

Boolean

Whether automatic mapping is used. If you set this parameter to true, you do not need to set the container name and log stream parameters.

Request Parameters

Table 3 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.

Default: None

Minimum: 1000

Maximum: 2000

Content-Type

Yes

String

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

Default: None

Minimum: 30

Maximum: 30

Table 4 Request body parameters

Parameter

Mandatory

Type

Description

rule_name

Yes

String

Ingestion rule name.

No default value.

Minimum: 1

Maximum: 100

rule_info

Yes

AomMappingRuleInfo object

Rule details.

project_id

Yes

String

Project ID. For details about how to obtain a project ID, see 10.3-Obtaining the Account Tenant ID, Project Resource Set ID, Log Group ID, and Log Stream ID.

No default value.

Minimum: 32

Maximum: 32

rule_id

No

String

Ingestion rule ID.

Table 5 AomMappingRuleInfo

Parameter

Mandatory

Type

Description

cluster_id

Yes

String

Cluster ID.

cluster_name

Yes

String

Cluster name.

deployments_prefix

No

String

Log stream prefix. If isBatch is true and this parameter is set, the log stream name consists of this parameter and the parameter deployments. The length of the combined log stream name cannot exceed 64 characters.

deployments

Yes

Array of strings

Deployment. ALL_DEPLOYMENTS indicates all Deployments.

NOTE:

During automatic mapping, all deployments need to be listed.

namespace

Yes

String

Namespace.

files

Yes

Array of CreateAomMappingfilesInfo objects

Log. ALL_FILES indicates all logs.

container_name

No

String

Container name.

Table 6 CreateAomMappingfilesInfo

Parameter

Mandatory

Type

Description

file_name

Yes

String

Path name. Matching rule: ^/[A-Za-z0-9._/-]+|stdout.log| Up to two asterisks () are allowed.

log_stream_info

Yes

CreateAomMappingLogStreamInfo object

Log stream details.

Table 7 CreateAomMappingLogStreamInfo

Parameter

Mandatory

Type

Description

target_log_group_id

Yes

String

Log group ID.

No default value.

Minimum: 36

Maximum: 36

target_log_group_name

Yes

String

Log group name.

Minimum: 1

Maximum: 64

target_log_stream_id

Yes

String

Log stream ID. No default value.

Minimum: 36

Maximum: 36

target_log_stream_name

Yes

String

Log stream name.

Minimum: 1

Maximum: 64

Response Parameters

Status code: 201

Table 8 Response body parameters

Parameter

Type

Description

[items]

Array of CreateAomMappingRuleResp objects

The ingestion rule is created.

Table 9 CreateAomMappingRuleResp

Parameter

Type

Description

project_id

String

Project ID.

rule_name

String

Ingestion rule name.

rule_id

String

Ingestion rule ID.

rule_info

AomMappingRuleInfoRespBody object

Ingestion rule details.

Table 10 AomMappingRuleInfoRespBody

Parameter

Type

Description

cluster_id

String

Cluster ID.

cluster_name

String

Cluster name.

deployments_prefix

String

Log stream prefix.

deployments

Array of strings

Workload.

namespace

String

Namespace

container_name

String

Container name

files

Array of AomMappingfilesInfos objects

Ingestion rule details.

Table 11 AomMappingfilesInfos

Parameter

Type

Description

file_name

String

Path name.

log_stream_info

AomMappingLogStreamInfos object

Ingestion rule details.

Table 12 AomMappingLogStreamInfos

Parameter

Type

Description

target_log_group_id

String

Log group ID.

target_log_group_name

String

Target log group name.

target_log_stream_id

String

Log stream ID.

target_log_stream_name

String

Target log stream name.

Status code: 400

Table 13 Response body parameters

Parameter

Type

Description

code

String

Error code.

Enumeration values:

  • LTS.0742

  • LTS.0743

  • LTS.0014

  • LTS.0740

  • LTS.0744

  • LTS.0746

details

String

Error message.

Enumeration values:

  • AOM mapping rule log group id does not exist

  • Operation DB failed

  • AOM mapping rule name already exists

  • AOM mapping rule param validate error

  • AOM mapping rule log stream id does not exist

  • AOM mapping rule log stream name already exist in another log group

Status code: 401

Table 14 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

Enumeration values:

  • LTS.0403

error_msg

String

Error message.

Enumeration values:

  • Invalid projectId

Status code: 403

Table 15 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

Enumeration values:

  • LTS.0403

error_msg

String

Error message.

Enumeration values:

  • Invalid projectId

Status code: 500

Table 16 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

Enumeration values:

  • LTS.0403

error_msg

String

Error message.

Enumeration values:

  • Invalid projectId

Example Requests

Creating an ingestion rule

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

Example Responses

Status code: 201

The ingestion rule is created.

[ {
  "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" : ""
} ]

Status code: 400

Bad Request: The request is invalid. Modify the request based on the description in error_msg before a retry.

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

Status code: 401

AuthFailed. Authentication failed. Check the token and try again.

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

Status code: 403

Forbidden.The request has been rejected.The server has received the request and understood it, but refuses to respond to it. The client should not repeat the request without modifications.

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

Status code: 500

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

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

SDK Sample Code

The SDK sample code is as follows.

Creating an ingestion rule

 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
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");

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

        LtsClient client = LtsClient.newBuilder()
                .withCredential(auth)
                .withRegion(LtsRegion.valueOf("<YOUR REGION>"))
                .build();
        CreateAomMappingRulesRequest request = new CreateAomMappingRulesRequest();
        request.withIsBatch(<isBatch>);
        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());
        }
    }
}

Creating an ingestion rule

 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"]

    credentials = BasicCredentials(ak, sk)

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

    try:
        request = CreateAomMappingRulesRequest()
        request.is_batch = <IsBatch>
        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)

Creating an ingestion rule

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

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

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

    request := &model.CreateAomMappingRulesRequest{}
	request.IsBatch = <isBatch>
	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)
    }
}

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

The ingestion rule is created.

400

Bad Request: The request is invalid. Modify the request based on the description in error_msg before a retry.

401

AuthFailed. Authentication failed. Check the token and try again.

403

Forbidden.The request has been rejected.The server has received the request and understood it, but refuses to respond to it. The client should not repeat the request without modifications.

500

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

503

ServiceUnavailable. The requested service is unavailable.

Error Codes

See Error Codes.