DescribeCasterConfig - ApsaraVideo Live - Alibaba Cloud Documentation Center

Queries the configuration of a production studio.

Operation description

Call the CreateCaster operation to create a production studio. Then, call this operation to query its configuration.

QPS limit

This operation has a queries per second (QPS) limit of 15 calls per user. If you exceed the limit, your API calls are throttled, which can 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:DescribeCasterConfig

get

*Caster

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

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	No	The region ID.	cn-shanghai
CasterId	string	Yes	The ID of the production studio. If you create the production studio by calling the CreateCaster operation, use the CasterId value that is returned in the response. If you create the production studio in the console, go to the LIVE console > Production Studio > Cloud Production Studio page to view the ID. Note The name of the production studio in the list on the Cloud Production Studio page is the production studio ID.	LIVEPRODUCER_POST-cn-0pp1czt****

Response parameters

Parameter	Type	Description	Example
	object	The configuration of the production studio.
AutoSwitchUrgentConfig	string	The configuration for the automatic switchover to the standby video. `eofThres`: The duration in seconds after which the system automatically switches to the standby video if the stream is interrupted.	{"eofThres":3}
AutoSwitchUrgentOn	string	Indicates whether automatic switchover to the standby video is enabled. true: Enabled. false: Disabled.	true
CallbackUrl	string	The webhook address.	http://learn.aliyundoc.com/callBackLive
CasterId	string	The ID of the production studio.	LIVEPRODUCER_POST-cn-0pp1czt****
CasterName	string	The name of the production studio.	coco-caster10
ChannelEnable	integer	Indicates whether the channel is enabled. Valid values: 0: Disabled. 1: Enabled.	1
Delay	number	The stream delay. Unit: seconds. 0: Delay is disabled. A value greater than 0: Delay is enabled.	0
DomainName	string	The streaming domain.	example.com
ProgramEffect	integer	The carousel flag. Valid values: 0: Not effective. 1: Effective.	0
ProgramName	string	The name of the carousel.	program_name
RecordConfig	object	If this parameter is empty, the recording feature is disabled.
OnDemand	integer	On-demand recording. Valid values: 0: Disabled. 1: HTTP callback. 2: On-demand recording based on stream ingest parameters. 7: Recording is disabled by default.	0
OssBucket	string	The storage location.	liveBucket****
OssEndpoint	string	The OSS endpoint where the storage location resides.	oss-cn-shanghai.aliyundoc.com
RecordFormat	object
RecordFormat	array<object>	The recording format configuration.
	object	The recording length information.
CycleDuration	integer	The recording length.	3600
Format	string	The recording format.	M3U8
OssObjectPrefix	string	The name of the recording file.	record/{liveApp**}/{liveStream**}
SliceOssObjectPrefix	string	The name of the segment.	record/{liveApp**}/{liveStream}/{UnixTimestamp**}
RequestId	string	The request ID.	97df6b7f-3490-47d2-ac50-8833e1b64597
SideOutputUrl	string	The custom bypass output URL of the production studio.	rtmp://sophon-developer.aliyundoc.com/caster/4a82a3d1b7f0462ea37348366201**?auth_key=1608953344-0-0-ac8c628078541d7055a170ec59a5**
SideOutputUrlList	string	The list of custom bypass output URLs for the production studio.	["rtmp://domain/app1/stream1","rtmp://domain/app2/stream2"]
SyncGroupsConfig	object
SyncGroup	array<object>	The storage configuration.
	object	The storage configuration.
HostResourceId	string	The resource ID of the production studio.	28768383240243****
Mode	integer	The caching mode for static pages. Valid values: 0: Standard mode. 1: Strong Mode. 2: No caching.	0
ResourceIds	object
ResourceId	array	The list of IDs of the cloud resources whose resource group you want to change. You can specify from 1 to 50 resource IDs.
	string	The list of IDs of the cloud resources whose resource group you want to change. You can specify from 1 to 50 resource IDs.	1
