更新时间:2024-02-06 GMT+08:00
分享

修改接入规则

功能介绍

该接口用于修改接入规则

调用方法

请参见如何调用API

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

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

缺省值:None

最小长度:32

最大长度:32

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

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

缺省值:None

最小长度:1000

最大长度:2000

Content-Type

String

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

缺省值:None

最小长度:30

最大长度:30

表3 请求Body参数

参数

是否必选

参数类型

描述

rule_id

String

接入规则id 缺省值:None

最小长度:36

最大长度:36

project_id

String

项目id 缺省值:None

最小长度:32

最大长度:32

rule_name

String

接入规则名称 缺省值:None

最小长度:1

最大长度:100

rule_info

UpdateAomMappingRuleInfo object

接入规则详情

表4 UpdateAomMappingRuleInfo

参数

是否必选

参数类型

描述

cluster_id

String

集群ID。

cluster_name

String

集群名称。

deployments

Array of strings

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

说明:

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

namespace

String

命名空间。

files

Array of AomMappingfilesInfo objects

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

container_name

String

容器名称

deployments_prefix

String

可选择的自定义日志流前缀

表5 AomMappingfilesInfo

参数

是否必选

参数类型

描述

file_name

String

路径名,匹配规则:^/[A-Za-z0-9.*_/-]+|stdout.log|最多两个**

log_stream_info

UpdateAomMappingLogStreamInfo object

日志流信息日志详细。

表6 UpdateAomMappingLogStreamInfo

参数

是否必选

参数类型

描述

target_log_group_id

String

日志组ID。日志组ID不为空时,必须有效。

缺省值:None

最小长度:36

最大长度:36

target_log_group_name

String

日志组名称。日志组名称与ID不能同时为空。

最小长度:1

最大长度:64

target_log_stream_id

String

日志流ID。日志流ID不为空时,必须有效。

缺省值:None

最小长度:36

最大长度:36

target_log_stream_name

String

日志流名称。日志流名称与ID不能同时为空。

最小长度:1

最大长度:64

响应参数

状态码: 200

表7 响应Body参数

参数

参数类型

描述

project_id

String

项目id

rule_name

String

接入规则名称

rule_id

String

接入规则id

rule_info

UpdateAomMappingRuleInfoRespBody object

接入规则详情

表8 UpdateAomMappingRuleInfoRespBody

参数

参数类型

描述

cluster_id

String

集群ID。

cluster_name

String

集群名称。

deployments

Array of strings

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

说明:

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

namespace

String

命名空间。

files

Array of UpdateAomMappingfilesInfos objects

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

container_name

String

容器名称

deployments_prefix

String

可选择的自定义日志流前缀

表9 UpdateAomMappingfilesInfos

参数

参数类型

描述

file_name

String

路径名称。 匹配规则:^/[A-Za-z0-9.*_/-]+|stdout.log| 最多两个**

log_stream_info

UpdateAomMappingLogStreamInfos object

日志流信息日志详细。

表10 UpdateAomMappingLogStreamInfos

参数

参数类型

描述

target_log_group_id

String

日志组ID。日志组ID不为空时,必须有效。

缺省值:None

最小长度:36

最大长度:36

target_log_group_name

String

日志组名称。日志组名称与ID不能同时为空。

最小长度:1

最大长度:64

target_log_stream_id

String

日志流ID。日志流ID不为空时,必须有效。 缺省值:None

最小长度:36

最大长度:36

target_log_stream_name

String

日志流名称。日志流名称与ID不能同时为空。

最小长度:1

最大长度:64

状态码: 400

表11 响应Body参数

参数

参数类型

描述

code

String

错误码。

枚举值:

  • LTS.0742

  • LTS.0743

  • LTS.0014

  • LTS.0740

  • LTS.0744

  • LTS.0746

details

String

调用失败响应信息描述。

枚举值:

  • 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

状态码: 401

表12 响应Body参数

参数

参数类型

描述

massage

Massage401 object

接口调用信息。

表13 Massage401

参数

参数类型

描述

code

String

错误码。

枚举值:

  • LTS.0001

details

String

调用失败响应信息描述。

枚举值:

  • project verify error

状态码: 403

表14 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

枚举值:

  • LTS.0403

error_msg

String

调用失败响应信息描述。

枚举值:

  • Invalid projectId

状态码: 500

表15 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

枚举值:

  • LTS.0403

error_msg

String

调用失败响应信息描述。

枚举值:

  • Invalid projectId

请求示例

修改接入规则

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

{
  "rule_id" : "",
  "rule_name" : "abcde",
  "project_id" : "2a473356cca5487f8373be891bffc1cf",
  "rule_info" : {
    "cluster_id" : "4fae3587-0202-11eb-9ba9-0255ac100b02",
    "cluster_name" : "testdiskrate",
    "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"
      }
    } ]
  }
}

响应示例

状态码: 200

请求响应成功, 成功更新接入配置

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

状态码: 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
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 UpdateAomMappingRulesSolution {

    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();
        UpdateAomMappingRulesRequest request = new UpdateAomMappingRulesRequest();
        UpdateAomMappingRequest body = new UpdateAomMappingRequest();
        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")
            .withDeployments(listRuleInfoDeployments)
            .withNamespace("default")
            .withContainerName("container-0")
            .withFiles(listRuleInfoFiles);
        body.withRuleInfo(ruleInfobody);
        body.withRuleName("abcde");
        body.withProjectId("2a473356cca5487f8373be891bffc1cf");
        body.withRuleId("");
        request.withBody(body);
        try {
            UpdateAomMappingRulesResponse response = client.updateAomMappingRules(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
# coding: utf-8

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 = __import__('os').getenv("CLOUD_SDK_AK")
    sk = __import__('os').getenv("CLOUD_SDK_SK")

    credentials = BasicCredentials(ak, sk) \

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

    try:
        request = UpdateAomMappingRulesRequest()
        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=listDeploymentsRuleInfo,
            namespace="default",
            container_name="container-0",
            files=listFilesRuleInfo
        )
        request.body = UpdateAomMappingRequest(
            rule_info=ruleInfobody,
            rule_name="abcde",
            project_id="2a473356cca5487f8373be891bffc1cf",
            rule_id=""
        )
        response = client.update_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
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.UpdateAomMappingRulesRequest{}
	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__",
    }
	containerNameRuleInfo:= "container-0"
	ruleInfobody := &model.AomMappingRuleInfo{
		ClusterId: "4fae3587-0202-11eb-9ba9-0255ac100b02",
		ClusterName: "testdiskrate",
		Deployments: listDeploymentsRuleInfo,
		Namespace: "default",
		ContainerName: &containerNameRuleInfo,
		Files: listFilesRuleInfo,
	}
	request.Body = &model.UpdateAomMappingRequest{
		RuleInfo: ruleInfobody,
		RuleName: "abcde",
		ProjectId: "2a473356cca5487f8373be891bffc1cf",
		RuleId: "",
	}
	response, err := client.UpdateAomMappingRules(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

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

状态码

状态码

描述

200

请求响应成功, 成功更新接入配置

400

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

401

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

403

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

500

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

503

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

错误码

请参见错误码

分享:

    相关文档

    相关产品