All Products
Search

This Product

    ApsaraVideo Live:DescribeCasters

    Document Center

    ApsaraVideo Live:DescribeCasters

    Last Updated:Dec 05, 2024

    Queries the list of production studios.

    Operation description

    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.

    Debugging

    You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

    Authorization information

    The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

    • Operation: the value that you can use in the Action element to specify the operation on a resource.
    • Access level: the access level of each operation. The levels are read, write, and list.
    • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
      • The required resource types are displayed in bold characters.
      • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
    • Condition Key: the condition key that is defined by the cloud service.
    • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
    OperationAccess levelResource typeCondition keyAssociated operation
    live:DescribeCastersget
    *Caster
    acs:live:*:{#accountId}:caster/{#CasterId}
      none
    		none

    Request parameters

    ParameterTypeRequiredDescriptionExample
    CasterIdstringNo

    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 ID/Name column.

    • If you leave this parameter empty, the data of all production studios is returned.

    		LIVEPRODUCER_POST-cn-0pp1czt****
    CasterNamestringNo

    The name of the production studio.

    		liveCaster****
    StartTimestringNo

    The beginning 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
    EndTimestringNo

    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
    PageNumintegerNo

    The number of the page to return.

    		1
    PageSizeintegerNo

    The number of templates to return on each page. If you leave this parameter empty, the default value is used. Default value: 100.

    		100
    StatusintegerNo

    The status of the production studio. Valid values:

    • 0: idle
    • 1: streaming
    		0
    ChargeTypeintegerNo

    The billing method. Valid values:

    • 0: the subscription billing method
    • 1: the pay-as-you-go billing method
    		0
    OrderByModifyAscstringNo

    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 is used. Default value: false.
    		false
    NormTypestringNo

    The type of the production studio. Valid values:

    • 1: general mode
    • 3: lightweight carousel playback mode
    • 4: virtual studio
    • 6: playlist mode
    		1
    ResourceGroupIdstringNo

    The resource group ID. For more information about resource groups, see Resource groups.

    		rg-aekzw******
    Tagarray<object>No

    The tags.

    objectNo

    The tag.

    KeystringNo

    The key of the tag.

    		TestKey
    ValuestringNo

    The value of the tag.

    		TestValue

    Response parameters

    ParameterTypeDescriptionExample
    object

    The number of production studios.

    CasterListarray<object>

    The production studios.

    Casterobject

    The information about the production studio.

    CasterIdstring

    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.

    		LIVEPRODUCER_POST-cn-0pp1czt****
    CasterNamestring

    The name of the production studio.

    		liveCaster****
    CasterTemplatestring

    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)
    		lp_ld
    ChannelEnableinteger

    Indicates whether the channel is enabled for the production studio.

    • 0: The channel is disabled.
    • 1: The channel is enabled.
    		1
    ChargeTypestring

    The billing method. Valid values:

    • PrePaid: the subscription billing method
    • PostPaid: the pay-as-you-go billing method
    		PrePaid
    CreateTimestring

    The time when the production studio was created.

    		2017-08-30 12:02:57.0
    Durationstring

    The streaming duration. Format: hh:mm:ss.

    		1:02:33
    ExpireTimestring

    The time when the production studio expires.

    		2018-08-30 12:02:57.0
    LastModifiedstring

    The time when the production studio was last modified. For example, the time when the production studio was last started, stopped, or modified is returned.

    		2021-12-01T05:08:45Z
    NormTypeinteger

    The type of the production studio. Valid values:

    • 0: playlist mode
    • 1: general mode
    		1
    PurchaseTimestring

    The time when the production studio was purchased.

    		2017-08-30 12:02:57.0
    StartTimestring

    The time when the production studio was started. This parameter is returned if the production studio is in the streaming status.

    		2017-08-30 18:02:57.0
    Statusinteger

    The status of the production studio. Valid values:

    • 0: idle
    • 1: streaming
    		1
    ResourceGroupIdinteger

    The resource group ID. For more information about resource groups, see Resource groups.

    		rg-aekzw******
    ClientTokenIdstring

    The client token that is used to ensure the idempotence of the request.

    		53200b81-b761-4c10-842a-a0726d97****
    Tagsarray<object>

    The tags.

    tagobject

    The tag.

    TagKeystring

    The key of the tag.

    		TestKey
    TagValuestring

    The value of the tag.

    		TestValue
    RequestIdstring

    The request ID.

    		5c6a2a0df228-4a64- af62-20e91b9676b3
    Totalinteger

    The number of production studios.

    		1

    Examples

    Sample success responses

    JSONformat

    {
  "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,
        "ResourceGroupId": 0,
        "ClientTokenId": "53200b81-b761-4c10-842a-a0726d97****\n",
        "Tags": {
          "tag": [
            {
              "TagKey": "TestKey",
              "TagValue": "TestValue"
            }
          ]
        }
      }
    ]
  },
  "RequestId": "5c6a2a0df228-4a64- af62-20e91b9676b3",
  "Total": 1
}

    Error codes

    HTTP status codeError codeError message
    400InvalidUserId.Malformed%s
    400MissingParameter%s
    400InvalidParameter.Malformed%s
    400InvalidParameter.PageSize%s
    400InvalidParameter.PageNum%s
    400InvalidParameter.Status%s
    400InvalidParameter.StartTime%s
    400InvalidParameter.EndTime%s
    400LiveServiceNotFound%s
    403PermissionDenied%s
    500InternalError%s

    For a list of error codes, visit the Service error codes.

    Change history

    Change timeSummary of changesOperation
    2024-09-27The Error code has changed. The request parameters of the API has changed. The response structure of the API has changedView Change Details
    2024-08-21The Error code has changed. The request parameters of the API has changed. The response structure of the API has changedView Change Details