DescribeShowList - ApsaraVideo Live - Alibaba Cloud Documentation Center

Queries the details of an episode list.

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.

Debug

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.

Operation	Access level	Resource type	Condition key	Associated operation
live:DescribeShowList	get	Domain `acs:live::{#accountId}:domain/{#DomainName}`	none	none

Request parameters

Parameter	Type	Required	Description	Example
CasterId	string	Yes	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 Name column.	LIVEPRODUCER_POST-cn-0pp1czt****

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	The request ID.	16A96B9A-F203-4EC5-8E43-CB92E68F4CD8
ShowList	string	**Details of the episode list. Show indicates the information about a specific episode. For more information, see the Show** parameter.	ShowList[Show1, Show2, Show3...]
ShowListInfo	object	The information about the episode list.
CurrentShowId	string	The ID of the episode that is playing.	a2b8e671-2fe5-4642-a2ec-bf93880e****
Background	string	The background of the episode list.	{\"MaterialId\":\"a2b8e671-2fe5-4642-a2ec-bf93880e****\",\"resourceType\":\"VOD\"}
HighPriorityShowId	string	The episode of the highest priority. Note You can configure this parameter only before the episode list starts playing.	a2b8e671-2fe5-4642-a2ec-bf93880e****
HighPriorityShowStartTime	string	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
ShowList	array<object>	The episodes in the episode list.
Show	object
Duration	long	The duration of the episode. Unit: seconds.	20
RepeatTimes	integer	The number of times the episode repeats after the first playback is complete. For example, if you set the value to 0, the episode is to be played once. If you set the value to 1, the episode is to be played twice.	5
ResourceInfo	object	The resource information.
LiveInputType	integer	The custom type label.	1
ResourceId	string	The ID of the video-on-demand (VOD) file.	a2b8e671-2fe5-4642-a2ec-bf93880e****
ResourceType	string	The type of the resource.	vod
ResourceUrl	string	The URL of the resource.	http:///atestObject.m3u8
ShowId	string	The ID of the episode.	a2b8e671-2fe5-4642-a2ec-bf93880e****
ShowName	string	The name of the episode.	liveShow****
ShowListRepeatTimes	integer	The number of additional times the episode list is played by default. The value is 0.	0
TotalShowListRepeatTimes	integer	The number of additional times the episode list is played.	1

Examples

Sample success responses

JSONformat

{
  "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
404	InvalidCaster.NotFound	%s
404	InvalidShowList.NotFound	%s
404	InvalidShow.NotFound	%s
500	InternalError	%s

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

Change history

Change time	Summary of changes	Operation
2024-07-15	The Error code has changed. The response structure of the API has changed	View Change Details
2024-07-11	The Error code has changed. The response structure of the API has changed	View Change Details
2024-04-11	The Error code has changed. The response structure of the API has changed	View Change Details
2024-01-30	The Error code has changed. The response structure of the API has changed	View Change Details