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

Configuring LTS for WAF Logging

Function

This API is used to enable or disable Log Tank Service (LTS) for WAF logging and to configure log groups and streams. You can obtain the log group ID and log stream ID from LTS. The log stream ID must belong to the log group you configure.

Calling Method

For details, see Calling APIs.

URI

PUT /v1/{project_id}/waf/config/lts/{ltsconfig_id}

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID. To obtain it, go to Huawei Cloud management console and hover the cursor over your username. On the displayed window, choose My Credentials. Then, in the Projects area, view Project ID of the corresponding project.

ltsconfig_id

Yes

String

ID of the LTS configuration. The ID can be obtained by calling the ShowLtsInfoConfig API.

Table 2 Query Parameters

Parameter

Mandatory

Type

Description

enterprise_project_id

No

String

You can obtain the ID by calling the ListEnterpriseProject API of EPS.

Request Parameters

Table 3 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

User token. It can be obtained by calling the IAM API (value of X-Subject-Token in the response header).

Content-Type

Yes

String

Content type.

Table 4 Request body parameters

Parameter

Mandatory

Type

Description

enabled

No

Boolean

Whether to enable LTS for WAF logging

  • false: LTS is disabled for WAF.

  • true: LTS is enabled for WAF.

ltsIdInfo

No

LtsIdInfo object

Log group and log stream IDs.

enabale

No

Boolean

This parameter has been discarded. Ignore it.

Table 5 LtsIdInfo

Parameter

Mandatory

Type

Description

ltsGroupId

No

String

Log group ID.

ltsAccessStreamID

No

String

Log stream ID for access logs.

ltsAttackStreamID

No

String

Log stream ID for attack logs.

Response Parameters

Status code: 200

Table 6 Response body parameters

Parameter

Type

Description

id

String

LTS configuration information ID. Each enterprise project has a unique ID.

enabled

Boolean

Whether to enable LTS for WAF logging

  • false: LTS is disabled for WAF.

  • true: LTS is enabled for WAF.

ltsIdInfo

LtsIdInfo object

Log group and log stream IDs.

enabale

Boolean

This parameter has been discarded. Ignore it.

Table 7 LtsIdInfo

Parameter

Type

Description

ltsGroupId

String

Log group ID.

ltsAccessStreamID

String

Log stream ID for access logs.

ltsAttackStreamID

String

Log stream ID for attack logs.

Status code: 400

Table 8 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

encoded_authorization_message

String

You can call the decode-authorization-message interface of the STS service to decode the rejection reason. For details, see the STS5 joint commissioning and self-verification. This parameter is returned only when an IAM 5 authentication error occurs.

details

Array of IAM5ErrorDetails objects

The set of error messages reported when a downstream service is invoked. This parameter is returned only when an IAM 5 authentication error occurs.

Table 9 IAM5ErrorDetails

Parameter

Type

Description

error_code

String

Error codes of the downstream service.

error_msg

String

Error messages of the downstream service.

Status code: 401

Table 10 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

encoded_authorization_message

String

You can call the decode-authorization-message interface of the STS service to decode the rejection reason. For details, see the STS5 joint commissioning and self-verification. This parameter is returned only when an IAM 5 authentication error occurs.

details

Array of IAM5ErrorDetails objects

The set of error messages reported when a downstream service is invoked. This parameter is returned only when an IAM 5 authentication error occurs.

Table 11 IAM5ErrorDetails

Parameter

Type

Description

error_code

String

Error codes of the downstream service.

error_msg

String

Error messages of the downstream service.

Status code: 500

Table 12 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

encoded_authorization_message

String

You can call the decode-authorization-message interface of the STS service to decode the rejection reason. For details, see the STS5 joint commissioning and self-verification. This parameter is returned only when an IAM 5 authentication error occurs.

details

Array of IAM5ErrorDetails objects

The set of error messages reported when a downstream service is invoked. This parameter is returned only when an IAM 5 authentication error occurs.

Table 13 IAM5ErrorDetails

Parameter

Type

Description

error_code

String

Error codes of the downstream service.

error_msg

String

Error messages of the downstream service.

Example Requests

The following example shows how to update the LTS configuration in a project. The project ID is specified by project_id. The new LTS configuration ID is c89a667487734f6a95e9967d1f373c77. LTS for WAF logging is enabled. Log group ID: 4bcff74d-f649-41c8-8325-1b0a264ff683. Access log stream ID: 0a7ef713-cc3e-418d-abda-85df04db1a3c. Attack log stream ID: f4fa07f6-277b-4e4a-a257-26508ece81e6

PUT https://{Endpoint}/v1/{project_id}/waf/config/lts/c89a667487734f6a95e9967d1f373c77?enterprise_project_id=0

{
  "enabled" : true,
  "ltsIdInfo" : {
    "ltsAccessStreamID" : "4bcff74d-f649-41c8-8325-1b0a264ff683",
    "ltsAttackStreamID" : "0a7ef713-cc3e-418d-abda-85df04db1a3c",
    "ltsGroupId" : "f4fa07f6-277b-4e4a-a257-26508ece81e6"
  }
}

Example Responses

Status code: 200

Request succeeded.

