StopDomain

1. API Description

This interface is used to disable an acceleration domain.

Note

  • An acceleration domain can only be successfully called when it is in the Deployed state. After a successful call, the acceleration domain's status will change to Stopped.

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. Pause Acceleration Domain

POST / HTTP/1.1
Host: console.zenlayer.com/api/v2/cdn
Content-Type: application/json
X-ZC-Action: StopDomain
<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