更新时间:2024-11-08 GMT+08:00

配置全量日志lts

功能介绍

配置全量日志lts,该接口可用来开启与关闭waf全量日志以及配置日志组和日志流。日志组id和日志流id可前往云日志服务获取。配置的日志流id要属于所配置的日志组。

调用方法

请参见如何调用API

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

项目ID,对应控制台用户名->我的凭证->项目列表->项目ID

ltsconfig_id

String

lts配置信息id,通过ShowLtsInfoConfig获取

表2 Query参数

参数

是否必选

参数类型

描述

enterprise_project_id

String

您可以通过调用企业项目管理服务(EPS)的查询企业项目列表接口(ListEnterpriseProject)查询企业项目id

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户Token,通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。

Content-Type

String

内容类型

表4 请求Body参数

参数

是否必选

参数类型

描述

enabled

Boolean

是否开启全量日志

  • false: 不开启

  • true: 开启

ltsIdInfo

LtsIdInfo object

日志组与日志流id信息

enabale

Boolean

该参数废弃,请忽略

表5 LtsIdInfo

参数

是否必选

参数类型

描述

ltsGroupId

String

日志组id

ltsAccessStreamID

String

访问日志流id

ltsAttackStreamID

String

攻击日志流id

响应参数

状态码: 200

表6 响应Body参数

参数

参数类型

描述

id

String

lts配置信息id

enabled

Boolean

是否开启全量日志

  • false: 不开启

  • true: 开启

ltsIdInfo

LtsIdInfo object

日志组与日志流id信息

enabale

Boolean

该参数已废弃,请忽略

表7 LtsIdInfo

参数

参数类型

描述

ltsGroupId

String

日志组id

ltsAccessStreamID

String

访问日志流id

ltsAttackStreamID

String

攻击日志流id

状态码: 400

表8 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误信息

encoded_authorization_message

String

编码 (加密) 后的详细拒绝原因,用户可以自行调用 STS 服务的decode-authorization-message接口进行解码,可参考STS5联调自验证。IAM5鉴权错误时才会返回此字段。

details

Array of IAM5ErrorDetails objects

调用下游服务的报错信息集合,IAM5鉴权错误时才会返回此字段。

表9 IAM5ErrorDetails

参数

参数类型

描述

error_code

String

下游服务错误码

error_msg

String

下游服务报错信息

状态码: 401

表10 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误信息

encoded_authorization_message

String

编码 (加密) 后的详细拒绝原因,用户可以自行调用 STS 服务的decode-authorization-message接口进行解码,可参考STS5联调自验证。IAM5鉴权错误时才会返回此字段。

details

Array of IAM5ErrorDetails objects

调用下游服务的报错信息集合,IAM5鉴权错误时才会返回此字段。

表11 IAM5ErrorDetails

参数

参数类型

描述

error_code

String

下游服务错误码

error_msg

String

下游服务报错信息

状态码: 500

表12 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误信息

encoded_authorization_message

String

编码 (加密) 后的详细拒绝原因,用户可以自行调用 STS 服务的decode-authorization-message接口进行解码,可参考STS5联调自验证。IAM5鉴权错误时才会返回此字段。

details

Array of IAM5ErrorDetails objects

调用下游服务的报错信息集合,IAM5鉴权错误时才会返回此字段。

表13 IAM5ErrorDetails

参数

参数类型

描述

error_code

String

下游服务错误码

error_msg

String

下游服务报错信息

请求示例

更新项目id为project_id,lts配置信息id为c89a667487734f6a95e9967d1f373c77的全量日志lts信息。全量日志lts开启全量日志,日志组id为"4bcff74d-f649-41c8-8325-1b0a264ff683",访问日志流id为:"0a7ef713-cc3e-418d-abda-85df04db1a3c",攻击日志流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"
  }
}

响应示例

状态码: 200

请求成功

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

SDK代码示例

SDK代码示例如下。

更新项目id为project_id,lts配置信息id为c89a667487734f6a95e9967d1f373c77的全量日志lts信息。全量日志lts开启全量日志,日志组id为"4bcff74d-f649-41c8-8325-1b0a264ff683",访问日志流id为:"0a7ef713-cc3e-418d-abda-85df04db1a3c",攻击日志流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());
        }
    }
}

更新项目id为project_id,lts配置信息id为c89a667487734f6a95e9967d1f373c77的全量日志lts信息。全量日志lts开启全量日志,日志组id为"4bcff74d-f649-41c8-8325-1b0a264ff683",访问日志流id为:"0a7ef713-cc3e-418d-abda-85df04db1a3c",攻击日志流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)

更新项目id为project_id,lts配置信息id为c89a667487734f6a95e9967d1f373c77的全量日志lts信息。全量日志lts开启全量日志,日志组id为"4bcff74d-f649-41c8-8325-1b0a264ff683",访问日志流id为:"0a7ef713-cc3e-418d-abda-85df04db1a3c",攻击日志流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)
    }
}

更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。

状态码

状态码

描述

200

请求成功

400

请求失败

401

token权限不足

500

服务器内部错误

错误码

请参见错误码