ModifyShowList - ApsaraVideo Live - Alibaba Cloud Documentation Center

Modifies the attributes of an episode list.

Operation description

This API operation modifies the position of a show in a playlist, the total number of playback loops for the playlist, and the specific playback time of the highest-priority show.

QPS limit

The queries per second (QPS) limit for this API operation is 10 calls per second per user. If this limit is exceeded, API calls are throttled, which may affect your business. We recommend that you call this operation at a reasonable rate.

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:ModifyShowList

update

*Caster

acs:live:*:{#accountId}:caster/{#CasterId}

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	No	The region ID.	cn-shanghai
CasterId	string	Yes	The ID of the production studio. If you created the production studio by calling the CreateCaster operation, use the CasterId value returned in the response. If you created the production studio in the LIVE console, find the production studio name on the Cloud Production Studio page. To go to the page, choose LIVE Console > Production Studio > Cloud Production Studio. Note The name of the production studio on the Cloud Production Studio page is the production studio ID.	LIVEPRODUCER_POST-cn-0pp1czt****
ShowId	string	No	The ID of the show whose position in the playlist you want to modify. Note Obtain the ShowId value from the response of the AddShowIntoShowList or DescribeShowList operation.	a2b8e671-2fe5-4642-a2ec-bf93880e****
RepeatTimes	integer	No	The number of times the playlist loops. Note RepeatTimes specifies the number of repetitions. For example, a value of 0 means the playlist is played once without repetition. A value of 1 means the playlist is played twice (one initial playback and one repetition). A value of -1 indicates that the playlist loops indefinitely.	5
Spot	integer	No	The new position of the show in the playlist. The show specified by ShowId is moved to the position specified by Spot. Note The value must be greater than or equal to 0 and less than or equal to the total number of shows in the playlist.	1
HighPriorityShowId	string	No	The highest-priority show. Note This parameter can be configured only before the playlist starts.	a2b8e671-2fe5-4642-a2ec-bf93880e****
HighPriorityShowStartTime	string	No	The time to play the highest-priority show. The format is yyyy-MM-dd'T'HH:mm:ss. Note This parameter can be configured only before the playlist starts. After this parameter is configured, the system switches from the currently playing show to the highest-priority show at the specified time.	2021-11-23T12:30:00

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	16A96B9A-F203-4EC5-8E43-CB92E68F4CD8

Examples

Success response

JSON format

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

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidUserId.Malformed	%s, please check userId.	The userId passed in is invalid, please check.
400	InvalidParameter.Malformed	There are invalid parameters: %s.	There are invalid parameters: %s.
400	InvalidCasterId.Malformed	%s, please check and try again later.	The parameter CasterId is invalid, please check and try again.
400	InvalidVodUrl.Malformed	%s, please check and try again later.	Parameter VodUrl is invalid, please check and try again.
400	MissingParameter	%s.	Missing parameter
400	IncorrectCasterStatus	%s, please check and try again later.	Guide station status error, please check and try again.
401	IllegalOperation	%s, please check and try again later.	Operation not allowed, please check and try again.
500	InternalError	%s, please try again later.	Internal error, please try again later.
404	InvalidCaster.NotFound	%s, please check and try again later.	The guide station does not exist, please check and try again.
404	InvalidShowList.NotFound	%s, please check and try again later.	ShowList does not exist, please check and try again.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.