# Get Domain Blacklist - DescribeWafDomainBlackList

## Overview

Get Domain Blacklist






## Definition

### Public Parameters

| Parameter Name | Type | Description Information | Required |
|:---|:---|:---|:---|
| **Action**     | string  | Corresponding API command name, the current API is `DescribeWafDomainBlackList`.                      | **Yes** |
| **PublicKey**  | string  | The user's public key can be obtained from [Console](https://console.dezai.com/uaccount/api_manage)                                             | **Yes** |
| **Signature**  | string  | User signature generated based on public key and API command, see [Signature Algorithm](/docs/api/summary/signature.md)  | **Yes** |

### Request Parameters

| Parameter Name | Type | Description Information | Required |
|:---|:---|:---|:---|
| **ProjectId** | string | Project ID. If not filled in, the default project is used, sub-accounts must be filled in. Please refer to the [GetProjectList interface](/docs/api/summary/get_project_list). |No|
| **FullDomain** | string | Domain to query |**Yes**|
| **Limit** | int | Limit per page (Equivalent to page size) |**Yes**|
| **Offset** | int | Page Offset (Equivalent to page number) |**Yes**|
| **Filter** | string | The IP, network segment, or IP segment you want to search for, pass the array (CIDRS). |No|
| **Sort.N** | string | Sort parameter, supports "ExpireTime", "-ExpireTime", "CreateTime", "-CreateTime". |No|

### Response Field

| Field Name | Type | Description Information | Required |
|:---|:---|:---|:---|
| **RetCode** | int | Return status code. If it is 0, it means successful return. If it is not 0, it means failure. |**Yes**|
| **Action** | string | Operation command name. |**Yes**|
| **Message** | string | Returns an error message, providing detailed description when `RetCode` is non-zero. |No|
| **Res** | [*BWInfoRes*](#bwinfores) | Blacklist return results, refer to BWInfoRes |No|

#### Data Model


#### BWInfoRes

| Field Name | Type | Description Information | Required |
|:---|:---|:---|:---|
| **Total** | int | Total |No|
| **Count** | int | Return Quantity |No|
| **Info** | array[[*BWInfo*](#bwinfo)] | Detail list, refer to BWInfo |No|

#### BWInfo

| Field Name | Type | Description Information | Required |
|:---|:---|:---|:---|
| **ID** | int | Blacklist/Whitelist Rule ID |No|
| **Type** | string | Type |No|
| **Source** | string | Join Method (Black) |No|
| **CIDRS** | array[string] | IP List |No|
| **CreateTime** | string | Join Time |No|
| **ExpireTime** | int | Expiration Time |No|
| **State** | int | Status |No|
| **SRC** | string | Join Method (White) |No|
| **Name** | string | Rule Name |No|
| **Remark** | string | Note Information |No|

## Example

### Request Example
    
```
https://api.dezai.com/?Action=DescribeWafDomainBlackList
&ProjectId=org-xxx
&FullDomain=www.test.com
&Offset=0
&Limit=10
&Remark=test
```

### Response Example
    
```json
{
  "Action": "DescribeWafDomainBlackListResponse",
  "Res": {
    "Count": 3,
    "Info": [
      {
        "ActionType": "forbidden",
        "CIDRS": [
          "1.2.3.4"
        ],
        "CreateTime": "2020-03-26 11:21:03",
        "ExpireTime": 1585193463,
        "ID": 251276,
        "Name": "",
        "Remark": "",
        "SRC": "",
        "Source": "custom",
        "State": 0,
        "Type": "custom"
      },
      {
        "ActionType": "forbidden",
        "CIDRS": [
          "2.2.2.2-2.2.2.10"
        ],
        "CreateTime": "2020-03-28 01:59:05",
        "ExpireTime": 1585332545,
        "ID": 252062,
        "Name": "",
        "Remark": "",
        "SRC": "",
        "Source": "custom",
        "State": 0,
        "Type": "custom"
      },
      {
        "ActionType": "forbidden",
        "CIDRS": [
          "2.2.2.2"
        ],
        "CreateTime": "2020-04-03 10:03:39",
        "ExpireTime": 1585880019,
        "ID": 252731,
        "Name": "",
        "Remark": "",
        "SRC": "",
        "Source": "custom",
        "State": 0,
        "Type": "custom"
      }
    ],
    "Total": 3
  },
  "RetCode": 0
}
```