更新时间:2025-08-19 GMT+08:00

查询可防护的资源列表

功能介绍

查询可防护的资源列表

调用方法

请参见如何调用API

URI

GET /v1/{project_id}/premium-waf/host/protectable-resources/{resource_type}

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释:

用户Project ID

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

resource_type

String

表2 Query参数

参数

是否必选

参数类型

描述

vpc_id

String

参数解释:

负载均衡器所在VPC ID

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数解释:

租户Token

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

region

String

参数解释:

租户region

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

Content-Type

String

参数解释:

内容类型

约束限制:

不涉及

取值范围:

不涉及

默认取值:

application/json;charset=utf8

响应参数

状态码:200

表4 响应Body参数

参数

参数类型

描述

items

Array of ProtectableResources objects

参数解释:

详细的可防护资源的信息

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

total

Integer

参数解释:

全部可防护资源的数量

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

表5 ProtectableResources

参数

参数类型

描述

loadbalancer_name

String

参数解释:

负载均衡器名称

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

loadbalancer_id

String

参数解释:

负载均衡器ID

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

domain_id

String

参数解释:

负载均衡器所属的账号ID

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

project_id

String

参数解释:

负载均衡器所在的项目ID

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

listeners

Array of Listener objects

参数解释:

当前ELB所关联的监听器列表

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

eips

Array of EipInfo objects

参数解释:

负载均衡器绑定的EIP

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

表6 Listener

参数

参数类型

描述

name

String

参数解释:

监听器的名称

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

id

String

参数解释:

监听器的ID

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

protocol

String

参数解释:

监听器的监听协议

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

protocol_port

Integer

参数解释:

监听器的监听端口

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

表7 EipInfo

参数

参数类型

描述

eip_id

String

参数解释:

弹性IP的ID

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

eip_address

String

参数解释:

弹性IP的IP地址

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

ip_version

Integer

参数解释:

IP版本号

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

状态码: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

下游服务报错信息

请求示例

响应示例

SDK代码示例

SDK代码示例如下。

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

    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();
        ListProtectableResourcesRequest request = new ListProtectableResourcesRequest();
        request.withResourceType("{resource_type}");
        try {
            ListProtectableResourcesResponse response = client.listProtectableResources(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
# 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 = ListProtectableResourcesRequest()
        request.resource_type = "{resource_type}"
        response = client.list_protectable_resources(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
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.ListProtectableResourcesRequest{}
	request.ResourceType = "{resource_type}"
	response, err := client.ListProtectableResources(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

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

状态码

状态码

描述

200

OK

400

非法请求

401

Token无权限

500

服务器内部错误

错误码

请参见错误码