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

Add Log Config

Function

This API is used to add log config.

Calling Method

For details, see Calling APIs.

URI

POST /v1/{project_id}/cfw/logs/configuration

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID

Table 2 Query Parameters

Parameter

Mandatory

Type

Description

fw_instance_id

Yes

String

Firewall instance ID, which is automatically generated after a CFW instance is created. You can obtain the ID by calling the API used for querying a firewall instance. For details, see the API Explorer and Help Center FAQ.By default, if fw_instance_Id is not specified, information about the first firewall under the account is returned. If fw_instance_Id is specified, information about the firewall with this fw_instance_Id is returned.If object_Id is specified, information about the firewall with this object_Id is returned by default. If both fw_instance_Id and object_Id are specified, the specified object_Id must belong to the specified firewall.

enterprise_project_id

No

String

Enterprise project id, the id generated by the enterprise project after the user supports the enterprise project.

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 used to obtain a user token. The value of X-Subject-Token in the response header is a token.

Table 4 Request body parameters

Parameter

Mandatory

Type

Description

fw_instance_id

Yes

String

Firewall instance ID, which is automatically generated after a CFW instance is created. You can obtain the ID by calling the API used for querying a firewall instance. For details, see the API Explorer and Help Center FAQ.By default, if fw_instance_Id is not specified, information about the first firewall under the account is returned. If fw_instance_Id is specified, information about the firewall with this fw_instance_Id is returned.If object_Id is specified, information about the firewall with this object_Id is returned by default. If both fw_instance_Id and object_Id are specified, the specified object_Id must belong to the specified firewall.

lts_enable

Yes

Integer

whether to enable LTS

lts_log_group_id

Yes

String

Lts log group id

lts_attack_log_stream_id

No

String

Lts attack log stream id

lts_attack_log_stream_enable

Yes

Integer

whether to enable attack log streaming

lts_access_log_stream_id

No

String

Lts access log stream id

lts_access_log_stream_enable

Yes

Integer

whether to enable access log streaming

lts_flow_log_stream_id

No

String

Lts flow log stream id

lts_flow_log_stream_enable

Yes

Integer

whether to enable flow log streaming

Response Parameters

Status code: 200

Table 5 Response body parameters

Parameter

Type

Description

data

String

Add Log Config Response Body

Example Requests

Add a log flow configuration to the firewall whose firewall instance id is 4d6c860a-0338-49e8-ac64-fcaeb4182ba5 and project id is 408972e72dcd4c1a9b033e955802a36b with LTS group ID 20282428-a8f9-4e75-8246-165e64cf8ba8, and the access control log flow is disabled, the traffic log flow is disabled, the attack log flow is disabled, and the LTS is disabled.

https://{Endpoint}/v1/408972e72dcd4c1a9b033e955802a36b/cfw/logs/configuration?fw_instance_id=4d6c860a-0338-49e8-ac64-fcaeb4182ba5&enterprise_project_id=default

{
  "fw_instance_id" : "4d6c860a-0338-49e8-ac64-fcaeb4182ba5",
  "lts_enable" : 0,
  "lts_log_group_id" : "20282428-a8f9-4e75-8246-165e64cf8ba8",
  "lts_attack_log_stream_enable" : 0,
  "lts_access_log_stream_enable" : 0,
  "lts_flow_log_stream_enable" : 0
}

Example Responses

Status code: 200

Add Log Config Response

{
  "data" : "4d6c860a-0338-49e8-ac64-fcaeb4182ba5"
}

SDK Sample Code

The SDK sample code is as follows.

Java

Add a log flow configuration to the firewall whose firewall instance id is 4d6c860a-0338-49e8-ac64-fcaeb4182ba5 and project id is 408972e72dcd4c1a9b033e955802a36b with LTS group ID 20282428-a8f9-4e75-8246-165e64cf8ba8, and the access control log flow is disabled, the traffic log flow is disabled, the attack log flow is disabled, and the LTS is disabled.

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


public class AddLogConfigSolution {

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

        CfwClient client = CfwClient.newBuilder()
                .withCredential(auth)
                .withRegion(CfwRegion.valueOf("<YOUR REGION>"))
                .build();
        AddLogConfigRequest request = new AddLogConfigRequest();
        request.withFwInstanceId("<fw_instance_id>");
        request.withEnterpriseProjectId("<enterprise_project_id>");
        LogConfigDto body = new LogConfigDto();
        body.withLtsFlowLogStreamEnable(0);
        body.withLtsAccessLogStreamEnable(0);
        body.withLtsAttackLogStreamEnable(0);
        body.withLtsLogGroupId("20282428-a8f9-4e75-8246-165e64cf8ba8");
        body.withLtsEnable(0);
        body.withFwInstanceId("4d6c860a-0338-49e8-ac64-fcaeb4182ba5");
        request.withBody(body);
        try {
            AddLogConfigResponse response = client.addLogConfig(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

Add a log flow configuration to the firewall whose firewall instance id is 4d6c860a-0338-49e8-ac64-fcaeb4182ba5 and project id is 408972e72dcd4c1a9b033e955802a36b with LTS group ID 20282428-a8f9-4e75-8246-165e64cf8ba8, and the access control log flow is disabled, the traffic log flow is disabled, the attack log flow is disabled, and the LTS is disabled.

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

from huaweicloudsdkcore.auth.credentials import BasicCredentials
from huaweicloudsdkcfw.v1.region.cfw_region import CfwRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdkcfw.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 = __import__('os').getenv("CLOUD_SDK_AK")
    sk = __import__('os').getenv("CLOUD_SDK_SK")

    credentials = BasicCredentials(ak, sk) \

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

    try:
        request = AddLogConfigRequest()
        request.fw_instance_id = "<fw_instance_id>"
        request.enterprise_project_id = "<enterprise_project_id>"
        request.body = LogConfigDto(
            lts_flow_log_stream_enable=0,
            lts_access_log_stream_enable=0,
            lts_attack_log_stream_enable=0,
            lts_log_group_id="20282428-a8f9-4e75-8246-165e64cf8ba8",
            lts_enable=0,
            fw_instance_id="4d6c860a-0338-49e8-ac64-fcaeb4182ba5"
        )
        response = client.add_log_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)

Go

Add a log flow configuration to the firewall whose firewall instance id is 4d6c860a-0338-49e8-ac64-fcaeb4182ba5 and project id is 408972e72dcd4c1a9b033e955802a36b with LTS group ID 20282428-a8f9-4e75-8246-165e64cf8ba8, and the access control log flow is disabled, the traffic log flow is disabled, the attack log flow is disabled, and the LTS is disabled.

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

import (
	"fmt"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic"
    cfw "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/cfw/v1"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/cfw/v1/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/cfw/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")

    auth := basic.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        Build()

    client := cfw.NewCfwClient(
        cfw.CfwClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

    request := &model.AddLogConfigRequest{}
	request.FwInstanceId = "<fw_instance_id>"
	enterpriseProjectIdRequest:= "<enterprise_project_id>"
	request.EnterpriseProjectId = &enterpriseProjectIdRequest
	request.Body = &model.LogConfigDto{
		LtsFlowLogStreamEnable: int32(0),
		LtsAccessLogStreamEnable: int32(0),
		LtsAttackLogStreamEnable: int32(0),
		LtsLogGroupId: "20282428-a8f9-4e75-8246-165e64cf8ba8",
		LtsEnable: int32(0),
		FwInstanceId: "4d6c860a-0338-49e8-ac64-fcaeb4182ba5",
	}
	response, err := client.AddLogConfig(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

More

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

Add Log Config Response

Error Codes

See Error Codes.