All Products
Search

This Product

    ApsaraVideo Live:ForbidLiveStream

    Document Center

    ApsaraVideo Live:ForbidLiveStream

    Last Updated:Jun 22, 2026

    Disables stream ingest for a specified stream. You can preset a time to resume the stream.

    Operation description

    Calls this operation to disable stream ingest for a specified stream. You can preset a time to resume the stream. If no preset time is specified, call the ResumeLiveStream operation to resume the live stream. This operation currently supports only publisher (streamer ingest).

    Note

    • This operation disables live streams by adding them to a blacklist. The upper limit is 10,000 streams. If this limit is exceeded, the disable operation fails. Monitor the number of currently disabled streams. Call the DescribeLiveStreamsBlockList operation to query the number of disabled streams.

    • If you only interrupt a live stream without adding it to the blacklist, the stream does not count toward the 10,000-stream blacklist quota.

    QPS limit

    The maximum queries per second (QPS) per user for this operation is 20. If this limit is exceeded, API calls are throttled, which may affect your business. Call this operation appropriately.

    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

    update

    *All Resource

    *

    		 None 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 which the ingest stream belongs. You can view the AppName on the Stream Management page.

    liveApp****
    StreamName

    string

    Yes

    The name of the ingest stream. You can view the StreamName on the Stream Management page.

    liveStream****
    LiveStreamType

    string

    Yes

    Specifies whether to disable stream ingest or streaming. Currently, only disabling stream ingest is supported: publisher.

    Valid values:

    • publisher :

      Stream ingest.

    publisher
    Oneshot

    string

    No

    Specifies whether to only interrupt the stream without adding it to the blacklist. Valid values:

    • yes: Only interrupts the stream without adding it to the blacklist (supports upstream ingest or upstream streaming).

    • no: Interrupts the stream and adds it to the blacklist.

    Note

    Default value: no.

    Valid values:

    • no :

      Interrupts the stream and adds it to the blacklist.

    • yes :

      Only interrupts the stream without adding it to the blacklist.

    yes
    ResumeTime

    string

    No

    The time to resume the stream. Format: yyyy-MM-ddTHH:mm:ssZ (UTC).

    Note

    • If the Oneshot parameter is set to no and ResumeTime is not specified, the live stream is disabled for 6 months by default.

    • If a value is specified, the restriction is lifted at the time specified by ResumeTime and the live stream is resumed.

    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.