DescribeCasterVideoResources - - Alibaba Cloud Documentation Center

Queries the video sources of a production studio.

Operation description

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

QPS limit

This operation is limited to 15 queries per second (QPS) for each user. If you exceed this limit, your API calls are throttled. Throttling 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:DescribeCasterVideoResources

get

*Caster

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

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 the production studio by calling the CreateCaster operation, use the value of CasterId that is returned. If you create the production studio in the LIVE console, go to the Cloud Production Studio page to view the ID. To go to the page, choose LIVE Console > Production Studio > Cloud 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

Element	Type	Description	Example
	object
RequestId	string	The ID of the request.	CF60DB6A-7FD6-426E-9288-122CC1A52FA7
Total	integer	The total number of records.	2
VideoResources	object
VideoResource	array<object>	A list of resources.
	object	A list of resources.
BeginOffset	integer	The start offset of the video file. This parameter is valid only for video files. Unit: milliseconds. Greater than 0: The read operation starts from a point in time that is relative to the first frame.	1000
EndOffset	integer	The end offset of the video file. This parameter is valid only for video files. Unit: milliseconds. Greater than 0: The read operation ends at a point in time that is relative to the first frame. Less than 0: The read operation ends at a point in time that is relative to the last frame.	10000
FlvUrl	string	The stream pulling URL.	http://guide.aliyundoc.com/example.org
ImageId	string	The ID of the image in the material library.	a089175eb5f4427684fc0715159a****
ImageUrl	string	The URL of the image.	http://learn.aliyundoc.com/AppName/image.jpg
LiveStreamUrl	string	The URL of the live stream.	rtmp://abcLive/appName/b5447c21fcfe444c9e9b6f7ba208****
LocationId	string	The location of the video source.	RV01
MaterialId	string	The ID of the material.	d2c429cd907742ee8f6e76465ad3****
PtsCallbackInterval	integer	The callback interval for video-on-demand files. If this parameter is set to 0, no callbacks are sent.	0
RepeatNum	integer	This parameter is valid only for video files. It specifies the number of times the video is replayed after the playback is complete. 0 (default): The video is not replayed. -1: The video is replayed in a loop.	0
ResourceId	string	The ID of the resource.	b5f8c837-ceeb-424f-b30b-68e94e86****
ResourceName	string	The name of the resource.	resource-Name1
VodUrl	string	The URL of the video-on-demand file. This parameter is used only when the resource is a video file that is not imported to the material library. The video file must be in the MP4, FLV, or TS format.	http://developer.aliyundoc.com/caster1.flv

Examples

Success response

JSON format

{
  "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	Description
400	InvalidCasterId.Malformed	%s, please check and try again later.	The parameter CasterId is invalid, 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.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.