All Products
Search

This Product

    ApsaraVideo Live:ModifyShowList

    Document Center

    ApsaraVideo Live:ModifyShowList

    Last Updated:Dec 05, 2024

    Modifies the attributes of an episode list.

    Operation description

    This operation allows you to change the position of an episode in an episode list, how many times an episode list is played, and the specific point in time at which the episode of the highest priority in an episode list is played.

    QPS limit

    You can call this operation up to 10 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.

    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.
    OperationAccess levelResource typeCondition keyAssociated operation
    live:ModifyShowListupdate
    *Caster
    acs:live:*:{#accountId}:caster/{#CasterId}
      none
    		none

    Request parameters

    ParameterTypeRequiredDescriptionExample
    CasterIdstringYes

    The ID of the production studio.

    • If the production studio was created by calling the CreateCaster operation, check the value of the response parameter CasterId to obtain the ID.
    • If the production studio was created by using the ApsaraVideo Live console, obtain the ID on the Production Studio Management page. To go to the page, log on to the ApsaraVideo Live console and click Production Studios in the left-side navigation pane.
    Note You can find the ID of the production studio in the Instance ID/Name column.
    		LIVEPRODUCER_POST-cn-0pp1czt****
    ShowIdstringNo

    The ID of the episode for which you want to change the position in the playlist.

    Note You can call the AddShowIntoShowList or DescribeShowList operation and check the value of the response parameter ShowId to obtain the ID.
    		a2b8e671-2fe5-4642-a2ec-bf93880e****
    RepeatTimesintegerNo

    The number of additional times the episode list is played.

    Note

    • The RepeatTimes parameter specifies the number of repetitions. For example, if you set the value to 0, the episode list is played once. If you set the value to 1, the episode list is played twice.********

    • If you set the value to -1, the episode list is repeated indefinitely.

    		5
    SpotintegerNo

    The position of the episode in the episode list. If you want to change the position of an episode in a playlist, place the ID of the episode in Spot.

    Note The value must be greater than or equal to 0 and less than or equal to the total number of episodes in the playlist.
    		1
    HighPriorityShowIdstringNo

    The episode of the highest priority.

    Note You can configure this parameter only before the playback of the episode list starts.
    		a2b8e671-2fe5-4642-a2ec-bf93880e****
    HighPriorityShowStartTimestringNo

    The time at which the episode of the highest priority is played. Format: yyyy-MM-dd'T'HH:mm:ss.

    Note You can configure this parameter only before the episode list starts playing.
    After you configure this parameter, when the specified point in time is reached, any episode that is playing stops and the episode of the highest priority in the episode list starts to play.
    		2021-11-23T12:30:00

    Response parameters

    ParameterTypeDescriptionExample
    object
    RequestIdstring

    The request ID.

    		16A96B9A-F203-4EC5-8E43-CB92E68F4CD8

    Examples

    Sample success responses

    JSONformat

    {
  "RequestId": "16A96B9A-F203-4EC5-8E43-CB92E68F4CD8"
}

    Error codes

    HTTP status codeError codeError message
    400InvalidUserId.Malformed%s
    400InvalidParameter.Malformed%s
    400InvalidCasterId.Malformed%s
    400IncorrectCasterStatus%s
    400MissingParameter%s
    401IllegalOperation%s
    404InvalidCaster.NotFound%s
    404InvalidShowList.NotFound%s
    404InvalidShow.NotFound%s
    500InternalError%s

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

    Change history

    Change timeSummary of changesOperation
    No change history