Disables a domain name.

Usage note

Call this API to disable a domain name, and change the DomainStatus to offline. After the domain name is disabled, the information about the domain name is retained. ApsaraVideo Live automatically reroutes all the requests that are destined for the domain name to the origin.

QPS limit

A single user can perform a maximum of 30 queries per second (QPS). Throttling is triggered when the number of calls per second exceeds the QPS limit. The throttling may affect your business. Thus, we recommend that you observe the QPS limit on this operation. For more information about what a single user means and the QPS details, see QPS limit on an API operation in ApsaraVideo Live.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes StopLiveDomain

The operation that you want to perform. Set the value to StopLiveDomain.

DomainName String Yes demo.aliyundoc.com

The streaming domain or ingest domain.

Response parameters

Parameter Type Example Description
RequestId String 324AEFFF-308C-4DA7-8CD3-01B277B98F28

The ID of the request.

Examples

Sample requests

http(s)://live.aliyuncs.com/?Action=StopLiveDomain
&DomainName=demo.aliyundoc.com
&<Common request parameters>

Sample success responses

XML format 

<StopLiveDomainResponse>
      <RequestId>324AEFFF-308C-4DA7-8CD3-01B277B98F28</RequestId>
</StopLiveDomainResponse>

JSON format 

{
    "RequestId":"324AEFFF-308C-4DA7-8CD3-01B277B98F28"
}

Error codes

For a list of error codes, visit the API Error Center.