DescribeCasters - ApsaraVideo Live - Alibaba Cloud Documentation Center

Queries a list of production studios.

Operation description

You can call the CreateCaster operation to create a production studio. You can then call this operation to query a list of production studios. A production studio can be in an Idle or In Production state.

Note

Before you call this operation, you must activate LIVE.

QPS limit

This operation is limited to 15 queries per second (QPS) per user. If you exceed this limit, your API calls are throttled. This may affect your business. Plan your API 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: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 ID of the production studio. If you create a production studio by calling the CreateCaster operation, use the CasterId value returned in the response. If you create a production studio in the LIVE console, find the ID on the LIVE Console > Production Studio > Cloud Production Studio page. Note The name of the production studio in the list on the Cloud Production Studio page serves as its ID. If you do not specify this parameter, information about all production studios is returned.	LIVEPRODUCER_POST-cn-0pp1czt****
CasterName	string	No	The name of the production studio.	liveCaster****
StartTime	string	No	The start of the time range to query. Specify the time in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.	2016-06-29T09:00:00Z
EndTime	string	No	The end of the time range to query. Specify the time in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.	2016-06-29T11:00:00Z
PageNum	integer	No	The page number.	1
PageSize	integer	No	The number of entries to return on each page. If you do not specify this parameter, the default value is 100.	100
Status	integer	No	The status. Valid values: 0: Idle. 1: In Production.	0
ChargeType	integer	No	The billing method. Valid values: 0: subscription. 1: pay-as-you-go.	0
OrderByModifyAsc	string	No	Specifies whether to sort the results by modification time in ascending order. Note If you do not specify this parameter, the default value is false.	false
NormType	string	No	The type of the production studio. Valid values: 1: Standard. 3: Lightweight carousel. 4: Virtual studio. 6: Carousel (new playlist mode).	1
ResourceGroupId	string	No	The ID of the resource group. For more information, 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 parameters

Parameter	Type	Description	Example
	object	The response object.
CasterList	object
Caster	array<object>	The information about the production studios.
	object	The information about the production studio.
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-30 12:02:57.0
Duration	string	The duration. The format is hh:mm:ss.	1:02:33
ExpireTime	string	The expiration time of the production studio.	2018-08-30 12:02:57.0
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-30 12:02:57.0
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-30 18:02:57.0
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-30 12:02:57.0",
        "Duration": "1:02:33",
        "ExpireTime": "2018-08-30 12:02:57.0",
        "LastModified": "2021-12-01T05:08:45Z",
        "NormType": 1,
        "PurchaseTime": "2017-08-30 12:02:57.0",
        "StartTime": "2017-08-30 18:02:57.0",
        "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
400	InvalidUserId.Malformed	%s
400	MissingParameter	%s
400	InvalidParameter.Malformed	%s
400	InvalidParameter.PageSize	%s
400	InvalidParameter.PageNum	%s
400	InvalidParameter.Status	%s
400	InvalidParameter.StartTime	%s
400	InvalidParameter.EndTime	%s
400	LiveServiceNotFound	%s
500	InternalError	%s
403	PermissionDenied	%s

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.