DescribeShowList - ApsaraVideo Live - Alibaba Cloud Documentation Center

Queries a playlist.

Operation description

Before calling this operation, you must add a show to the playlist. To add a show by calling an API operation, see Add a show to a playlist.

QPS limit

The queries per second (QPS) limit for a single user is 10. If the limit is exceeded, API calls are throttled. This may affect your business operations. Plan your calls accordingly.

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

get

*Domain

acs:live:*:{#accountId}:domain/{#DomainName}

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	No	The ID of the region.	cn-shanghai
CasterId	string	Yes	The ID of the production studio. If you create a production studio by calling the CreateCaster operation, use the CasterId value that is returned in the response. If you create a production studio in the LIVE console, choose LIVE Console > Production Studio > Cloud Production Studio to find the name of the production studio. Note The name of the production studio in the list on the Cloud Production Studio page is the production studio ID.	LIVEPRODUCER_POST-cn-0pp1czt****

Response elements

Parameter	Type	Description	Example
	object	The response parameters.
RequestId	string	The ID of the request.	16A96B9A-F203-4EC5-8E43-CB92E68F4CD8
ShowList	string	The details of the playlist. `Show` contains the details of a show in the playlist.	ShowList[Show1, Show2, Show3...]
ShowListInfo	object	The playlist.
CurrentShowId	string	The ID of the show that is being played.	a2b8e671-2fe5-4642-a2ec-bf93880e****
Background	string	The background of the playlist.	{\"MaterialId\":\"a2b8e671-2fe5-4642-a2ec-bf93880e****\",\"resourceType\":\"VOD\"}
HighPriorityShowId	string	The highest-priority show. Note You can configure this parameter only before the playlist starts.	a2b8e671-2fe5-4642-a2ec-bf93880e****
HighPriorityShowStartTime	string	The time when the highest-priority show is played. The format is yyyy-MM-dd'T'HH:mm:ss. Note You can configure this parameter only before the playlist starts. After the configuration is complete, the system switches to the highest-priority show at the specified time.	2021-11-23T12:30:00
ShowList	object
Show	array<object>	The list of shows in the playlist.
	object	The details of the show.
Duration	integer	The duration of a single show, in seconds.	20
RepeatTimes	integer	The number of times a single show is looped. For example, a value of 0 indicates that the show is played once. A value of 1 indicates that the show is played twice.	5
ResourceInfo	object	The resource information.
LiveInputType	integer	The custom type identifier.	1
ResourceId	string	The ID of the video-on-demand (VOD) file.	a2b8e671-2fe5-4642-a2ec-bf93880e****
ResourceType	string	The type of the resource material.	vod
ResourceUrl	string	The URL of the resource.	http:///atestObject.m3u8
ShowId	string	The ID of the show.	a2b8e671-2fe5-4642-a2ec-bf93880e****
ShowName	string	The name of the show.	liveShow****
ShowListRepeatTimes	integer	The default number of loops for the playlist. This value is always 0.	0
TotalShowListRepeatTimes	integer	The number of times the entire playlist is looped.	1

Examples

Success response

JSON format

{
  "RequestId": "16A96B9A-F203-4EC5-8E43-CB92E68F4CD8",
  "ShowList": "ShowList[Show1, Show2, Show3...]",
  "ShowListInfo": {
    "CurrentShowId": "a2b8e671-2fe5-4642-a2ec-bf93880e****",
    "Background": "{\\\"MaterialId\\\":\\\"a2b8e671-2fe5-4642-a2ec-bf93880e****\\\",\\\"resourceType\\\":\\\"VOD\\\"}",
    "HighPriorityShowId": "a2b8e671-2fe5-4642-a2ec-bf93880e****",
    "HighPriorityShowStartTime": "2021-11-23T12:30:00",
    "ShowList": {
      "Show": [
        {
          "Duration": 20,
          "RepeatTimes": 5,
          "ResourceInfo": {
            "LiveInputType": 1,
            "ResourceId": "a2b8e671-2fe5-4642-a2ec-bf93880e****",
            "ResourceType": "vod",
            "ResourceUrl": "http://**/atestObject**.m3u8"
          },
          "ShowId": "a2b8e671-2fe5-4642-a2ec-bf93880e****",
          "ShowName": "liveShow****"
        }
      ]
    },
    "ShowListRepeatTimes": 0,
    "TotalShowListRepeatTimes": 1
  }
}

Error codes

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

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.