All Products
Search
Document Center

Dynamic Content Delivery Network:DescribeDcdnFullDomainsBlockIPConfig

Last Updated:Apr 11, 2024

Queries the configurations of blocked IP addresses.

Operation description

  • If you specify IP addresses or CIDR blocks, IP addresses that are effective and corresponding expiration time are returned. If you do not specify IP addresses or CIDR blocks, all effective IP addresses and the corresponding expiration time are returned.
  • The results are written to OSS and returned as OSS URLs. The OSS objects are in the format of IP address-Corresponding expiration time. The expiration time is in the yyyy-MM-dd HH:mm:ss format.
  • You can share URLs of OSS objects with others. The shared URLs are valid for three days.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

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.
OperationAccess levelResource typeCondition keyAssociated operation
dcdn:DescribeDcdnFullDomainsBlockIPConfigWrite
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
IPListstringNo

The IP address or CIDR block to query. Separate multiple values with commas (,). You can specify up to 50 IP addresses or CIDR blocks.

10.XX.XX.10/24

Response parameters

ParameterTypeDescriptionExample
object

Schema of Response

RequestIdstring

The ID of the request.

0C58632F-BA12-1A1E-986D-09285752B42C
Messagestring

The returned results. If the operation is successful, URLs of OSS objects are returned. If the operation fails, an error message is returned.

http://xxxx-api.oss-cn-hangzhou.aliyuncs.com/blocklist%2Fxxxxxxxxxxxx.txt?Expires=1682663947&OSSAccessKeyId=xxxxxxxxxx&Signature=xxxxxx
Codeinteger

The response code.

The value of Code is not 0 in the following scenarios:

  • The format of the IP address is invalid.
  • The number of IP addresses exceeds the limit.
  • Other abnormal scenarios
0

Examples

Sample success responses

JSONformat

{
  "RequestId": "0C58632F-BA12-1A1E-986D-09285752B42C",
  "Message": "http://xxxx-api.oss-cn-hangzhou.aliyuncs.com/blocklist%2Fxxxxxxxxxxxx.txt?Expires=1682663947&OSSAccessKeyId=xxxxxxxxxx&Signature=xxxxxx",
  "Code": 0
}

Error codes

HTTP status codeError codeError messageDescription
400InvalidParameterThe specified parameter is invalid.A parameter is set to an invalid value.
406InvalidKey.QuotaFullThe maximum number of keys is exceeded.The number of keys has reached the upper limit.
500InternalErrorAn internal error occurred; please try again later.An internal error occurred. Try again later. If the error persists, submit a ticket.

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