# 添加域名黑名单 - AddWafDomainBlackList

## 简介

添加域名黑名单





## 定义

### 公共参数

| 参数名 | 类型 | 描述信息 | 必填 |
|:---|:---|:---|:---|
| **Action**     | string  | 对应的 API 指令名称，当前 API 为 `AddWafDomainBlackList`                        | **Yes** |
| **PublicKey**  | string  | 用户公钥，可从 [控制台](https://console.dezai.com/uaccount/api_manage) 获取                                             | **Yes** |
| **Signature**  | string  | 根据公钥及 API 指令生成的用户签名，参见 [签名算法](/docs/api/summary/signature.md)  | **Yes** |

### 请求参数

| 参数名 | 类型 | 描述信息 | 必填 |
|:---|:---|:---|:---|
| **ProjectId** | string | 	<br />项目ID。不填写为默认项目，子帐号必须填写。 请参考[GetProjectList接口](/docs/api/summary/get_project_list) |No|
| **FullDomain** | string | 要添加黑名单的域名 |**Yes**|
| **Source** | string | 黑名单来源， 用户自定义(custom)/机器行为检测(bot)/ bot-rule/ auto（自动拦截规则） |**Yes**|
| **Type** | string | 类型：境内(internal)、境外(oversea)，自定义(custom) |**Yes**|
| **ActionType** | string | 执行动作: 可选值:拦截请求(forbidden) ，验证码(captcha) |**Yes**|
| **ExpireTime** | int | 过期时间,即有效时长，单位为秒,永不过期传0 |**Yes**|
| **RecordId** | int | 域名记录ID |No|
| **DestIp** | string | 目标IP; Source为bot时需传递 |No|
| **CIDRS.N** | string | IP、网段或者IP段，传递数组；类型为custom时必填 |No|
| **Remark** | string | 备注信息 |No|
| **Name** | string | 名称 |No|

### 响应字段

| 字段名 | 类型 | 描述信息 | 必填 |
|:---|:---|:---|:---|
| **RetCode** | int | 返回状态码，为 0 则为成功返回，非 0 为失败 |**Yes**|
| **Action** | string | 操作指令名称 |**Yes**|
| **Message** | string | 返回错误消息，当 `RetCode` 非 0 时提供详细的描述信息 |No|
| **Id** | int | 添加成功后返回的域名黑名单ID |No|




## 示例

### 请求示例
    
```
https://api.dezai.com/?Action=AddWafDomainBlackList
&ProjectId=org-xxx
&FullDomain=www.test.com
&Source=custom
&Type=custom
&ActionType=forbidden
&CIDRS.0=2.2.2.2
&ExpireTime=10
&Remark=test
&Name=DqXFAQfT
```

### 响应示例
    
```json
{
  "Action": "AddWafDomainBlackListResponse",
  "Id": 6,
  "RetCode": 0
}
```