ModifyDomainRefererAcl

1. API Description

This interface is used to modify the referer access control policy for the accelerated domain.

Notes

  • This is an asynchronous interface. After the interface returns success, the operation of creating the accelerated domain has not been completed immediately. During this period, the status of the accelerated domain will be Deploying. You can check the status of the accelerated domain by calling the DescribeCdnDomains interface. If the status of the accelerated domain (domainStatus) changes from Deploying to Deployed, it means the deployment was successful; Failed indicates that the configuration failed.

2. Request Parameters

The following list of request parameters includes only those required by the interface:

Parameter Name
Required
Type
Description

domainId

Yes

String

Accelerated domain Id

refererAcl

Yes

Referer access control information

3. Output Parameterss

Parameter Name
Type
Description

requestId

String

Unique request ID returned with each request. Provide this requestId when locating issues.

4. Code Example

  1. Modify the Referer Access Control Policy of the Accelerated Domain

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

Request:
{
    "domainId": "domainIdxxxxx",
    "refererAcl": {
        "enable": true,
        "type": "WHITE",
        "allowEmptyReferer": true,
        "allowNoReferer": true,
        "refererDomains": [
            "www.zenlayer.com",
            "163.com",
            "*.baidu.com"
        ]
    }
}


Response:
{
    "requestId": "TEEFDCA5B-76FB-4E91-A18E-DF7F5D2CE41F",
}

5. Error Codes

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

HTTP Status Code
Error Code
Description

404

INVALID_DOMAIN_NOT_FOUND

The specified accelerated domain does not exist.

403

DOMAIN_OPERATION_NO_PERMISSION

Operation denied due to lack of permission.

400

INVALID_REFERER_ACL_TYPE_EMPTY

The referer ACL type cannot be empty when enabling referer access control.

400

INVALID_REFERER_ACL_REFERER_DOMAINS_EMPTY

The referer domains list cannot be empty when enabling referer access control.

400

INVALID_REFERER_ACL_REFERER_DOMAINS

The referer domains list is invalid.

Last updated