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

Querying All Ingestion Rules

Function

This API is used to query all rules of ingesting container logs from AOM to LTS.

Calling Method

For details, see Calling APIs.

URI

GET /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.

Table 2 Query Parameters

Parameter

Mandatory

Type

Description

log_group_name

No

String

Log group name.

log_stream_name

No

String

Log stream name.

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.

Content-Type

Yes

String

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

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

[items]

Array<Array<CreateAomMappingRuleResp>>

Details of all ingestion rules are returned.

Table 5 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 6 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 7 AomMappingfilesInfos

Parameter

Type

Description

file_name

String

Path name.

log_stream_info

AomMappingLogStreamInfos object

Ingestion rule details.

Table 8 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 9 Response body parameters

Parameter

Type

Description

code

String

Error code.

details

String

Error message.

Status code: 401

Table 10 Response body parameters

Parameter

Type

Description

message

Message401 object

Response message.

Table 11 Message401

Parameter

Type

Description

code

String

Error code.

details

String

Error message.

Status code: 403

Table 12 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Status code: 500

Table 13 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Example Requests

None

Example Responses

Status code: 200

Details of all ingestion rules are returned.

[ {
  "project_id" : "",
  "rule_id" : "",
  "rule_info" : {
    "cluster_id" : "",
    "cluster_name" : "",
    "container_name" : "",
    "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" : ""
}, {
  "project_id" : "",
  "rule_id" : "",
  "rule_info" : {
    "cluster_id" : "",
    "cluster_name" : "",
    "container_name" : "",
    "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.

 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
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 ShowAomMappingRulesSolution {

    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();
        ShowAomMappingRulesRequest request = new ShowAomMappingRulesRequest();
        try {
            ShowAomMappingRulesResponse response = client.showAomMappingRules(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
# 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 = ShowAomMappingRulesRequest()
        response = client.show_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
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.ShowAomMappingRulesRequest{}
	response, err := client.ShowAomMappingRules(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

200

Details of all ingestion rules are returned.

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.