ForbidLiveStream - ApsaraVideo Live - Alibaba Cloud Documentation Center

Disables a live stream. You can specify the time when the live stream is resumed.

Operation description

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

Note

This operation disables a live stream by adding the stream to the blacklist. You can disable up to 10,000 live streams. If the limit is reached, you cannot disable any more live streams. Pay attention to the number of live streams that are disabled. You can call the DescribeLiveStreamsBlockList operation to query the number of live streams that are disabled.
An interrupted live stream is not added to the blacklist and does not occupy the quota.

QPS limit

You can call this operation up to 20 times per second per account. Requests that exceed this limit are dropped and you will experience service interruptions. We recommend that you take note of this limit when you call this operation.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
live:ForbidLiveStream	get	All Resources ``	none	none

Request parameters

Parameter	Type	Required	Description	Example
DomainName	string	Yes	The ingest domain.	demo.aliyundoc.com
AppName	string	Yes	The name of the application to which the live stream belongs. You can view the application name on the Stream Management page of the ApsaraVideo Live console.	liveApp****
StreamName	string	Yes	The name of the ingested stream. You can view the stream name on the Stream Management page of the ApsaraVideo Live console.	liveStream****
LiveStreamType	string	Yes	Specifies whether the live stream is ingested by a streamer or played by a viewer. Set the value to publisher.	publisher
Oneshot	string	No	Specifies whether to only interrupt the live stream without adding the ingest URL of the live stream to the blacklist. Valid values: yes: interrupts the live stream but does 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: disables the live stream and adds the ingest URL of the live stream to the blacklist. Note If you do not specify this parameter, the default value no is used.	yes
ResumeTime	string	No	The time when the live stream is resumed. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC. Note If you set the Oneshot parameter to no and do not specify this parameter, the live stream is disabled for six months by default. If you specify this parameter, the live stream is resumed at the specified point in time.	2015-12-01T10:37:00Z

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	The request ID.	16BFE188-B193-4C3C-ADC5-79A7E31486EA

Examples

Sample success responses

JSONformat

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

Error codes

HTTP status code	Error code	Error message
400	InvalidResumeTime.Malformed	Specified parameter ResumeTime is not valid.
400	QuotaExceeded.Blacklist	Exceed max blacklist count limit
400	ConfigAlreadyExists	Config has already exist.
500	InternalError	The request processing has failed due to backend service exception.

For a list of error codes, visit the Service error codes.