{
  "enabled" : true,
  "id" : "c89a667487734f6a95e9967d1f373c77",
  "ltsIdInfo" : {
    "ltsAccessStreamID" : "4bcff74d-f649-41c8-8325-1b0a264ff683",
    "ltsAttackStreamID" : "0a7ef713-cc3e-418d-abda-85df04db1a3c",
    "ltsGroupId" : "f4fa07f6-277b-4e4a-a257-26508ece81e6"
  }
}

SDK Sample Code

The SDK sample code is as follows.

The following example shows how to update the LTS configuration in a project. The project ID is specified by project_id. The new LTS configuration ID is c89a667487734f6a95e9967d1f373c77. LTS for WAF logging is enabled. Log group ID: 4bcff74d-f649-41c8-8325-1b0a264ff683. Access log stream ID: 0a7ef713-cc3e-418d-abda-85df04db1a3c. Attack log stream ID: f4fa07f6-277b-4e4a-a257-26508ece81e6

 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
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.waf.v1.region.WafRegion;
import com.huaweicloud.sdk.waf.v1.*;
import com.huaweicloud.sdk.waf.v1.model.*;


public class UpdateLtsInfoConfigSolution {

    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);

        WafClient client = WafClient.newBuilder()
                .withCredential(auth)
                .withRegion(WafRegion.valueOf("<YOUR REGION>"))
                .build();
        UpdateLtsInfoConfigRequest request = new UpdateLtsInfoConfigRequest();
        request.withLtsconfigId("{ltsconfig_id}");
        UpdateLtsInfoConfigRequestBody body = new UpdateLtsInfoConfigRequestBody();
        LtsIdInfo ltsIdInfobody = new LtsIdInfo();
        ltsIdInfobody.withLtsGroupId("f4fa07f6-277b-4e4a-a257-26508ece81e6")
            .withLtsAccessStreamID("4bcff74d-f649-41c8-8325-1b0a264ff683")
            .withLtsAttackStreamID("0a7ef713-cc3e-418d-abda-85df04db1a3c");
        body.withLtsIdInfo(ltsIdInfobody);
        body.withEnabled(true);
        request.withBody(body);
        try {
            UpdateLtsInfoConfigResponse response = client.updateLtsInfoConfig(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());
        }
    }
}

The following example shows how to update the LTS configuration in a project. The project ID is specified by project_id. The new LTS configuration ID is c89a667487734f6a95e9967d1f373c77. LTS for WAF logging is enabled. Log group ID: 4bcff74d-f649-41c8-8325-1b0a264ff683. Access log stream ID: 0a7ef713-cc3e-418d-abda-85df04db1a3c. Attack log stream ID: f4fa07f6-277b-4e4a-a257-26508ece81e6

 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
# coding: utf-8

import os
from huaweicloudsdkcore.auth.credentials import BasicCredentials
from huaweicloudsdkwaf.v1.region.waf_region import WafRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdkwaf.v1 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 = WafClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(WafRegion.value_of("<YOUR REGION>")) \
        .build()

    try:
        request = UpdateLtsInfoConfigRequest()
        request.ltsconfig_id = "{ltsconfig_id}"
        ltsIdInfobody = LtsIdInfo(
            lts_group_id="f4fa07f6-277b-4e4a-a257-26508ece81e6",
            lts_access_stream_id="4bcff74d-f649-41c8-8325-1b0a264ff683",
            lts_attack_stream_id="0a7ef713-cc3e-418d-abda-85df04db1a3c"
        )
        request.body = UpdateLtsInfoConfigRequestBody(
            lts_id_info=ltsIdInfobody,
            enabled=True
        )
        response = client.update_lts_info_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)

The following example shows how to update the LTS configuration in a project. The project ID is specified by project_id. The new LTS configuration ID is c89a667487734f6a95e9967d1f373c77. LTS for WAF logging is enabled. Log group ID: 4bcff74d-f649-41c8-8325-1b0a264ff683. Access log stream ID: 0a7ef713-cc3e-418d-abda-85df04db1a3c. Attack log stream ID: f4fa07f6-277b-4e4a-a257-26508ece81e6

 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
package main

import (
	"fmt"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic"
    waf "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/waf/v1"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/waf/v1/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/waf/v1/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 := waf.NewWafClient(
        waf.WafClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

    request := &model.UpdateLtsInfoConfigRequest{}
	request.LtsconfigId = "{ltsconfig_id}"
	ltsGroupIdLtsIdInfo:= "f4fa07f6-277b-4e4a-a257-26508ece81e6"
	ltsAccessStreamIDLtsIdInfo:= "4bcff74d-f649-41c8-8325-1b0a264ff683"
	ltsAttackStreamIDLtsIdInfo:= "0a7ef713-cc3e-418d-abda-85df04db1a3c"
	ltsIdInfobody := &model.LtsIdInfo{
		LtsGroupId: &ltsGroupIdLtsIdInfo,
		LtsAccessStreamID: &ltsAccessStreamIDLtsIdInfo,
		LtsAttackStreamID: &ltsAttackStreamIDLtsIdInfo,
	}
	enabledUpdateLtsInfoConfigRequestBody:= true
	request.Body = &model.UpdateLtsInfoConfigRequestBody{
		LtsIdInfo: ltsIdInfobody,
		Enabled: &enabledUpdateLtsInfoConfigRequestBody,
	}
	response, err := client.UpdateLtsInfoConfig(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

Request succeeded.

400

Request failed.

401

The token does not have required permissions.

500

Internal server error.

Error Codes

See Error Codes.