DescribeDomainIpAcl

1. API Description

This interface is used to query the IP access control policy for an accelerated domain.

2. Request Parameters

The following request parameters are required by the interface:

Parameter NameRequiredTypeDescription

domainId

Yes

String

Accelerated domain ID

3. Output Parameters

Parameter NameTypeDescription

requestId

String

Unique request ID. This ID is returned with every request and is needed for troubleshooting.

ipAcl

IP access control information

4. Code Example

  1. Query Accelerated Domain IP Access Control Policy

POST / HTTP/1.1
Host: console.zenlayer.com/api/v2/cdn
Content-Type: application/json
X-ZC-Action: DescribeDomainIpAcl
<Common Request Params>

Request:
{
    "domainId": "domainIdxxxxx"
}

Response:
{
    "requestId": "T6883FCD0-3E7D-44EA-A517-A421A52A27F4",
    "response": {
        "requestId": "T6883FCD0-3E7D-44EA-A517-A421A52A27F4",
        "ipAcl": {
            "enable": true,
            "type": "WHITE",
            "ips": [
                "1.1.1.1",
                "2.2.2.2"
            ]
        }
    }
}

5. Error Codes

The following includes error codes encountered in business logic. For other error codes, see Common Error Codes.

HTTP Status CodeError CodeDescription

404

INVALID_DOMAIN_NOT_FOUND

The specified accelerated domain does not exist.

403

DOMAIN_OPERATION_NO_PERMISSION

Operation denied due to lack of permission.

Last updated