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

查询EIP防护状态列表

功能介绍

查询用户所有EIP的Anti-DDoS防护状态信息,用户的EIP无论是否绑定到云服务器,都可以进行查询。

调用方法

请参见如何调用API

URI

GET /v1/{project_id}/antiddos

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

项目id

最小长度:32

最大长度:64

表2 Query参数

参数

是否必选

参数类型

描述

status

String

可选范围:

  • normal:表示正常

  • configging:表示设置中

  • notConfig:表示未设置

  • packetcleaning:表示清洗

  • packetdropping:表示黑洞

不带此参数默认所有列表,以neutron查询到的顺序为准。

limit

String

返回结果个数限制,取值范围:1~100

最小长度:1

最大长度:3

offset

String

偏移量,取值范围:0~2147483647

最小长度:1

最大长度:10

ip

String

IP地址,支持IPv4格式和IPv6格式输入,支持部分查询。例如“?ip=192.168”,会返回192.168.111.1和10.192.168.8所对应的EIP防护状态。

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

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

最小长度:32

最大长度:2097152

Content-Type

String

Content-Type请求头

缺省值:application/json;charset=utf8

最小长度:1

最大长度:255

响应参数

状态码: 200

表4 响应Body参数

参数

参数类型

描述

total

Integer

弹性IP总数

最小值:0

最大值:2147483647

ddosStatus

Array of DDosStatus objects

防护状态列表

表5 DDosStatus

参数

参数类型

描述

floating_ip_id

String

EIP的ID

floating_ip_address

String

浮动IP地址

network_type

String

EIP所属类型,可选范围:

  • EIP:未绑定到ECS的EIP或绑定到ECS的EIP

  • ELB:绑定到ELB的EIP

status

String

防护状态,可选范围:

  • normal:表示正常

  • configging:表示设置中

  • notConfig:表示未设置

  • packetcleaning:表示清洗

  • packetdropping:表示黑洞

blackhole_endtime

Long

黑洞结束时间

protect_type

String

防护类型

traffic_threshold

Long

流量阈值

http_threshold

Long

http流量阈值

请求示例

响应示例

状态码: 200

请求已成功

{
  "total" : 1,
  "ddosStatus" : [ {
    "floating_ip_id" : "18e6ace5-eb36-4196-a15e-1e000c24e026",
    "floating_ip_address" : "139.9.116.167",
    "network_type" : "EIP",
    "status" : "normal",
    "blackhole_endtime" : 0,
    "protect_type" : "default",
    "traffic_threshold" : 99,
    "http_threshold" : 0
  } ]
}

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
49
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.antiddos.v1.region.AntiDDoSRegion;
import com.huaweicloud.sdk.antiddos.v1.*;
import com.huaweicloud.sdk.antiddos.v1.model.*;


public class ListDDosStatusSolution {

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

        AntiDDoSClient client = AntiDDoSClient.newBuilder()
                .withCredential(auth)
                .withRegion(AntiDDoSRegion.valueOf("cn-north-4"))
                .build();
        ListDDosStatusRequest request = new ListDDosStatusRequest();
        request.withStatus("<status>");
        request.withLimit("<limit>");
        request.withOffset("<offset>");
        request.withIp("<ip>");
        try {
            ListDDosStatusResponse response = client.listDDosStatus(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
33
# coding: utf-8

from huaweicloudsdkcore.auth.credentials import BasicCredentials
from huaweicloudsdkantiddos.v1.region.antiddos_region import AntiDDoSRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdkantiddos.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.getenv("CLOUD_SDK_AK")
    sk = os.getenv("CLOUD_SDK_SK")

    credentials = BasicCredentials(ak, sk) \

    client = AntiDDoSClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(AntiDDoSRegion.value_of("cn-north-4")) \
        .build()

    try:
        request = ListDDosStatusRequest()
        request.status = "<status>"
        request.limit = "<limit>"
        request.offset = "<offset>"
        request.ip = "<ip>"
        response = client.list_d_dos_status(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
39
40
41
42
43
package main

import (
	"fmt"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic"
    antiddos "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/antiddos/v1"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/antiddos/v1/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/antiddos/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 := antiddos.NewAntiDDoSClient(
        antiddos.AntiDDoSClientBuilder().
            WithRegion(region.ValueOf("cn-north-4")).
            WithCredential(auth).
            Build())

    request := &model.ListDDosStatusRequest{}
	statusRequest:= "<status>"
	request.Status = &statusRequest
	limitRequest:= "<limit>"
	request.Limit = &limitRequest
	offsetRequest:= "<offset>"
	request.Offset = &offsetRequest
	ipRequest:= "<ip>"
	request.Ip = &ipRequest
	response, err := client.ListDDosStatus(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

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

状态码

状态码

描述

200

请求已成功

错误码

请参见错误码

相关文档