Retrieve All Production Studio Scenes via DescribeCasterScenes - ApsaraVideo Live - Alibaba Cloud - ApsaraVideo Live

Queries the list of scenes in a production studio.

Operation description

Create a production studio by calling the CreateCaster operation, and then call this operation to query the list of scenes in the production studio.

QPS limit

The single-user QPS limit for this operation is 15 calls per second. If the limit is exceeded, the API call is throttled, which may affect your business. Call this operation as needed.

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

get

*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 production studio ID. If you created the production studio by calling the CreateCaster operation, check the CasterId parameter value returned by the CreateCaster operation. If you created the production studio in the ApsaraVideo Live console, go to ApsaraVideo Live console > Production Studios > Cloud Production Studio to view the ID. The production studio specified by CasterId must have a DomainName configured through SetCasterConfig. Otherwise, the error InvalidDomainName.NotFound is returned. Note The name of the production studio in the production studio list on the Cloud Production Studio page is the production studio ID.	80787064-1c94-4dc1-85ce-9409960a****
SceneId	string	No	The scene ID.	b5f8c837-ceeb-424f-b30b-68e94e86****

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	CF60DB6A-7FD6-426E-9288-122CC1*****
SceneList	object
Scene	array<object>	The list of scene information.
	array<object>	The list of scene information.
ComponentIds	object
componentId	array	The list of component IDs.
	string	The list of component IDs.	["1506396160-0-0-7de771a77102680861853af862d5****"]
LayoutId	string	The layout ID.	37cb2f8b-f152-4338-b928-6704f71d****
OutputType	string	Indicates whether the scene is the one being streamed. Valid values: 0: The scene is used for preview. 1: The scene is being streamed.	0
SceneId	string	The scene ID. You can use this ID as a request parameter to update the audio configuration of a scene, query the audio configuration of a scene, start a scene, or stop a scene.	b5f8c837-ceeb-424f-b30b-68e94e86****
SceneName	string	The scene name.	scene1
Status	integer	The status of the scene. Valid values: 0: disabled. 1: enabled.	0
StreamInfos	object
StreamInfo	array<object>	The list of playback URLs.
	object	The list of playback URLs.
OutputStreamUrl	string	The playback URL.	http://live/caster/example.net
TranscodeConfig	string	The transcoding configuration. Valid values: sd: standard definition. lld: low definition. lud: ultra-high definition. lhd: high definition.	lld
VideoFormat	string	The format. Valid values: flv mp4 m3u8	flv
StreamUrl	string	The output stream URL.	rtmp://developer.aliyundoc.com/caster/4a82a3d1b7f0462ea37348366201**?auth_key=1608953344-0-0-ac8c628078541d7055a170ec59a5**
Total	integer	The total number of records.	2

Examples

Success response

JSON format

{
  "RequestId": "CF60DB6A-7FD6-426E-9288-122CC1*****",
  "SceneList": {
    "Scene": [
      {
        "ComponentIds": {
          "componentId": [
            "[\"1506396160-0-0-7de771a77102680861853af862d5****\"]"
          ]
        },
        "LayoutId": "37cb2f8b-f152-4338-b928-6704f71d****",
        "OutputType": "0",
        "SceneId": "b5f8c837-ceeb-424f-b30b-68e94e86****",
        "SceneName": "scene1",
        "Status": 0,
        "StreamInfos": {
          "StreamInfo": [
            {
              "OutputStreamUrl": "http://live/caster/example.net",
              "TranscodeConfig": "lld",
              "VideoFormat": "flv"
            }
          ]
        },
        "StreamUrl": "rtmp://developer.aliyundoc.com/caster/4a82a3d1b7f0462ea37348366201****?auth_key=1608953344-0-0-ac8c628078541d7055a170ec59a5****"
      }
    ]
  },
  "Total": 2
}

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.
400	InvalidSceneId.Malformed	%s, please check and try again later.	The parameter SceneId 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.
404	InvalidDomainName.NotFound	%s, please check and try again later.	Domain name does not exist, please check and try again.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.