ForbidLiveStream - ApsaraVideo Live - Alibaba Cloud Documentation Center

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

Operation description

If you do not specify a recovery time, call the ResumeLiveStream operation to resume the disabled live stream. This operation can only be performed by hosts (publisher).

Note

This operation disables a live stream by adding the stream to the blacklist. You can disable up to 10,000 live streams. 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 may experience service interruptions.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

live:ForbidLiveStream

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	No	The region ID.	cn-shanghai
DomainName	string	Yes	The ingest domain.	demo.aliyundoc.com
AppName	string	Yes	The name of the application. To view AppName, go to Stream Management.	liveApp****
StreamName	string	Yes	The name of the stream. To view StreamName, go to Stream Management.	liveStream****
LiveStreamType	string	Yes	Specifies whether the stream is ingested by a streamer or played by a client. Currently, only publisher (streamer ingest) is supported.	publisher
Oneshot	string	No	Specifies whether to only interrupt the stream without adding it to the blacklist. Valid values: yes: Disconnects the stream but does not add it to a blacklist. The publisher can reconnect at any time. no: Disconnects the stream and adds it to a blacklist. Note Default value: no.	yes
ResumeTime	string	No	The time when the blacklisted stream is automatically unblocked. Specify the time in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC. Note If Oneshot is set to no and you do not specify this parameter, the stream is disabled for six months by default. If you specify a time, the stream resumes at the specified time.	2015-12-01T10:37:00Z

Response elements

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

Examples

Success response

JSON format

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

Error codes

HTTP status code	Error code	Error message	Description
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.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.