Queries the streaming URLs of a production studio.
Usage note
You must create a production studio before calling this operation to query the information.
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 | DescribeCasterStreamUrl | The operation that you want to perform. Set the value to DescribeCasterStreamUrl. |
CasterId | String | Yes | a2b8e671-2fe5-4642-a2ec-bf93880e**** | 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. |
Response parameters
Parameter | Type | Example | Description |
---|---|---|---|
RequestId | String | 16A96B9A-F203-4EC5-8E43-CB92E68F4CD8 | The ID of the request. |
CasterId | String | a2b8e671-2fe5-4642-a2ec-bf93880e**** | The ID of the production studio. |
CasterStreams | Array of CasterStream | The information about the streams of the production studio. | |
CasterStream | |||
SceneId | String | 23ca74e0-aca3-4e7a-8561-9d96f525**** | The ID of the scene. |
StreamUrl | String | http://live/caster/example.org | The streaming URL. |
OutputType | Integer | 1 | Indicates whether the output stream is in preview mode or program mode.
|
StreamInfos | Array of StreamInfo | The information about the stream. | |
StreamInfo | |||
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:
|
OutputStreamUrl | String | http://out/caster/example.net | The streaming URL. |
RtmpUrl | String | rtmp://live/caster/example.edu | The Real Time Messaging Protocol (RTMP) URL. |
Total | Integer | 1 | The number of streams that were returned. |
Examples
Sample requests
http(s)://live.aliyuncs.com/?Action=DescribeCasterStreamUrl
&CasterId=a2b8e671-2fe5-4642-a2ec-bf93880e****
&<Common request parameters>
Sample success responses
XML
format
<DescribeCasterStreamUrlResponse>
<RequestId>16A96B9A-F203-4EC5-8E43-CB92E68F4CD8</RequestId>
<CasterId>a2b8e671-2fe5-4642-a2ec-bf93880e****</CasterId>
<CasterStreams>
<StreamUrl>rtmp://live/caster/1975ee99db904ebb83908d43bc87****?auth_key=1506396160-0-0-063397072a9980fd418d43eb00e0****</StreamUrl>
<SceneId>23ca74e0-aca3-4e7a-8561-9d96f525****</SceneId>
<OutputType>1</OutputType>
<StreamInfos>
<VideoFormat>flv</VideoFormat>
<OutputStreamUrl>http://live/caster/fb628e2469f94f2aa2c0c219af8b****_lld.flv?auth_key=1506396160-0-0-7de771a77102680861853af862d5****</OutputStreamUrl>
<TranscodeConfig>lld</TranscodeConfig>
</StreamInfos>
<StreamInfos>
<VideoFormat>rtmp</VideoFormat>
<OutputStreamUrl>rtmp://live/caster/fb628e2469f94f2aa2c0c219af8b****_lld?auth_key=1506396160-0-0-77ed32cd82ed32ccd51a832b5765****</OutputStreamUrl>
<TranscodeConfig>lld</TranscodeConfig>
</StreamInfos>
<StreamInfos>
<VideoFormat>m3u8</VideoFormat>
<OutputStreamUrl>http://live/caster/fb628e2469f94f2aa2c0c219af8b****.m3u8?auth_key=1506396160-0-0-d51f0512dcf76aa749f79f53ae64****</OutputStreamUrl>
<TranscodeConfig>lld</TranscodeConfig>
</StreamInfos>
</CasterStreams>
<CasterStreams>
<StreamUrl>rtmp://live/caster/3a2e3cf978f3496f96d44e28b542****?auth_key=1506396160-0-0-6182084bd33e93a72029764f5cfb****</StreamUrl>
<SceneId>9445dbed-7aef-4cae-925f-8a3a026f****</SceneId>
<OutputType>0</OutputType>
</CasterStreams>
</DescribeCasterStreamUrlResponse>
JSON
format
{
"RequestId": "16A96B9A-F203-4EC5-8E43-CB92E68F4CD8",
"CasterId": "a2b8e671-2fe5-4642-a2ec-bf93880e****",
"CasterStreams": [
{
"StreamUrl": "rtmp://live/caster/1975ee99db904ebb83908d43bc87****?auth_key=1506396160-0-0-063397072a9980fd418d43eb00e0****",
"SceneId": "23ca74e0-aca3-4e7a-8561-9d96f525****",
"OutputType": 1,
"StreamInfos": [
{
"VideoFormat": "flv",
"OutputStreamUrl": "http://live/caster/fb628e2469f94f2aa2c0c219af8b****_lld.flv?auth_key=1506396160-0-0-7de771a77102680861853af862d5****",
"TranscodeConfig": "lld"
},
{
"VideoFormat": "rtmp",
"OutputStreamUrl": "rtmp://live/caster/fb628e2469f94f2aa2c0c219af8b****_lld?auth_key=1506396160-0-0-77ed32cd82ed32ccd51a832b5765****",
"TranscodeConfig": "lld"
},
{
"VideoFormat": "m3u8",
"OutputStreamUrl": "http://live/caster/fb628e2469f94f2aa2c0c219af8b****.m3u8?auth_key=1506396160-0-0-d51f0512dcf76aa749f79f53ae64****",
"TranscodeConfig": "lld"
}
]
},
{
"StreamUrl": "rtmp://live/caster/3a2e3cf978f3496f96d44e28b542****?auth_key=1506396160-0-0-6182084bd33e93a72029764f5cfb****",
"SceneId": "9445dbed-7aef-4cae-925f-8a3a026f****",
"OutputType": 0
}
]
}
Error codes
For a list of error codes, visit the API Error Center.