DescribeAutoCcBlacklist - Anti-DDoS - Alibaba Cloud Documentation Center

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

yundun-ddoscoo:DescribeAutoCcBlacklist

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
InstanceId	string	Yes	The ID of the Anti-DDoS Pro or Anti-DDoS Premium instance. Note Call the DescribeInstanceIds operation to query the IDs of all Anti-DDoS Pro and Anti-DDoS Premium instances.	ddoscoo-cn-mp91j1ao****
QueryType	string	No
KeyWord	string	No	The keyword for a fuzzy search. The value is a prefix of the source IP address that you want to query. Note The keyword must be more than three characters long.	138
PageNumber	integer	Yes	The number of the page to return for a paged query. For example, to query the results on the first page, set the value to 1.	1
PageSize	integer	Yes	The number of records to display on each page.	10

Response elements

Element	Type	Description	Example
	object
TotalCount	integer	The total number of blacklisted IP addresses.	2
RequestId	string	The ID of the request. Alibaba Cloud generates a unique ID for each request. You can use this ID to troubleshoot issues.	E78C8472-0B15-42D5-AF22-A32A78818AB2
AutoCcBlacklist	array<object>	The list of blacklisted IP addresses for the Anti-DDoS Pro or Anti-DDoS Premium instance.
	object
Type	string	The source of the blacklisted IP address. Valid values: manual: The IP address is manually added. auto: The IP address is automatically added.	manual
DestIp	string	The IP address of the Anti-DDoS Pro or Anti-DDoS Premium instance.	192.0.XX.XX
EndTime	integer	The expiration time of the blacklisted IP address. This value is a UNIX timestamp. Unit: seconds.	1584093569
SourceIp	string	The blacklisted IP address.	47.100.XX.XX

Examples

Success response

JSON format

{
  "TotalCount": 2,
  "RequestId": "E78C8472-0B15-42D5-AF22-A32A78818AB2",
  "AutoCcBlacklist": [
    {
      "Type": "manual",
      "DestIp": "192.0.XX.XX",
      "EndTime": 1584093569,
      "SourceIp": "47.100.XX.XX"
    }
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.