DescribeCasterStreamUrl - ApsaraVideo Live - Alibaba Cloud Documentation Center

Queries the stream URL of a production studio.

Operation description

Before you call this operation, call the CreateCaster operation to create a production studio. If a production studio has not been created, the InvalidScene.NotFound error is returned.

QPS limit

The queries per second (QPS) limit for this operation is 5 for each user. Calls that exceed this limit are throttled. This may affect your business. Plan your calls accordingly.

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

get

*Caster

acs:live:*:{#accountId}:caster/{#CasterId}

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	No	The ID of the region.	cn-shanghai
CasterId	string	Yes	The ID of the production studio. Make sure that the CasterId is correct. If you create a production studio by calling the CreateCaster operation, obtain the ID from the CasterId parameter in the response. If you create a production studio in the ApsaraVideo Live console, go to the ApsaraVideo Live console and choose Production Studio > Cloud Production Studio to view the ID. Note The name of a production studio in the list on the Cloud Production Studio page is its ID.	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	object
CasterStream	array<object>	A list of production studio streams.
	object
OutputType	integer	Indicates whether the stream is for final output. 0: The stream is for preview. 1: The stream is for final output.	1
RtmpUrl	string	The RTMP URL.	rtmp://live/caster/example.edu
SceneId	string	The ID of the scenario.	23ca74e0-aca3-4e7a-8561-9d96f525****
StreamInfos	object
StreamInfo	array<object>	A list of playback URLs.
	object
OutputStreamUrl	string	The playback URL.	http://out/caster/example.net
TranscodeConfig	string	The transcoding configuration. Valid values: lsd: standard definition lld: low definition lud: ultra-high definition lhd: high definition	lld
VideoFormat	string	The format. Valid values: flv rtmp m3u8 artc Note The streaming domain for the production studio must have the Real-Time Streaming (RTS) feature enabled to return a URL that uses the ARTC protocol. For more information about how to enable the feature, see Enable Real-Time Streaming (RTS).	flv
StreamUrl	string	The output stream URL.	http://live/caster/example.org
RequestId	string	The ID of the request.	16A96B9A-F203-4EC5-8E43-CB92E6******
Total	integer	The total number of entries.	1

Examples

Success response

JSON format

{
  "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-CB92E6******",
  "Total": 1
}

Error codes

HTTP status code	Error code	Error message
400	InvalidUserId.Malformed	%s
400	InvalidCasterId.Malformed	%s
401	IllegalOperation	%s
500	InternalError	%s
404	InvalidCaster.NotFound	%s
404	InvalidScene.NotFound	%s
404	InvalidDomainName.NotFound	%s

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.