TranscodeConfig	object	The transcoding configuration.
CasterTemplate	string	The transcoding template for the production studio. Valid values: lp_ld: Low definition. lp_sd: Standard definition. lp_hd: High definition. lp_ud: Ultra-high definition. lp_ld_v: Vertical low definition. lp_sd_v: Vertical standard definition. lp_hd_v: Vertical high definition. lp_ud_v: Vertical ultra-high definition.	lp_hd
LiveTemplateIds	object
LocationId	array	The live stream transcoding configuration.
	string	The live stream transcoding configuration. Valid values: lsd: Standard definition. lld: Low definition. lud: Ultra-high definition. lhd: High-definition adaptive transcoding template. daobo-lsd: Standard definition. daobo-lld: Low definition. daobo-lud: Ultra-high definition. daobo-lhd: High definition.	lld
CustomParams	object	Custom configuration
video	object	Video parameters
fps	integer	Video frame rate	300
bitrate	integer	Video bitrate	300
width	integer	The video width in pixels (px).	1080
height	integer	The video height in pixels (px).	720
UrgentImageId	string	The ID of the standby image asset in the media asset library.	a089175eb5f4427684fc0715159a****
UrgentImageUrl	string	The URL of the standby image asset.	http://learn.aliyundoc.com/AppName/image.jpg
UrgentLiveStreamUrl	string	The URL of the standby live stream.	rtmp://demo.aliyundoc.com
UrgentMaterialId	string	The ID of the standby video asset in the media asset library.	98646538-bcf9-4aef-bd4a-e6bb76588****

Examples

Success response

JSON format

{
  "AutoSwitchUrgentConfig": "{\"eofThres\":3}",
  "AutoSwitchUrgentOn": "true",
  "CallbackUrl": "http://learn.aliyundoc.com/callBackLive",
  "CasterId": "LIVEPRODUCER_POST-cn-0pp1czt****",
  "CasterName": "coco-caster10",
  "ChannelEnable": 1,
  "Delay": 0,
  "DomainName": "example.com",
  "ProgramEffect": 0,
  "ProgramName": "program_name",
  "RecordConfig": {
    "OnDemand": 0,
    "OssBucket": "liveBucket****",
    "OssEndpoint": "oss-cn-shanghai.aliyundoc.com",
    "RecordFormat": {
      "RecordFormat": [
        {
          "CycleDuration": 3600,
          "Format": "M3U8",
          "OssObjectPrefix": "record/{liveApp****}/{liveStream****}",
          "SliceOssObjectPrefix": "record/{liveApp****}/{liveStream****}/{UnixTimestamp****}"
        }
      ]
    }
  },
  "RequestId": "97df6b7f-3490-47d2-ac50-8833e1b64597",
  "SideOutputUrl": "rtmp://sophon-developer.aliyundoc.com/caster/4a82a3d1b7f0462ea37348366201****?auth_key=1608953344-0-0-ac8c628078541d7055a170ec59a5****",
  "SideOutputUrlList": "[\"rtmp://domain/app1/stream1\",\"rtmp://domain/app2/stream2\"]",
  "SyncGroupsConfig": {
    "SyncGroup": [
      {
        "HostResourceId": "28768383240243****",
        "Mode": 0,
        "ResourceIds": {
          "ResourceId": [
            "1"
          ]
        }
      }
    ]
  },
  "TranscodeConfig": {
    "CasterTemplate": "lp_hd",
    "LiveTemplateIds": {
      "LocationId": [
        "lld"
      ]
    },
    "CustomParams": {
      "video": {
        "fps": 300,
        "bitrate": 300,
        "width": 1080,
        "height": 720
      }
    }
  },
  "UrgentImageId": "a089175eb5f4427684fc0715159a****",
  "UrgentImageUrl": "http://learn.aliyundoc.com/AppName/image.jpg",
  "UrgentLiveStreamUrl": "rtmp://demo.aliyundoc.com",
  "UrgentMaterialId": "98646538-bcf9-4aef-bd4a-e6bb76588****"
}

Error codes

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

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.