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

Updating Aggregation Configurations

Function

This API can be called only by administrators or delegated administrators to update aggregation configurations.

Calling Method

For details, see Calling APIs.

URI

PUT /v1/{project_id}/lts/log-converge-config

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.

Request Parameters

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

Table 3 Request body parameters

Parameter

Mandatory

Type

Description

id

No

String

ID

member_account_id

Yes

String

Account ID of an organization member.

member_project_id

No

String

Project ID of an organization member.

create_time

No

Long

Creation time.

update_time

No

Long

Update time.

status

No

String

Status.

organization_id

Yes

String

Organization ID.

management_account_id

Yes

String

Account ID of an administrator or delegated administrator.

management_project_id

Yes

String

Project ID of an administrator or delegated administrator.

version

No

String

Version.

log_mapping_config

No

Array of LogMappingConfig objects

Log aggregation configuration.

Table 4 LogMappingConfig

Parameter

Mandatory

Type

Description

source_log_group_id

Yes

String

Source log group ID.

target_log_group_id

No

String

Target log group ID.

target_log_group_name

Yes

String

Target log group name.

log_stream_config

No

Array of LogMappingStreamInfo objects

Log stream configuration.

Table 5 LogMappingStreamInfo

Parameter

Mandatory

Type

Description

source_log_stream_id

Yes

String

Source log stream ID.

target_log_stream_id

No

String

Target log stream ID.

target_log_stream_name

Yes

String

Target log stream name.

target_log_stream_eps_id

No

String

Target log stream EPS ID.

target_log_stream_ttl

Yes

Integer

Time to live (TTL) storage duration of the target log stream, in days.

Response Parameters

Status code: 200

Table 6 Response body parameters

Parameter

Type

Description

status

String

Update log aggregation configurations.

Example Requests

PUT https://{endpoint}/v1/{project_id}/lts/log-converge-config

{
  "management_account_id" : "115ba1c5fec44839820795ebefe25f2a",
  "management_project_id" : "a5baef478e6840dc9f454bbc00c996c6",
  "organization_id" : "o-fa9h4ghf0hnpfnq4xd02tah2nxmtugrf",
  "member_account_id" : "1d26cc8c86a840e28a4f8d0d07852f1d",
  "log_mapping_config" : [ {
    "source_log_group_id" : "21845482-07fc-440c-a26a-840e6cb12289",
    "target_log_group_id" : "",
    "target_log_group_name" : "lts-xxx_xx-xxx-test",
    "log_stream_config" : [ {
      "source_log_stream_id" : "72ece92e-af01-4216-aaa7-6df7a66465c7",
      "target_log_stream_eps_id" : "0",
      "target_log_stream_id" : "",
      "target_log_stream_name" : "lts_xxx_xxx_xxx_xxx",
      "target_log_stream_ttl" : 180
    } ]
  } ]
}

Example Responses

Status code: 200

Response body for updating aggregation configurations

{
  "status" : "creating"
}

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

    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();
        UpdateLogConvergeConfigRequest request = new UpdateLogConvergeConfigRequest();
        UpdatelogConvergeConfig body = new UpdatelogConvergeConfig();
        List<LogMappingStreamInfo> listLogMappingConfigLogStreamConfig = new ArrayList<>();
        listLogMappingConfigLogStreamConfig.add(
            new LogMappingStreamInfo()
                .withSourceLogStreamId("72ece92e-af01-4216-aaa7-6df7a66465c7")
                .withTargetLogStreamId("")
                .withTargetLogStreamName("lts_xxx_xxx_xxx_xxx")
                .withTargetLogStreamEpsId("0")
                .withTargetLogStreamTtl(180)
        );
        List<LogMappingConfig> listbodyLogMappingConfig = new ArrayList<>();
        listbodyLogMappingConfig.add(
            new LogMappingConfig()
                .withSourceLogGroupId("21845482-07fc-440c-a26a-840e6cb12289")
                .withTargetLogGroupId("")
                .withTargetLogGroupName("lts-xxx_xx-xxx-test")
                .withLogStreamConfig(listLogMappingConfigLogStreamConfig)
        );
        body.withLogMappingConfig(listbodyLogMappingConfig);
        body.withManagementProjectId("a5baef478e6840dc9f454bbc00c996c6");
        body.withManagementAccountId("115ba1c5fec44839820795ebefe25f2a");
        body.withOrganizationId("o-fa9h4ghf0hnpfnq4xd02tah2nxmtugrf");
        body.withMemberAccountId("1d26cc8c86a840e28a4f8d0d07852f1d");
        request.withBody(body);
        try {
            UpdateLogConvergeConfigResponse response = client.updateLogConvergeConfig(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
# 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 = UpdateLogConvergeConfigRequest()
        listLogStreamConfigLogMappingConfig = [
            LogMappingStreamInfo(
                source_log_stream_id="72ece92e-af01-4216-aaa7-6df7a66465c7",
                target_log_stream_id="",
                target_log_stream_name="lts_xxx_xxx_xxx_xxx",
                target_log_stream_eps_id="0",
                target_log_stream_ttl=180
            )
        ]
        listLogMappingConfigbody = [
            LogMappingConfig(
                source_log_group_id="21845482-07fc-440c-a26a-840e6cb12289",
                target_log_group_id="",
                target_log_group_name="lts-xxx_xx-xxx-test",
                log_stream_config=listLogStreamConfigLogMappingConfig
            )
        ]
        request.body = UpdatelogConvergeConfig(
            log_mapping_config=listLogMappingConfigbody,
            management_project_id="a5baef478e6840dc9f454bbc00c996c6",
            management_account_id="115ba1c5fec44839820795ebefe25f2a",
            organization_id="o-fa9h4ghf0hnpfnq4xd02tah2nxmtugrf",
            member_account_id="1d26cc8c86a840e28a4f8d0d07852f1d"
        )
        response = client.update_log_converge_config(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
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.UpdateLogConvergeConfigRequest{}
	targetLogStreamIdLogStreamConfig:= ""
	targetLogStreamEpsIdLogStreamConfig:= "0"
	var listLogStreamConfigLogMappingConfig = []model.LogMappingStreamInfo{
        {
            SourceLogStreamId: "72ece92e-af01-4216-aaa7-6df7a66465c7",
            TargetLogStreamId: &targetLogStreamIdLogStreamConfig,
            TargetLogStreamName: "lts_xxx_xxx_xxx_xxx",
            TargetLogStreamEpsId: &targetLogStreamEpsIdLogStreamConfig,
            TargetLogStreamTtl: int32(180),
        },
    }
	targetLogGroupIdLogMappingConfig:= ""
	var listLogMappingConfigbody = []model.LogMappingConfig{
        {
            SourceLogGroupId: "21845482-07fc-440c-a26a-840e6cb12289",
            TargetLogGroupId: &targetLogGroupIdLogMappingConfig,
            TargetLogGroupName: "lts-xxx_xx-xxx-test",
            LogStreamConfig: &listLogStreamConfigLogMappingConfig,
        },
    }
	request.Body = &model.UpdatelogConvergeConfig{
		LogMappingConfig: &listLogMappingConfigbody,
		ManagementProjectId: "a5baef478e6840dc9f454bbc00c996c6",
		ManagementAccountId: "115ba1c5fec44839820795ebefe25f2a",
		OrganizationId: "o-fa9h4ghf0hnpfnq4xd02tah2nxmtugrf",
		MemberAccountId: "1d26cc8c86a840e28a4f8d0d07852f1d",
	}
	response, err := client.UpdateLogConvergeConfig(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

Response body for updating aggregation configurations

Error Codes

See Error Codes.