StartDomain

1. API Description

This interface is used to enable an acceleration domain.

Note

  • An acceleration domain can only be successfully called when it is in the Stopped state.

  • This interface is asynchronous. After a successful return from the interface, the operation to enable the acceleration domain is not immediately completed. During this period, the state of the acceleration domain will be Deploying. You can check the accelerator status by calling the DescribeCdnDomains interface. If the acceleration domain status (domainStatus) changes from Deploying (in deployment) to Deployed (deployment successful), it indicates that the deployment is successful. Failed indicates deployment failure.

2. Request Parameters

The following request parameters list only includes the required parameters for the interface.

Parameter Name
Required
Type
Description

domainId

Yes

String

Acceleration domain Id

3. Output Parameters

Parameter Name
Type
Description

requestId

String

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

4. Code Example

  1. Enable Acceleration Domain

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

Request:
{
    "domainId": "domainIdxxxxx"
}


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.

Last updated