Queries the information about production studios.

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.

CasterName String No caster001

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 number of the page to return.

PageSize Integer No 5

The number of entries to return on each page.

Status Integer No 0

The status of the production studio. Valid values:

  • 0: idle.
  • 1: streaming.
RegionId String No cn-shanghai

The ID of the region.

Response parameters

Parameter Type Example Description
CasterList Array of Caster

The information about each production studio.

Caster
CasterId String LIVEPRODUCER_POST-cn-0pp1czt****

The ID of the production studio.

CasterName String coco-caster2

The name of the production studio.

CasterTemplate String lp_ld

The resolution in which the production studio plays videos. This parameter is required for subscription production studios. Valid values:

  • lp_ld: The production studio plays videos in the low definition.
  • lp_sd: The production studio plays videos in the standard definition.
  • lp_hd: The production studio plays videos in the high definition.
  • lp_ud: The production studio plays videos in the ultra high definition.
  • lp_ld_v: The production studio plays videos in the low definition and in portrait mode.
  • lp_sd_v: The production studio plays videos in the standard definition and in portrait mode.
  • lp_hd_v: The production studio plays videos in the high definition and in portrait mode.
  • lp_ud_v: The production studio plays videos in the ultra high definition and in portrait mode.
ChannelEnable Integer 1

Indicates whether channels are enabled for the production studio.

  • 0: Channels are disabled.
  • 1: Channels are enabled.
ChargeType String PrePaid

The billing method of the production studio. Only the pay-as-you-go billing method is supported now. Valid values:

  • PrePaid: subscription.
  • PostPaid: pay-as-you-go.
CreateTime String 2017-08-30 12:02:57.0

The time when the production studio was created.

ExpireTime String 2018-08-30 12:02:57.0

The expiration time of the production studio.

NormType Integer 1

The type of the production studio. Valid values:

  • 0: the near VOD mode.
  • 1: the studio mode.
PurchaseTime String 2017-08-30 12:02:57.0

The time when the production studio was purchased.

StartTime String 2017-08-30 18:02:57.0

The start time of the current streaming. This parameter is returned when the production studio is streaming.

Status Integer 1

The status of the production studio. Valid values:

  • 0: idle.
  • 1: streaming.
RequestId String 6159ba01-6687-4fb2-a831-f0cd8d188648

The ID of the request.

Total Integer 1

The total number of production studios that were returned.

Examples

Sample requests

http(s)://live.aliyuncs.com/? Action=DescribeCasters
&<Common request parameters>

Sample success responses

XML format

<DescribeCastersResponse>
  <RequestId>D81E449E-6420-42A3-8525-BCCB6E87323F</RequestId>
  <Total>1</Total>
  <CasterList>
        <Caster>
              <Status>0</Status>
              <CasterName>LIVEPRODUCER_POST-cn-v0h1557****</CasterName>
              <ChannelEnable>1</ChannelEnable>
              <ChargeType>PostPaid</ChargeType>
              <CreateTime>2019-05-23T12:31:48Z</CreateTime>
              <NormType>0</NormType>
              <CasterId>LIVEPRODUCER_POST-cn-v0h1557****</CasterId>
        </Caster>
  </CasterList>
</DescribeCastersResponse>

JSON format

{
	"RequestId": "D81E449E-6420-42A3-8525-BCCB6E87323F",
	"Total": 1,
	"CasterList": {
		"Caster": [
			{
				"Status": 0,
				"CasterName": "LIVEPRODUCER_POST-cn-v0h1557****",
				"ChannelEnable": 1,
				"ChargeType": "PostPaid",
				"CreateTime": "2019-05-23T12:31:48Z",
				"NormType": 0,
				"CasterId": "LIVEPRODUCER_POST-cn-v0h1557****"
			}
		]
	}
}

Error codes

For a list of error codes, visit the API Error Center.