DescribeCasters

Queries the list of production studios.

Operation description

Create a production studio by calling the CreateCaster operation, and then call this operation to query the list of production studios. A production studio can be in the idle or streaming state.

Note

The account that calls this operation must have ApsaraVideo Live activated.

QPS limit

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

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

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	No	The production studio ID. If you created the production studio by calling the CreateCaster operation, check the CasterId parameter 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 production studio name in the production studio list on the Cloud Production Studio page is the production studio ID. If this parameter is left empty, the merged data of all production studios is returned by default.	LIVEPRODUCER_POST-cn-0pp1czt****
CasterName	string	No	The name of the production studio.	liveCaster****
StartTime	string	No	The start time. Format: yyyy-MM-ddTHH:mm:ssZ (UTC).	2016-06-29T09:00:00Z
EndTime	string	No	The end time. Format: yyyy-MM-ddTHH:mm:ssZ (UTC).	2016-06-29T11:00:00Z
PageNum	integer	No	The page number.	1
PageSize	integer	No	The number of entries per page. Default value: 100.	100
Status	integer	No	The status. Valid values: 0: idle. 1: streaming.	0
ChargeType	integer	No	The billing method. Valid values: 0: PrePaid (subscription). 1: PostPaid (pay-as-you-go).	0
OrderByModifyAsc	string	No	Specifies whether to sort the production studios in ascending order by modification time. Valid values: true (ascending order by modification time) \| false (descending order by modification time, which is the default value). Note If this parameter is not specified, the default value is "false".	false
NormType	string	No	The specification type of the production studio. Valid values: 1: general mode. 3: lightweight playlist mode. 4: virtual studio mode. 6: playlist mode (new playlist mode production studio).	1
ResourceGroupId	string	No	The resource group ID. For more information about resource groups, see What is a resource group.	rg-aekzw******
Tag	array<object>	No	The list of tags.
	object	No	The list of tags.
Key	string	No	The tag key.	TestKey
Value	string	No	The tag value.	TestValue

Response elements

Element	Type	Description	Example
	object	The query result of the production studio list.
CasterList	object
Caster	array<object>	The list of production studios.
	array<object>	The production studio information.
CasterId	string	The ID of the production studio. This ID is used as a request parameter for other operations, such as querying stream URLs, starting a production studio, adding video resources, adding layouts, querying layouts, adding components, and adding playlists.	LIVEPRODUCER_POST-cn-0pp1czt****
CasterName	string	The name of the production studio.	liveCaster****
CasterTemplate	string	The resolution of the production studio. This parameter is required if the billing method is subscription. 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_ld
ChannelEnable	integer	Indicates whether the channel is enabled. 0: No. 1: Yes.	1
ChargeType	string	The billing method. PrePaid: subscription. PostPaid: pay-as-you-go.	PrePaid
CreateTime	string	The time when the production studio was created.	2017-08-30T12:02:57Z
Duration	string	The duration. The format is hh:mm:ss.	1:02:33
ExpireTime	string	The expiration time of the production studio.	2018-08-30T12:02:57Z
LastModified	string	The time when the production studio was last modified. For example, the time when the production studio was started, stopped, or configured.	2021-12-01T05:08:45Z
NormType	integer	The type of the production studio. Valid values: 0: Playlist mode. 1: Standard.	1
PurchaseTime	string	The time when the production studio was purchased.	2017-08-30T12:02:57Z
StartTime	string	The time when the production studio was started. This parameter is returned only when the production studio is in the In Production state.	2017-08-30T18:02:57Z
Status	integer	The status. Valid values: 0: Idle. 1: In Production.	1
ClientTokenId	string	A client-generated token that is used to ensure the idempotence of the request. The token must be unique among different requests and can contain a maximum of 64 ASCII characters.	53200b81-b761-4c10-842a-a0726d97****
Tags	object
tag	array<object>	The list of tags.
	object	The tag.
TagKey	string	The tag key.	TestKey
TagValue	string	The tag value.	TestValue
ResourceGroupId	string	The ID of the resource group. For more information, see What is a resource group?.	rg-acfmz******
RequestId	string	The request ID.	5c6a2a0df228-4a64- af62-20e91b******
Total	integer	The total number of production studios.	1

Examples

Success response

JSON format

{
  "CasterList": {
    "Caster": [
      {
        "CasterId": "LIVEPRODUCER_POST-cn-0pp1czt****",
        "CasterName": "liveCaster****",
        "CasterTemplate": "lp_ld",
        "ChannelEnable": 1,
        "ChargeType": "PrePaid",
        "CreateTime": "2017-08-30T12:02:57Z",
        "Duration": "1:02:33",
        "ExpireTime": "2018-08-30T12:02:57Z",
        "LastModified": "2021-12-01T05:08:45Z",
        "NormType": 1,
        "PurchaseTime": "2017-08-30T12:02:57Z",
        "StartTime": "2017-08-30T18:02:57Z",
        "Status": 1,
        "ClientTokenId": "53200b81-b761-4c10-842a-a0726d97****\n",
        "Tags": {
          "tag": [
            {
              "TagKey": "TestKey",
              "TagValue": "TestValue"
            }
          ]
        },
        "ResourceGroupId": "rg-acfmz******"
      }
    ]
  },
  "RequestId": "5c6a2a0df228-4a64- af62-20e91b******",
  "Total": 1
}

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidUserId.Malformed	%s, please check userId.	The userId passed in is invalid, please check.
400	MissingParameter	%s.	Missing parameter
400	InvalidParameter.Malformed	There are invalid parameters: %s.	There are invalid parameters: %s.
400	InvalidParameter.Status	%s, please check and try again.	Status is invalid, please check and try again.
400	InvalidParameter.StartTime	%s, please check and try again later.	The parameter StartTime is invalid, please check and try again.
400	InvalidParameter.EndTime	%s, please check and try again later.	The parameter EndTime is invalid, please check and try again.
400	LiveServiceNotFound	%s, please check and try again later.	The live service is not enabled. Please check and try again.
400	InvalidParameter.PageSize	%s, please check and try again later.	The parameter PageSize is invalid, please check and try again.
400	InvalidParameter.PageNum	%s, please check and try again later.	The parameter PageNum is invalid, please check and try again.
403	PermissionDenied	%s, please check and try again later.	Access denied, please check and try again.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.