# 修改接入规则 - UpdateAomMappingRules #### 功能介绍 该接口用于修改接入规则 #### 调用方法 请参见[如何调用API](https://support.huaweicloud.com/api-lts/lts_api_0003.html)。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。 - 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-lts/lts_api_0046.html)。 - 如果使用身份策略授权，需具备如下身份策略权限。 | 授权项 | 访问级别 | 资源类型（\*为必须） | 条件键 | 别名 | 依赖的授权项 | |:---|:---|:---|:---|:---|:---| | lts:mappingRule:update | Write | - | - | lts:topics:put | - | #### URI PUT /v2/{project_id}/lts/aom-mapping 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 是 | String | 项目ID，可以从调用API处获取，也可以从控制台获取。获取方式请参见：[获取项目ID](https://support.huaweicloud.com/api-lts/lts_api_0006.html)。 | #### 请求参数 表2请求Header参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | X-Auth-Token | 是 | String | **参数解释：** 从IAM服务获取的用户Token，获取方式请参见：[获取用户Token](https://support.huaweicloud.com/api-lts/lts_api_0004.html)。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | | Content-Type | 是 | String | **参数解释：** 用于定义消息体的格式，该字段填为：application/json;charset=utf8。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | 表3请求Body参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | rule_id | 是 | String | **参数解释：** 接入规则ID。 **约束限制：** 不涉及 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | | project_id | 是 | String | **参数解释：** 项目ID，获取方式请参见：[获取项目ID](https://support.huaweicloud.com/api-lts/lts_api_0006.html)。 **约束限制：** 长度固定为32个字符。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | | rule_name | 是 | String | **参数解释：** 接入规则名称。 **约束限制：** 不涉及。 **取值范围：** 1-100。 **默认取值：** 不涉及。 | | rule_info | 是 | [UpdateAomMappingRuleInfo] object | **参数解释：** 接入规则详情。 **约束限制：** 不涉及。 | 表4UpdateAomMappingRuleInfo | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | 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 | **参数解释：** 可选择的自定义日志流前缀。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | 表5AomMappingfilesInfo | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | file_name | 是 | String | **参数解释：** 路径名称。 **约束限制：** 匹配规则：\^/\[A-Za-z0-9.\*_/-\]+\|stdout.log\|，最多两个\*\*。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | | log_stream_info | 是 | [UpdateAomMappingLogStreamInfo] object | **参数解释：** 日志流信息。 **约束限制：** 不涉及。 | 表6UpdateAomMappingLogStreamInfo | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | target_log_group_id | 是 | String | 日志组ID。日志组ID不为空时，必须有效。 | | target_log_group_name | 是 | String | 日志组名称。日志组名称与ID不能同时为空。 | | target_log_stream_id | 是 | String | 日志流ID。日志流ID不为空时，必须有效。 | | target_log_stream_name | 是 | String | 日志流名称。日志流名称与ID不能同时为空。 | #### 响应参数 **状态码：200** 表7响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | project_id | String | **参数解释：** 项目ID。 **取值范围：** 不涉及。 | | rule_name | String | **参数解释：** 接入规则名称。 **取值范围：** 不涉及。 | | rule_id | String | **参数解释：** 接入规则ID。 **取值范围：** 不涉及。 | | rule_info | [UpdateAomMappingRuleInfoRespBody] object | **参数解释：** 接入规则详情。 | 表8UpdateAomMappingRuleInfoRespBody | 参数 | 参数类型 | 描述 | |:---|:---|:---| | cluster_id | String | **参数解释：** 集群ID。 **取值范围：** 不涉及。 | | cluster_name | String | **参数解释：** 集群名称。 **取值范围：** 不涉及。 | | deployments | Array of strings | **参数解释：** 工作负载。 **取值范围：** 不涉及。 | | namespace | String | **参数解释：** 命名空间。 **取值范围：** 不涉及。 | | files | Array of [UpdateAomMappingfilesInfos] objects | **参数解释：** 日志详细。 | | container_name | String | **参数解释：** 容器名称。 **取值范围：** 不涉及。 | | deployments_prefix | String | **参数解释：** 可选择的自定义日志流前缀。 **取值范围：** 不涉及。 | 表9UpdateAomMappingfilesInfos | 参数 | 参数类型 | 描述 | |:---|:---|:---| | file_name | String | **参数解释：** 路径名称。 **取值范围：** 不涉及。 | | log_stream_info | [UpdateAomMappingLogStreamInfos] object | **参数解释：** 日志流信息。 | 表10UpdateAomMappingLogStreamInfos | 参数 | 参数类型 | 描述 | |:---|:---|:---| | target_log_group_id | String | **参数解释：** 日志组ID。 **取值范围：** 不涉及。 | | target_log_group_name | String | **参数解释：** 日志组名称。 **取值范围：** 不涉及。 | | target_log_stream_id | String | **参数解释：** 日志流ID。 **取值范围：** 不涉及。 | | target_log_stream_name | String | **参数解释：** 日志流名称。 **取值范围：** 不涉及。 | **状态码：400** 表11响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | code | String | 错误码。 | | details | String | 调用失败响应信息描述。 | **状态码：401** 表12响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | message | [Message401] object | 接口调用信息。 | 表13Message401 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | code | String | 错误码。 | | details | String | 调用失败响应信息描述。 | **状态码：403** 表14响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | **参数解释：** 错误码，请参见：[错误码](https://support.huaweicloud.com/api-lts/ErrorCode.html)。 **取值范围：** 不涉及。 | | error_msg | String | **参数解释：** 调用失败响应信息描述。 **取值范围：** 不涉及。 | **状态码：500** 表15响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | **参数解释：** 错误码，请参见：[错误码](https://support.huaweicloud.com/api-lts/ErrorCode.html)。 **取值范围：** 不涉及。 | | error_msg | String | **参数解释：** 调用失败响应信息描述。 **取值范围：** 不涉及。 | #### 请求示例 修改接入规则 ``` 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** 非法请求。 ``` { "code" : "LTS.0014", "details" : "Operation DB failed" } ``` **状态码：401** 鉴权失败, 请确认token后再次请求 。 ``` { "message" : { "code" : "LTS.0414", "details" : "Invalid token" } } ``` **状态码：403** 请求被拒绝访问。返回该状态码，表明请求能够到达服务端，且服务端能够理解用户请求，但是拒绝做更多的事情，因为该请求被设置为拒绝访问，建议直接修改该请求，不要重试该请求。 ``` { "error_code" : "LTS.0003", "error_msg" : "parse_token_failed" } ``` **状态码：500** 表明服务端能被请求访问到，但是服务内部出错。 ``` { "error_code" : "LTS.0102", "error_msg" : "ServiceUnavailable." } ``` #### SDK代码示例 SDK代码示例如下。 - [Java] 修改接入规则 ``` 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"); String projectId = "{project_id}"; ICredential auth = new BasicCredentials() .withProjectId(projectId) .withAk(ak) .withSk(sk); LtsClient client = LtsClient.newBuilder() .withCredential(auth) .withRegion(LtsRegion.valueOf("")) .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 listRuleInfoFiles = new ArrayList<>(); listRuleInfoFiles.add( new AomMappingfilesInfo() .withFileName("__ALL_FILES__") .withLogStreamInfo(logStreamInfoFiles) ); List 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()); } } } ``` - [Python] 修改接入规则 ``` # 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("")) \ .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) ``` - [Go] 修改接入规则 ``` 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, err := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). WithProjectId(projectId). SafeBuild() if err != nil { fmt.Println(err) return } hcClient, err := lts.LtsClientBuilder(). WithRegion(region.ValueOf("")). WithCredential(auth). SafeBuild() if err != nil { fmt.Println(err) return } client := lts.NewLtsClient(hcClient) 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](https://console.huaweicloud.com/apiexplorer/#/openapi/LTS/sdk?api=UpdateAomMappingRules)的代码示例页签，可生成自动对应的SDK代码示例。 #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | 请求响应成功, 成功更新接入配置 | | 400 | 非法请求。 | | 401 | 鉴权失败, 请确认token后再次请求 。 | | 403 | 请求被拒绝访问。返回该状态码，表明请求能够到达服务端，且服务端能够理解用户请求，但是拒绝做更多的事情，因为该请求被设置为拒绝访问，建议直接修改该请求，不要重试该请求。 | | 500 | 表明服务端能被请求访问到，但是服务内部出错。 | | 503 | 被请求的服务无效,服务不可用。 | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-lts/ErrorCode.html)。