DescribeCasterStreamUrl - ApsaraVideo Live - Alibaba Cloud Documentation Center

Queries the streaming URLs of a production studio.

Operation description

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

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:DescribeCasterStreamUrl	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 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.	a2b8e671-2fe5-4642-a2ec-bf93880e****

Response parameters

Parameter	Type	Description	Example
	object
CasterId	string	The ID of the production studio.	a2b8e671-2fe5-4642-a2ec-bf93880e****
CasterStreams	array<object>	The information about the streams of the production studio.
CasterStream	object
OutputType	integer	Indicates whether the output stream is in preview mode or program mode. 0: indicates that the output videos of the scene are in preview mode. 1: indicates that the output videos of the scene are in program mode.	1
RtmpUrl	string	The Real Time Messaging Protocol (RTMP) URL.	rtmp://live/caster/example.edu
SceneId	string	The ID of the scene.	23ca74e0-aca3-4e7a-8561-9d96f525****
StreamInfos	array<object>	The information about the stream.
StreamInfo	object
OutputStreamUrl	string	The streaming URL.	http://out/caster/example.net
TranscodeConfig	string	The resolution to which the scene transcodes the stream for playback. Valid values: lsd: standard definition. lld: low definition. lud: ultra high definition. lhd: high definition.	lld
VideoFormat	string	The format to which the scene transcodes the stream for playback. Valid values: flv. rtmp. m3u8.	flv
StreamUrl	string	The streaming URL.	http://live/caster/example.org
RequestId	string	The ID of the request.	16A96B9A-F203-4EC5-8E43-CB92E68F4CD8
Total	integer	The number of streams that were returned.	1

Examples

Sample success responses

JSONformat

{
  "CasterId": "a2b8e671-2fe5-4642-a2ec-bf93880e****",
  "CasterStreams": {
    "CasterStream": [
      {
        "OutputType": 1,
        "RtmpUrl": "rtmp://live/caster/example.edu",
        "SceneId": "23ca74e0-aca3-4e7a-8561-9d96f525****",
        "StreamInfos": {
          "StreamInfo": [
            {
              "OutputStreamUrl": "http://out/caster/example.net",
              "TranscodeConfig": "lld",
              "VideoFormat": "flv"
            }
          ]
        },
        "StreamUrl": "http://live/caster/example.org"
      }
    ]
  },
  "RequestId": "16A96B9A-F203-4EC5-8E43-CB92E68F4CD8",
  "Total": 1
}

Error codes

HTTP status code	Error code	Error message
400	InvalidUserId.Malformed	%s
400	InvalidCasterId.Malformed	%s
401	IllegalOperation	%s
404	InvalidCaster.NotFound	%s
404	InvalidScene.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
2023-03-14	The Error code has changed	View Change Details