Add whitelist IP addresses for an Anti-DDoS Proxy instance.
Operation description
This operation adds whitelist IP addresses for a single Anti-DDoS instance, allowing the Anti-DDoS instance to directly forward request traffic from the specified IP addresses.
By default, whitelist IP addresses are permanently valid once added. If you no longer need a whitelist IP address, you can call EmptyAutoCcWhitelist to remove all added whitelist IP addresses.
QPS limits
The queries per second (QPS) limit for this operation is 10 per second per user. If the limit is exceeded, API calls will be throttled, which may affect your business. We recommend that you call this operation at an appropriate rate.
Try it now
Test
RAM authorization
Request parameters
Parameter | Type | Required | Description | Example |
InstanceId | string | Yes | The ID of the Anti-DDoS Proxy instance for which you want to add whitelist IP addresses. Note You can call DescribeInstanceIds to query the IDs of all Anti-DDoS Proxy instances. | ddoscoo-cn-mp91j1ao**** |
Whitelist | string | Yes | The configuration of the whitelist IP addresses that you want to add. This parameter is a string that is converted from a JSON array. Each element in the JSON array is a struct of a whitelist IP address that contains the following parameter:
| [{"src":"192.XX.XX.1"},{"src":"192.XX.XX.2"}] |
ExpireTime | integer | No | This parameter is deprecated. Note This parameter specifies the validity period of blacklist IP addresses. Whitelist IP addresses are permanently valid by default. You do not need to set this parameter. | 0 |
When you call this operation, in addition to the request parameters described in this topic, you must also specify the common parameters for API operations. For more information, see Common parameters.
For the request format, see the Examples section of this topic.
Response elements
Parameter | Type | Description | Example |
object | |||
RequestId | string | The ID of the request. | AB5025DA-5C52-5207-B6AC-3F198758B678 |
Examples
Success response
JSON format
{
"RequestId": "AB5025DA-5C52-5207-B6AC-3F198758B678"
}Error codes
See Error Codes for a complete list.
Release notes
See Release Notes for a complete list.