Disables the ingest of a live stream and resumes stream ingest at a specific point in time.

Usage note

Call this interface to prohibit the push of a certain stream. You can set ResumeTime parameter so that the stream can be resumed at a certain time. You can also resume the live stream through the ResumeLiveStream API. This interface only supports the publisher (ingested by a streamer) regarding the LiveStreamType.

Note You can disable the ingest of a maximum of 10,000 live streams. If the limit is reached, you cannot disable the ingest of excess live streams. Pay attention to the number of live streams for which you have disabled stream ingest. You can call this operation up to 20 times per second.

QPS limit

A single user can perform a maximum of 200 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.


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 ForbidLiveStream

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

AppName String Yes liveApp****

The name of the application to which the live stream belongs.

DomainName String Yes demo.aliyundoc.com

The ingest domain name.

LiveStreamType String Yes publisher

Specifies whether the live stream is ingested by a streamer or played by a client. Valid value: publisher.

StreamName String Yes liveStream****

The name of the live stream.

Oneshot String No yes

Specifies whether to disable stream ingest without adding the ingest URL of the live stream to the blacklist. Valid values:

  • yes: Disable stream ingest but do not add the ingest URL of the live stream to the blacklist. This value is available only when the live stream is ingested or played in the upstream.
  • no: Disable stream ingest and add the ingest URL of the live stream to the blacklist.

Default value: no.

ResumeTime String No 2015-12-01T10:37:00Z

The time to resume stream ingest. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.

Response parameters

Parameter Type Example Description
RequestId String 16BFE188-B193-4C3C-ADC5-79A7E31486EA

The ID of the request.


Sample requests

&<Common request parameters>

Sample success responses

XML format


JSON format

    "ForbidLiveStreamResponse": {
        "RequestId": "16BFE188-B193-4C3C-ADC5-79A7E31486EA"

Error codes

HTTP status code Error codes Error message Description
400 InvalidResumeTime.Malformed Specified parameter ResumeTime is not valid. The error message returned because the value of the ResumeTime parameter is invalid. Specify a valid value.
400 ConfigAlreadyExists Config has already exist. The error message returned because the ingest of the live stream has been disabled.

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