All Products
Search

This Product

    Edge Security Acceleration:DescribeDcdnFullDomainsBlockIPConfig

    Document Center

    Edge Security Acceleration:DescribeDcdnFullDomainsBlockIPConfig

    Last Updated:Oct 17, 2024

    Queries the configurations of blocked IP addresses.

    Operation description

    Note
  • If you specify IP addresses or CIDR blocks, IP addresses that are effective and the 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 content in OSS objects is 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 OSS URLs with others. The shared URLs are valid for three days.
    •

    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.

    Authorization information

    There is currently no authorization information disclosed in the API.

    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.