DescribeCasterConfig API Reference for Production Studio - ApsaraVideo Live - Alibaba Cloud - ApsaraVideo Live

Queries the configuration information of a production studio.

Operation description

Create a production studio by calling the CreateCaster operation, and then call this operation to query the configuration information of the production studio.

QPS limit

The single-user QPS limit for this operation is 15 calls per second. If the limit is exceeded, the API call is throttled, which may affect your business. Call this operation appropriately.

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 production studio ID. If you created the production studio by calling the CreateCaster operation, check the CasterId parameter value returned by the CreateCaster operation. If you created the production studio in the ApsaraVideo Live console, go to ApsaraVideo Live console > Production Studios > Cloud Production Studio to view the ID. Note The name of the production studio in the production studio list on the Cloud Production Studio page is the production studio ID.	LIVEPRODUCER_POST-cn-0pp1czt****

Response elements

Element	Type	Description	Example
	object	The configuration information of the production studio.
AutoSwitchUrgentConfig	string	The automatic standby video switching configuration. `eofThres`: specifies the duration of stream interruption before automatically switching to the standby video. Unit: seconds.	{"eofThres":3}
AutoSwitchUrgentOn	string	Indicates whether automatic switchover to the standby video upon stream interruption is enabled. true: Enabled. false: Shutdown.	true
CallbackUrl	string	The user callback URL.	http://learn.aliyundoc.com/callBackLive
CasterId	string	The production studio ID.	LIVEPRODUCER_POST-cn-0pp1czt****
CasterName	string	The production studio name.	coco-caster10
ChannelEnable	integer	Indicates whether Channel is enabled. Valid values: 0: Disabled. 1: Enabled.	1
Delay	number	The stream delay. Unit: seconds. 0: Stream delay is disabled. Greater than 0: Stream delay is enabled.	0
DomainName	string	The primary streaming domain.	example.com
ProgramEffect	integer	The playlist effective flag. Valid values: 0: Not effective. 1: Effective.	0
ProgramName	string	The playlist name.	program_name
RecordConfig	object	The recording configuration. If this parameter is empty, the recording feature is not enabled.
OnDemand	integer	The on-demand recording mode. Valid values: 0: Disabled. 1: HTTP callback-based. 2: On-demand recording by parsing stream ingest parameters. 7: Not recorded by default.	0
OssBucket	string	The storage location.	liveBucket****
OssEndpoint	string	The OSS endpoint of the storage location.	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 side 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 side output URLs of the production studio.	["rtmp://domain/app1/stream1","rtmp://domain/app2/stream2"]
SyncGroupsConfig	object
SyncGroup	array<object>	The storage configuration.
	array<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 production studio transcoding template. Valid values: lp_ld: low definition. lp_sd: standard definition. lp_hd: high definition. lp_ud: ultra-high definition. lp_ld_v: portrait low definition. lp_sd_v: portrait standard definition. lp_hd_v: portrait high definition. lp_ud_v: portrait 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	The 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 media library asset ID of the standby image.	a089175eb5f4427684fc0715159a****
UrgentImageUrl	string	The URL of the standby image.	http://learn.aliyundoc.com/AppName/image.jpg
UrgentLiveStreamUrl	string	The URL of the standby live stream.	rtmp://demo.aliyundoc.com
UrgentMaterialId	string	The media library asset ID of the standby video.	98646538-bcf9-4aef-bd4a-e6bb76588****
AudioMixerMode	string

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****",
  "AudioMixerMode": ""
}

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidCasterId.Malformed	%s, please check and try again later.	The parameter CasterId is invalid, please check and try again.
401	IllegalOperation	%s, please check and try again later.	Operation not allowed, please check and try again.
500	InternalError	%s, please try again later.	Internal error, please try again later.
404	InvalidCaster.NotFound	%s, please check and try again later.	The guide station does not exist, please check and try again.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.