Documentation|Tencent Cloud

Recent Pages

Documentation

ModifyCCIpAllowDeny

Last updated: 2020-07-31 10:09:05

1. API Description

Domain name for API request: dayu.tencentcloudapi.com.

This API is used to add/remove a CC IP to/from the blocklist/allowlist.

A maximum of 10 requests can be initiated per second for this API.

We recommend you to use API Explorer

Try it

API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters

The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.

Parameter Name	Required	Type	Description
Action	Yes	String	Common parameter. The value used for this API: ModifyCCIpAllowDeny.
Version	Yes	String	Common parameter. The value used for this API: 2018-07-09.
Region	No	String	Common parameter. This parameter is not required for this API.
Business	Yes	String	Anti-DDoS service type. `bgpip`: Anti-DDoS Advanced; `bgp`: Anti-DDoS Pro (single IP); `bgp-multip`: Anti-DDoS Pro (multi-IP), `net`: Anti-DDoS Ultimate
Id	Yes	String	Anti-DDoS instance ID
Method	Yes	String	add: add, delete: delete
Type	Yes	String	Blocklist/allowlist type. Valid values: [white (allowlist), black (blocklist)]
IpList.N	Yes	Array of String	Blocklisted/whitelisted IP array
Protocol	No	String	CC protection type, which is optional. Valid values: [http (HTTP CC protection), https (HTTPS CC protection)]; if this field is left empty, HTTPS CC protection will be used by default; if `https` is entered, the `Domain` and `RuleId` fields are required;
Domain	No	String	HTTPS layer-7 forwarding rule domain name (which is optional and can be obtained from the layer-7 forwarding rule API). This field is required only if `Protocol` is `https`;
RuleId	No	String	HTTPS layer-7 forwarding rule ID (which is optional and can be obtained from the layer-7 forwarding rule API), If `Method` is `delete`, this field can be left empty;

3. Output Parameters

Parameter Name	Type	Description
Success	SuccessCode	Success code
RequestId	String	The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Adding IP to HTTP CC protection blacklist/whitelist

Input Example

https://dayu.tencentcloudapi.com/?Action=ModifyCCIpAllowDeny
&Business=bgpip
&Id=bgpip-000000xe
&Method=add
&Type=white
&IpList.0=1.1.1.1
&IpList.1=1.1.1.2
&Protocol=http
&<Common request parameters>

Output Example

{
  "Response": {
    "RequestId": "eac6b301-a322-493a-8e36-83b295459397",
    "Success": {
      "Code": "Success",
      "Message": "Success"
    }
  }
}

Example2 Adding IP to HTTPS CC protection blacklist/whitelist

Input Example

https://dayu.tencentcloudapi.com/?Action=ModifyCCIpAllowDeny
&Business=bgpip
&Id=bgpip-000000xe
&Method=add
&Type=white
&IpList.0=1.1.1.1
&IpList.1=1.1.1.2
&Protocol=https
&Domain=test.com
&RuleId=rule-0000001
&<Common request parameters>

Output Example

{
  "Response": {
    "RequestId": "eac6b301-a322-493a-8e36-83b295459397",
    "Success": {
      "Code": "Success",
      "Message": "Success"
    }
  }
}

Example3 Removing IP from HTTPS CC protection blacklist/whitelist

Input Example

https://dayu.tencentcloudapi.com/?Action=ModifyCCIpAllowDeny
&Business=bgpip
&Id=bgpip-000000xe
&Method=delete
&Type=white
&IpList.0=1.1.1.1
&IpList.1=1.1.1.2
&Protocol=https
&Domain=test.com
&<Common request parameters>

Output Example

{
  "Response": {
    "RequestId": "eac6b301-a322-493a-8e36-83b295459397",
    "Success": {
      "Code": "Success",
      "Message": "Success"
    }
  }
}

5. Developer Resources

API Explorer

This tool allows online call, signature authentication, SDK code generation and quick search of APIs to greatly improve the efficiency of using TencentCloud APIs.