DescribeCasterScenes - ApsaraVideo Live - Alibaba Cloud Documentation Center

Queries the scenes 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 scenes 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 limits.

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:DescribeCasterScenes	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 ID/Name column.	80787064-1c94-4dc1-85ce-9409960a****
SceneId	string	No	The ID of the scene.	b5f8c837-ceeb-424f-b30b-68e94e86****

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	The request ID.	The ID of the scene.
SceneList	array<object>	The scenes.
Scene	object	The information about the scene.
ComponentIds	array	The components.
componentId	string	The ID of the component.	["1506396160-0-0-7de771a77102680861853af862d5****"]
LayoutId	string	The ID of the layout.	37cb2f8b-f152-4338-b928-6704f71d****
OutputType	string	Indicates whether the output video is in PVW mode or PGM mode. Valid values: 0: in PVW mode. 1: in PGM mode.	0
SceneId	string	The ID of the scene. You can use the ID as a request parameter in the API operation that is used to modify the audio configurations of the scene, query the audio configurations of the scene, start the scene, or stop the scene.	b5f8c837-ceeb-424f-b30b-68e94e86****
SceneName	string	The name of the scene.	scene1
Status	integer	The status of the scene. Valid values: 0: disabled 1: enabled	0
StreamInfos	array<object>	The information about the stream.
StreamInfo	object	The information about the stream.
OutputStreamUrl	string	The streaming 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 URL of the output stream.	rtmp://developer.aliyundoc.com/caster/4a82a3d1b7f0462ea37348366201**?auth_key=1608953344-0-0-ac8c628078541d7055a170ec59a5**
Total	integer	The total number of entries.	2

Examples

Sample success responses

JSONformat

{
  "RequestId": "The ID of the scene.\n",
  "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
400	InvalidCasterId.Malformed	%s
400	InvalidSceneId.Malformed	%s
401	IllegalOperation	%s
404	InvalidCaster.NotFound	%s
404	InvalidDomainName.NotFound	%s
500	InternalError	%s

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

Change history

Change time	Summary of changes	Operation

No change history