DescribeAutoCcWhitelist - Anti-DDoS - Alibaba Cloud Documentation Center

Queries IP addresses in the IP address whitelist of an Anti-DDoS Pro or Anti-DDoS Premium instance.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
yundun-ddoscoo:DescribeAutoCcWhitelist	get	All Resources *	none	none

Request parameters

Parameter	Type	Required	Description	Example
InstanceId	string	Yes	The ID of the instance. Note You can call the DescribeInstanceIds operation to query the IDs of all instances.	ddoscoo-cn-mp91j1ao****
KeyWord	string	No	The keyword for the query. This keyword is used to specify the prefix of the source IP address that you want to query. Note The keyword must be greater than three characters in length.	138
PageNumber	integer	Yes	The number of the page to return. For example, to query the returned results on the first page, set the value to 1.	1
PageSize	integer	Yes	The number of entries to return on each page.	10

Response parameters

Parameter	Type	Description	Example
	object
TotalCount	long	The total number of returned IP addresses in the whitelist.	2
RequestId	string	The ID of the request.	F09D085E-5E0F-4FF2-B32E-F4A644049162
AutoCcWhitelist	array<object>	An array that consists of details of the IP address in the whitelist of the instance.
AutoCcWhitelist	object
Type	string	The mode of how an IP address is added to the whitelist. Valid values: manual: manually added auto: automatically added	manual
DestIp	string	The IP address of the instance.	203.*.*.117
EndTime	long	The validity period of the IP address in the whitelist. Unit: seconds. 0 indicates that the IP address in the whitelist never expires.	0
SourceIp	string	The IP addresses that is contained in the IP address whitelist.	2.2.2.2

Examples

Sample success responses

JSONformat

{
  "TotalCount": 2,
  "RequestId": "F09D085E-5E0F-4FF2-B32E-F4A644049162",
  "AutoCcWhitelist": [
    {
      "Type": "manual",
      "DestIp": "203.***.***.117",
      "EndTime": 0,
      "SourceIp": "2.2.2.2"
    }
  ]
}

Error codes

For a list of error codes, visit the Service error codes.