Disables the ingest of a live stream.

Usage notes

You can call this operation to disable the ingest of a live stream and specify the time when the ingest can be enabled. If the time is not specified, you can call the ResumeLiveStream operation to enable the ingest of the live stream. This operation supports only the live streams ingested by streamers.

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 disable the ingest. You can call the DescribeLiveStreamsBlockList operation to query the number of live streams for which you disable the ingest.

Limits on QPS

You can call this operation up to 200 times per second per account. If the number of calls per second exceeds the limit, throttling is triggered. This may affect your business. We recommend that you take note of the limit when you call this operation. For more information, 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 ForbidLiveStream

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

AppName String Yes liveApp****

The application to which the live stream belongs.

DomainName String Yes demo.aliyundoc.com

The ingest domain.

LiveStreamType String Yes publisher

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

StreamName String Yes liveStream****

The name of the live stream for which you want to disable the ingest.

RegionId String No cn-beijing

The ID of the region where the ingest domain resides.

Oneshot String No yes

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

  • yes: Disable the 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 the ingest and add the ingest URL of the live stream to the blacklist.
Note Default value: no.
ResumeTime String No 2015-12-01T10:37:00Z

The time when the ingest can be enabled for the live stream. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.

Notice

If the Oneshot parameter is set to no, you can permanently disable the ingest of the live stream by leaving the ResumeTime parameter empty.

If you specify a value for the ResumeTime parameter, the ingest URL is removed from the blacklist at the specified time and the ingest is enabled for the live stream.

Response parameters

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

The ID of the request.

Examples

Sample request

http(s)://live.aliyuncs.com/?Action=ForbidLiveStream
&AppName=liveApp****
&DomainName=demo.aliyundoc.com
&LiveStreamType=publisher
&StreamName=liveStream****
&<Common request parameters>

Sample success responses

XML format

<ForbidLiveStreamResponse>
	  <RequestId>16BFE188-B193-4C3C-ADC5-79A7E31486EA</RequestId>
</ForbidLiveStreamResponse>

JSON format

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

Error codes

HttpCode Error code 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 QuotaExceeded.Blacklist Exceed max blacklist count limit The error message returned because the number of items in the blacklist exceeded the upper limit.
400 ConfigAlreadyExists Config has already exist. The error message returned because an existing configuration is found.

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