Modifying an Ingestion Rule
Function
This API is used to modify an ingestion rule.
Calling Method
For details, see Calling APIs.
URI
PUT /v2/{project_id}/lts/aom-mapping
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 |
Request 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 |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
rule_id |
Yes |
String |
Ingestion rule ID. No default value. Minimum: 36 Maximum: 36 |
project_id |
Yes |
String |
Project ID. No default value. Minimum: 32 Maximum: 32 |
rule_name |
Yes |
String |
Ingestion rule name. No default value. Minimum: 1 Maximum: 100 |
rule_info |
Yes |
UpdateAomMappingRuleInfo object |
Ingestion rule details. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
cluster_id |
Yes |
String |
Cluster ID. |
cluster_name |
Yes |
String |
Cluster name. |
deployments |
Yes |
Array of strings |
Deployment. ALL_DEPLOYMENTS indicates all Deployments. During automatic mapping, all Deployments need to be listed. |
namespace |
Yes |
String |
Namespace. |
files |
Yes |
Array of AomMappingfilesInfo objects |
Log details. ALL_FILES indicates all logs. |
container_name |
No |
String |
Container name. |
deployments_prefix |
No |
String |
Available custom log stream prefix. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
file_name |
Yes |
String |
Path name. The matching rule is as follows: ^/[A-Za-z0-9.*_/-]+|stdout.log| (A maximum of two asterisks (**) are supported.) |
log_stream_info |
Yes |
Log stream information. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
target_log_group_id |
Yes |
String |
Log group ID. The ID must be valid. No default value. Minimum: 36 Maximum: 36 |
target_log_group_name |
Yes |
String |
Log group name. The log group name and ID cannot be empty at the same time. Minimum: 1 Maximum: 64 |
target_log_stream_id |
Yes |
String |
Log stream ID. The ID must be valid. No default value. Minimum: 36 Maximum: 36 |
target_log_stream_name |
Yes |
String |
Log stream name. The log stream name and ID cannot be empty at the same time. Minimum: 1 Maximum: 64 |
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
project_id |
String |
Project ID. |
rule_name |
String |
Ingestion rule name. |
rule_id |
String |
Ingestion rule ID. |
rule_info |
Ingestion rule details. |
Parameter |
Type |
Description |
---|---|---|
cluster_id |
String |
Cluster ID. |
cluster_name |
String |
Cluster name. |
deployments |
Array of strings |
Deployment. ALL_DEPLOYMENTS indicates all Deployments. NOTE:
During automatic mapping, all Deployments need to be listed. |
namespace |
String |
Namespace. |
files |
Array of UpdateAomMappingfilesInfos objects |
Log details. ALL_FILES indicates all logs. |
container_name |
String |
Container name. |
deployments_prefix |
String |
Available custom log stream prefix. |
Parameter |
Type |
Description |
---|---|---|
file_name |
String |
Path name. Matching rule: ^/[A-Za-z0-9._/-]+|stdout.log| Up to two asterisks () are allowed. |
log_stream_info |
Log stream details. |
Parameter |
Type |
Description |
---|---|---|
target_log_group_id |
String |
Log group ID. The ID must be valid. No default value. Minimum: 36 Maximum: 36 |
target_log_group_name |
String |
Log group name. The log group name and ID cannot be empty at the same time. Minimum: 1 Maximum: 64 |
target_log_stream_id |
String |
Log stream ID. The ID must be valid. No default value. Minimum: 36 Maximum: 36 |
target_log_stream_name |
String |
Log stream name. The log stream name and ID cannot be empty at the same time. Minimum: 1 Maximum: 64 |
Status code: 400
Parameter |
Type |
Description |
---|---|---|
code |
String |
Error code. Enumeration values:
|
details |
String |
Error message. Enumeration values:
|
Status code: 401
Parameter |
Type |
Description |
---|---|---|
message |
Message401 object |
Response message. |
Parameter |
Type |
Description |
---|---|---|
code |
String |
Error code. Enumeration values:
|
details |
String |
Error message. Enumeration values:
|
Status code: 403
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code. Enumeration values:
|
error_msg |
String |
Error message. Enumeration values:
|
Status code: 500
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code. Enumeration values:
|
error_msg |
String |
Error message. Enumeration values:
|
Example Requests
Modifying an ingestion rule
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" } } ] } }
Example Responses
Status code: 200
The ingestion rule is modified.
{ "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" : "" } } ] } }
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.
Modifying 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 |
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()); } } } |
Modifying 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 |
# 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 = 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) |
Modifying 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 |
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) } } |
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 |
The ingestion rule is modified. |
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.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot