文档首页/ 云防火墙 CFW/ API参考/ API/ EIP管理/ 查看eip告警白名单
更新时间:2025-08-12 GMT+08:00

查看eip告警白名单

功能介绍

查看eip告警白名单

调用方法

请参见如何调用API

URI

GET /v1/{project_id}/eip/alarm-whitelist/{fw_instance_id}

表1 路径参数

参数

是否必选

参数类型

描述

fw_instance_id

String

防火墙ID,可通过防火墙ID获取方式获取

project_id

String

项目ID,可以通过调用API获取,也可以从控制台获取。可通过项目ID获取方式获取

表2 Query参数

参数

是否必选

参数类型

描述

ip_address

String

IP地址

limit

Integer

每页显示个数,范围为1-1024

offset

Integer

偏移量:指定返回记录的开始位置,必须为数字,取值范围为大于或等于0,默认0

enterprise_project_id

String

企业项目ID,用户根据组织规划企业项目,对应的ID为企业项目ID,可通过如何获取企业项目ID获取,用户未开启企业项目时为0

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户Token,可通过如何获取用户Token获取

响应参数

状态码:200

表4 响应Body参数

参数

参数类型

描述

data

HttpListAlarmWhiteListResponseData object

查询告警白名单返回值数据

表5 HttpListAlarmWhiteListResponseData

参数

参数类型

描述

list

Array of EipInfo objects

查询告警白名单返回值数据

pages

Integer

目前页数

size

Integer

每页个数

total

Integer

总数

表6 EipInfo

参数

参数类型

描述

device_name

String

设备名称

eip_id

String

EIP id

fw_instance_id

String

防火墙ID

object_id

String

防护对象id

public_ip

String

ip v4地址

public_ipv6

String

ip v6地址

type

Integer

EIP白名单标志,0表示是EIP白名单,1表示不是EIP白名单。

请求示例

查看项目id为408972e72dcd4c1a9b033e955802a36b的EIP告警白名单,防火墙ID为e743cfaf-8164-4807-aa13-d893d83313cf,企业项目id为fb55459c-41b3-47fc-885d-540946fddda4。查询结果限制为1000条,偏移量为0。

https://{Endpoint}/v1/408972e72dcd4c1a9b033e955802a36b/eip/alarm-whitelist/e743cfaf-8164-4807-aa13-d893d83313cf?fw_instance_id=e743cfaf-8164-4807-aa13-d893d83313cf&enterprise_project_id=fb55459c-41b3-47fc-885d-540946fddda4&limit=1000&offset=0

响应示例

状态码:200

查询告警白名单返回值

{
  "data" : {
    "list" : [ {
      "device_name" : "client_ipv6",
      "eip_id" : "a40f3306-b7f3-428b-afe7-5ae1e7a5c594",
      "object_id" : "",
      "public_ip" : "100.100.100.100",
      "type" : 1
    }, {
      "device_name" : "ecs-172",
      "eip_id" : "5e9c7249-2c05-4c0e-a9ed-192af2c1d129",
      "fw_instance_id" : "e743cfaf-8164-4807-aa13-d893d83313cf",
      "object_id" : "1b90f031-0c7b-4f25-95e2-b6d9940d269e",
      "public_ip" : "100.200.200.200",
      "type" : 0
    } ],
    "pages" : 1,
    "size" : 2,
    "total" : 2
  }
}

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


public class ListAlarmWhitelistSolution {

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

        CfwClient client = CfwClient.newBuilder()
                .withCredential(auth)
                .withRegion(CfwRegion.valueOf("<YOUR REGION>"))
                .build();
        ListAlarmWhitelistRequest request = new ListAlarmWhitelistRequest();
        request.withFwInstanceId("{fw_instance_id}");
        try {
            ListAlarmWhitelistResponse response = client.listAlarmWhitelist(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 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 = os.environ["CLOUD_SDK_AK"]
    sk = os.environ["CLOUD_SDK_SK"]
    projectId = "{project_id}"

    credentials = BasicCredentials(ak, sk, projectId)

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

    try:
        request = ListAlarmWhitelistRequest()
        request.fw_instance_id = "{fw_instance_id}"
        response = client.list_alarm_whitelist(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"
    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")
    projectId := "{project_id}"

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

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

    request := &model.ListAlarmWhitelistRequest{}
	request.FwInstanceId = "{fw_instance_id}"
	response, err := client.ListAlarmWhitelist(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

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

状态码

状态码

描述

200

查询告警白名单返回值

401

Unauthorized,错误的请求

403

Forbidden,禁止访问

404

Not Found,网页未找到

错误码

请参见错误码