修改域名与 WAF 关联关系¶
1. 接口描述¶
接口请求路径:POST /prod-api/waf/wafv3/domains/modifyDomainByWaf
modifyDomainByWaf 用于批量将域名关联到指定 WAF 策略组,或移除策略组关联。域名 ID 来自 查询域名列表 的 rows[].id;策略组 ID 与列表中的 wafAclId 为同一标识,请求体字段名为 wafId。移除关联时 wafId 传 null 或不传。
Token 获取方式见 密钥鉴权。
2. 输入参数¶
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| domainIds | 是 | Array of Long | 要操作的域名 ID 列表,对应列表接口的 id示例值: [657] |
| oid | 是 | String | WAF 套餐/订单 ID,须与域名所属 doid、策略组所属套餐一致示例值: 20240412279097884616 |
| wafId | 否 | Long | WAF 策略组 ID,与列表返回的 wafAclId 相同。传入则绑定;不传或 null 表示解除关联示例值: 149 |
3. 示例¶
示例1 关联策略组¶
输入示例¶
代码调用¶
请将 {登录域名}、token 替换为实际值。
import org.apache.http.client.methods.CloseableHttpResponse;
import org.apache.http.client.methods.HttpPost;
import org.apache.http.entity.ContentType;
import org.apache.http.entity.StringEntity;
import org.apache.http.impl.client.CloseableHttpClient;
import org.apache.http.impl.client.HttpClients;
import org.apache.http.util.EntityUtils;
public class ModifyDomainByWafTest {
public static void main(String[] args) throws Exception {
String url = "https://{登录域名}/prod-api/waf/wafv3/domains/modifyDomainByWaf";
String token = "eyJhbGciOiJIUzUxMiJ9.xxxxxx";
String requestBody = "{"
+ "\"domainIds\":[657],"
+ "\"oid\":\"20240412279097884616\","
+ "\"wafId\":149"
+ "}";
try (CloseableHttpClient httpClient = HttpClients.createDefault()) {
HttpPost httpPost = new HttpPost(url);
httpPost.setHeader("Authorization", "Bearer " + token);
httpPost.setEntity(new StringEntity(requestBody, ContentType.APPLICATION_JSON));
try (CloseableHttpResponse response = httpClient.execute(httpPost)) {
int statusCode = response.getStatusLine().getStatusCode();
String body = EntityUtils.toString(response.getEntity(), "UTF-8");
System.out.println("Status Code: " + statusCode);
System.out.println("Body: " + body);
}
}
}
}
package main
import (
"bytes"
"fmt"
"io"
"net/http"
)
func main() {
url := "https://{登录域名}/prod-api/waf/wafv3/domains/modifyDomainByWaf"
token := "eyJhbGciOiJIUzUxMiJ9.xxxxxx"
requestBody := []byte(`{
"domainIds": [657],
"oid": "20240412279097884616",
"wafId": 149
}`)
req, err := http.NewRequest(http.MethodPost, url, bytes.NewReader(requestBody))
if err != nil {
panic(err)
}
req.Header.Set("Authorization", "Bearer "+token)
req.Header.Set("Content-Type", "application/json")
resp, err := http.DefaultClient.Do(req)
if err != nil {
panic(err)
}
defer resp.Body.Close()
body, err := io.ReadAll(resp.Body)
if err != nil {
panic(err)
}
fmt.Println("Status Code:", resp.StatusCode)
fmt.Println("Body:", string(body))
}
输出示例¶
示例2 移除策略组关联¶
输入示例¶
输出示例¶
4. 输出参数¶
| 参数名称 | 类型 | 描述 |
|---|---|---|
| code | Integer | 状态码。示例值:200 |
| msg | String | 提示信息。示例值:成功 |
5. 错误码¶
| HTTP 状态码 / 业务提示 | 描述 |
|---|---|
| 200 | 成功 |
| 401 | 未鉴权或 Token 无效 |
| 403 | 无权限 |
| 套餐id不能为空 | 未传 oid |
| 更新失败,请确认wafId是否正确 | wafId 不属于当前账号 |
| 更新失败,可能原因:1.存在错误的域名ID;2.域名不在套餐[...]下 | 域名 ID 无效或不属于该套餐 |