DescribeCasterVideoResources - ApsaraVideo Live - Alibaba Cloud Documentation Center

Queries the video resources of a production studio.

Operation description

You can call the CreateCaster operation to create a production studio and then call this operation to query the video sources of the production studio.

QPS limit

You can call this operation up to 15 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. For more information, see QPS limit on an API operation in ApsaraVideo Live.

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:DescribeCasterVideoResources	get	Caster `acs:live::{#accountId}:caster/{#CasterId}`	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 ID of the request.	CF60DB6A-7FD6-426E-9288-122CC1A52FA7
Total	integer	The total number of returned entries.	2
VideoResources	array<object>	The video resources.
VideoResource	object
BeginOffset	integer	The offset of the position where the system starts to read the video resource. This parameter takes effect only if the input source is a video file. Unit: milliseconds. A value greater than 0 indicates an offset from the first frame.	1000
EndOffset	integer	The offset of the position where the system stops reading the video file. This parameter takes effect only if the input source is a video file. Unit: milliseconds. A value greater than 0 indicates an offset from the first frame. A value smaller than 0 indicates an offset from the last frame.	10000
FlvUrl	string	The source URL.	http://guide.aliyundoc.com/example.org
ImageId	string	The image ID.	a089175eb5f4427684fc0715159a****
ImageUrl	string	The image URL.	http://learn.aliyundoc.com/AppName/image.jpg
LiveStreamUrl	string	The URL of the live stream.	rtmp://abcLive/appName/b5447c21fcfe444c9e9b6f7ba208****
LocationId	string	The position of the video resource.	RV01
MaterialId	string	The material ID.	d2c429cd907742ee8f6e76465ad3****
PtsCallbackInterval	integer	The interval between presentation timestamp (PTS) callbacks. If you set the value to 0, the PTS callback is disabled. This parameter is returned only when the video resource is a video-on-demand (VOD) file.	0
RepeatNum	integer	The number of playback times after the first playback is complete. This parameter takes effect only when the input source is a video file. Valid values: 0 (default): The video file is played only once. -1: The video file is played in loop mode.	0
ResourceId	string	The resource ID.	b5f8c837-ceeb-424f-b30b-68e94e86****
ResourceName	string	The resource name.	resource-Name1
VodUrl	string	The URL of the VOD file. This parameter is returned only when the video resource is an MP4, FLV, or TS file that is not from the media library.	http://developer.aliyundoc.com/caster1.flv

Examples

Sample success responses

JSONformat

{
  "RequestId": "CF60DB6A-7FD6-426E-9288-122CC1A52FA7",
  "Total": 2,
  "VideoResources": {
    "VideoResource": [
      {
        "BeginOffset": 1000,
        "EndOffset": 10000,
        "FlvUrl": "http://guide.aliyundoc.com/example.org",
        "ImageId": "a089175eb5f4427684fc0715159a****",
        "ImageUrl": "http://learn.aliyundoc.com/AppName/image.jpg",
        "LiveStreamUrl": "rtmp://abcLive/appName/b5447c21fcfe444c9e9b6f7ba208****",
        "LocationId": "RV01",
        "MaterialId": "d2c429cd907742ee8f6e76465ad3****",
        "PtsCallbackInterval": 0,
        "RepeatNum": 0,
        "ResourceId": "b5f8c837-ceeb-424f-b30b-68e94e86****",
        "ResourceName": "resource-Name1",
        "VodUrl": "http://developer.aliyundoc.com/caster1.flv"
      }
    ]
  }
}

Error codes

HTTP status code	Error code	Error message
400	InvalidCasterId.Malformed	%s
401	IllegalOperation	%s
404	InvalidCaster.NotFound	%s
500	InternalError	%s

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

Change history

Change time	Summary of changes	Operation
2023-03-31	The Error code has changed. The response structure of the API has changed	View Change Details