Queries information about the scenes of a production studio.
Usage note
The parameter CasterId is required in the request.
QPS limit
A single user can perform a maximum of 15 queries per second (QPS). Throttling is triggered when the number of calls per second exceeds the QPS limit. The throttling may affect your business. Thus, we recommend that you observe the QPS limit on this operation. For more information about what a single user means and the QPS details, see QPS limit on an API operation in ApsaraVideo Live.
Debugging
Request parameters
Parameter | Type | Required | Example | Description |
---|---|---|---|---|
Action | String | Yes | DescribeCasterScenes |
The operation that you want to perform. Set the value to DescribeCasterScenes. |
CasterId | String | Yes | 80787064-1c94-4dc1-85ce-9409960a**** |
The ID of the production studio. If you create a production studio through the CreateCaster interface, check the value of the CasterId parameter in the response. If you create a production studio through the ApsaraVideo Live Console, log in to the console, then check the ID of the production studio through the following path: Production Studios > Production Studio Management Note The CasterId is reflected in the Name column on the Production Studio Management page.
|
RegionId | String | No | cn-shanghai |
The ID of the region. |
SceneId | String | No | b5f8c837-ceeb-424f-b30b-68e94e86**** |
The ID of the scene. |
Response parameters
Parameter | Type | Example | Description |
---|---|---|---|
RequestId | String | CF60DB6A-7FD6-426E-9288-122CC1A52FA7 |
The ID of the request. |
SceneList | Array of Scene |
The information about the scenes that were queried. |
|
Scene | |||
SceneId | String | b5f8c837-ceeb-424f-b30b-68e94e86**** |
The ID of the scene. |
SceneName | String | scene1 |
The name of the scene. |
OutputType | String | 0 |
Indicates whether the output video is in preview mode or program mode. Valid values:
|
LayoutId | String | 37cb2f8b-f152-4338-b928-6704f71d**** |
The ID of the layout. |
StreamUrl | String | rtmp://developer.aliyundoc.com/caster/4a82a3d1b7f0462ea37348366201****?auth_key=1608953344-0-0-ac8c628078541d7055a170ec59a5**** |
The streaming URL. |
ComponentIds | List | ["1506396160-0-0-7de771a77102680861853af862d5****"] |
The IDs of components. |
Status | Integer | 0 |
The status of the scene. Valid values:
|
StreamInfos | Array of StreamInfo |
The information about the stream. |
|
StreamInfo | |||
OutputStreamUrl | String | http://live/caster/example.net |
The streaming URL. |
TranscodeConfig | String | lld |
The resolution to which the scene transcodes the stream for playback. Valid values:
|
VideoFormat | String | flv |
The format to which the scene transcodes the stream for playback. Valid values:
|
Total | Integer | 2 |
The total number of entries that were returned. |
Examples
Sample requests
http(s)://live.aliyuncs.com/?Action=DescribeCasterScenes
&CasterId=80787064-1c94-4dc1-85ce-9409960a****
&<Common request parameters>
Sample success responses
XML
format
<DescribeCasterScenesResponse>
<RequestId>CF60DB6A-7FD6-426E-9288-122CC1A52FA7</RequestId>
<Total>2</Total>
<SceneList>
<Scene>
<Status>0</Status>
<SceneId>b5f8c837-ceeb-424f-b30b-68e94e86****</SceneId>
<SceneName>scene1</SceneName>
<LayoutId>37cb2f8b-f152-4338-b928-6704f71d****</LayoutId>
<StreamUrl>rtmp://developer.aliyundoc.com/caster/4a82a3d1b7f0462ea37348366201****?auth_key=1608953344-0-0-ac8c628078541d7055a170ec59a5****</StreamUrl>
<OutputType>0</OutputType>
<StreamInfos>
<StreamInfo>
<OutputStreamUrl>http://live/caster/example.net</OutputStreamUrl>
<VideoFormat>flv</VideoFormat>
<TranscodeConfig>lld</TranscodeConfig>
</StreamInfo>
</StreamInfos>
<ComponentIds>
<componentId>["1506396160-0-0-7de771a77102680861853af862d5****"]</componentId>
</ComponentIds>
</Scene>
</SceneList>
</DescribeCasterScenesResponse>
JSON
format
{
"DescribeCasterScenesResponse": {
"RequestId": "CF60DB6A-7FD6-426E-9288-122CC1A52FA7",
"Total": 2,
"SceneList": {
"Scene": {
"Status": 0,
"SceneId": "b5f8c837-ceeb-424f-b30b-68e94e86****",
"SceneName": "scene1",
"LayoutId": "37cb2f8b-f152-4338-b928-6704f71d****",
"StreamUrl": "rtmp://developer.aliyundoc.com/caster/4a82a3d1b7f0462ea37348366201****?auth_key=1608953344-0-0-ac8c628078541d7055a170ec59a5****",
"OutputType": 0,
"StreamInfos": {
"StreamInfo": {
"OutputStreamUrl": "http://live/caster/example.net",
"VideoFormat": "flv",
"TranscodeConfig": "lld"
}
},
"ComponentIds": {
"componentId": "[\"1506396160-0-0-7de771a77102680861853af862d5****\"]"
}
}
}
}
}
Error codes
For a list of error codes, visit the API Error Center.