DescribeCasters - ApsaraVideo Live

Usage notes

You can call the CreateCaster operation to create a production studio and then call this operation to query the production studio list. The status of a production studio can be idle or streaming.

QPS limit

You can call this operation up to 15 times per second per account. Requests that exceed this limit are dropped and you will experience service interruptions. We recommend that you take note of this limit when you call this operation. For more information, see QPS limits.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter	Type	Required	Example	Description
Action	String	Yes	DescribeCasters	The operation that you want to perform. Set the value to DescribeCasters.
CasterId	String	No	LIVEPRODUCER_POST-cn-0pp1czt****	The ID of the production studio. If the production studio was created by calling the CreateCaster operation, check the value of the response parameter CasterId to obtain the ID. If the production studio was created by using the ApsaraVideo Live console, obtain the ID on the Production Studio Management page. To go to the page, log on to the ApsaraVideo Live console and click Production Studios in the left-side navigation pane. Note You can find the ID of the production studio in the Instance Name column.
CasterName	String	No	liveCaster****	The name of the production studio.
StartTime	String	No	2016-06-29T09:00:00Z	The beginning of the time range to query. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.
EndTime	String	No	2016-06-29T11:00:00Z	The end of the time range to query. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.
PageNum	Integer	No	1	The page number.
PageSize	Integer	No	100	The number of entries to return on each page. If you leave this parameter empty, the default value 100 is used.
Status	Integer	No	0	The status of the production studio. Valid values: 0: idle 1: streaming
ChargeType	Integer	No	0	The billing method. Valid values: 0: subscription 1: pay-as-you-go
OrderByModifyAsc	String	No	false	Specifies whether to sort the production studios in ascending order based on the modification time. Note If you leave this parameter empty, the default value false is used.
NormType	String	No	1	The type of the production studio. Valid values: 1: general mode 3: lightweight carousel playback mode 4: virtual studio 6: playlist mode

Response parameters

Parameter	Type	Example	Description
Total	Integer	1	The number of production studios.
RequestId	String	5c6a2a0df228-4a64- af62-20e91b9676b3	The request ID.
CasterList	Array of Caster		The information about the production studio.
Caster
Status	Integer	1	The status of the production studio. Valid values: 0: idle 1: streaming
PurchaseTime	String	2017-08-30 12:02:57.0	The time when the production studio was purchased.
ExpireTime	String	2018-08-30 12:02:57.0	The time when the production studio expires.
CreateTime	String	2017-08-30 12:02:57.0	The time when the production studio was created.
CasterName	String	liveCaster****	The name of the production studio.
ChargeType	String	PrePaid	The billing method. PrePaid: subscription PostPaid: pay-as-you-go
CasterTemplate	String	lp_ld	The resolution in which the production studio plays videos. This parameter is returned if the subscription billing method is used. Valid values: lp_ld: low definition lp_sd: standard definition lp_hd: high definition lp_ud: ultra high definition lp_ld_v: low definition (portrait mode) lp_sd_v: standard definition (portrait mode) lp_hd_v: high definition (portrait mode) lp_ud_v: ultra high definition (portrait mode)
CasterId	String	LIVEPRODUCER_POST-cn-0pp1czt****	The ID of the production studio. You can specify the ID in a request to query the streaming URLs of the production studio, start the production studio, add a video resource, a layout, a component, or a playlist to the production studio, or query layouts of the production studio.
ChannelEnable	Integer	1	Indicates whether channels are enabled for the production studio. 0: Channels are disabled. 1: Channels are enabled.
LastModified	String	2021-12-01T05:08:45Z	The time when the production studio was last modified. For example, the time when the production studio was last started, stopped, or updated is returned.
StartTime	String	2017-08-30 18:02:57.0	The time when the production studio was started. This parameter is returned if the production studio is in the streaming status.
NormType	Integer	1	The type of the production studio. Valid values: 0: playlist mode 1: general mode
Duration	String	1:02:33	The streaming duration. Format: hh:mm:ss.

Examples

Sample requests

http(s)://live.aliyuncs.com/?Action=DescribeCasters
&CasterId=LIVEPRODUCER_POST-cn-0pp1czt****
&CasterName=liveCaster****
&StartTime=2016-06-29T09:00:00Z
&EndTime=2016-06-29T11:00:00Z
&PageNum=1
&PageSize=100
&Status=0
&ChargeType=0
&OrderByModifyAsc=false
&NormType=1
&<Common request parameters>

Sample success responses

XML format

HTTP/1.1 200 OK
Content-Type:application/xml

<DescribeCastersResponse>
    <Total>1</Total>
    <RequestId>5c6a2a0df228-4a64- af62-20e91b9676b3</RequestId>
    <CasterList>
        <Status>1</Status>
        <PurchaseTime>2017-08-30 12:02:57.0</PurchaseTime>
        <ExpireTime>2018-08-30 12:02:57.0</ExpireTime>
        <CreateTime>2017-08-30 12:02:57.0</CreateTime>
        <CasterName>liveCaster****</CasterName>
        <ChargeType>PrePaid</ChargeType>
        <CasterTemplate>lp_ld</CasterTemplate>
        <CasterId>LIVEPRODUCER_POST-cn-0pp1czt****</CasterId>
        <ChannelEnable>1</ChannelEnable>
        <LastModified>2021-12-01T05:08:45Z</LastModified>
        <StartTime>2017-08-30 18:02:57.0</StartTime>
        <NormType>1</NormType>
        <Duration>1:02:33</Duration>
    </CasterList>
</DescribeCastersResponse>

JSON format

HTTP/1.1 200 OK
Content-Type:application/json

{
  "Total" : 1,
  "RequestId" : "5c6a2a0df228-4a64- af62-20e91b9676b3",
  "CasterList" : [ {
    "Status" : 1,
    "PurchaseTime" : "2017-08-30 12:02:57.0",
    "ExpireTime" : "2018-08-30 12:02:57.0",
    "CreateTime" : "2017-08-30 12:02:57.0",
    "CasterName" : "liveCaster****",
    "ChargeType" : "PrePaid",
    "CasterTemplate" : "lp_ld",
    "CasterId" : "LIVEPRODUCER_POST-cn-0pp1czt****",
    "ChannelEnable" : 1,
    "LastModified" : "2021-12-01T05:08:45Z",
    "StartTime" : "2017-08-30 18:02:57.0",
    "NormType" : 1,
    "Duration" : "1:02:33"
  } ]
}

Error codes

For a list of error codes, see Service error codes.