DescribeAutoShowListTasks - ApsaraVideo Live - Alibaba Cloud Documentation Center

Queries the scheduled tasks that are used to start and stop playlists at the specified points in time.

Operation description

You can call this operation to query the scheduled tasks that are used to start and stop playlists at the specified points in time. Make sure that the parameter settings are valid for calling this operation.

QPS limit

You can call this operation up to 10 times per second per account. If the number of calls per second exceeds the limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limit when you call this operation. For more information, see QPS limit on an API operation in ApsaraVideo Live.

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.

Debug

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.

Operation	Access level	Resource type	Condition key	Associated operation
live:DescribeAutoShowListTasks	get	Caster `acs:live::{#accountId}:caster/{#CasterId}`	none	none

Request parameters

Parameter	Type	Required	Description	Example
CasterId	string	No	The ID of the streaming panel for which you want to query scheduled tasks. Note If you create scheduled tasks by calling the InitializeAutoShowListTask operation, check the value of the CasterId parameter in the response of the InitializeAutoShowListTask operation to obtain the ID of the streaming panel. If you do not specify this parameter when you call the DescribeAutoShowListTasks operation, the system queries all the scheduled tasks that belong to the user specified by the OwnerId parameter.	53200b81-b761-4c10-842a-a0726d97****

Response parameters

Parameter	Type	Description	Example
	object
AutoShowListTasks	string	The list of scheduled tasks. The following fields are returned: Status: the status of the scheduled task. Valid values: 0 and 1. A value of 0 indicates that the scheduled task is paused. A value of 1 indicates that the scheduled task is started. LiveTemplate: the list of templates used for transcoding. TranscodeConfig: the output resolution specified for video transcoding of the source URL. CasterId : the ID of the streaming panel.	{"Status":0,"TranscodeConfig":{"CasterTemplate":"lp_hd", "LiveTemplate":["lhd","lsd"]}, "CasterId":"cce04ef3-2226-4865-8704-f84b8375****"}
RequestId	string	The ID of the request.	16A96B9A-F203-4EC5-8E43-CB92E68F4CD8

Sample code

public void DescribeAutoShowListTasks() throws ClientException {
        CommonRequest describeAutoShowListTasksRequest = new CommonRequest();
        describeAutoShowListTasksRequest.setAction("DescribeAutoShowListTasks");
        describeAutoShowListTasksRequest.setDomain("live.aliyuncs.com");
        describeAutoShowListTasksRequest.setVersion("2016-11-01");
        DefaultAcsClient client = initClient(ACCESS_KEY_ID, ACCESS_KEY_SECRET);
        CommonResponse commonResponse = client.getCommonResponse(describeAutoShowListTasksRequest);
        System.out.printf("Status is %s and Response is:\n", commonResponse.getHttpStatus());
        JSONObject jsonObject = JSON.parseObject(commonResponse.getData());
        System.out.println(JSON.toJSONString(jsonObject, true));

    }

Sample response in the JSON format

{
  "RequestId": "04F5D5E0-9FAA-13CB-96A9-850FB06E9A82",
  "AutoShowListTasks": [
    {
      "Status": 0,
      "EndTime": 1645594715228,
      "ResourceIds": "[\"6ae09369cab349a78dab7a0c350d****\"]",
      "StartTime": 1645594115228,
      "TranscodeConfig": {
        "CasterTemplate": "lp_hd",
        "LiveTemplate": [
          "lhd",
          "lsd"
        ]
      },
      "CasterId": "e18b0c36-c0b5-47c1-81fd-7d783b5c****"
    }
  ]
}

Examples

Sample success responses

JSONformat

{
  "AutoShowListTasks": "{\"Status\":0,\"TranscodeConfig\":{\"CasterTemplate\":\"lp_hd\", \"LiveTemplate\":[\"lhd\",\"lsd\"]}, \"CasterId\":\"cce04ef3-2226-4865-8704-f84b8375****\"}",
  "RequestId": "16A96B9A-F203-4EC5-8E43-CB92E68F4CD8"
}

Error codes

HTTP status code	Error code	Error message
400	InvalidUserId.Malformed	%s
400	InvalidParameter.Malformed	%s
400	InvalidCasterId.Malformed	%s
400	InvalidVodUrl.Malformed	%s
400	MissingParameter	%s
401	IllegalOperation	%s
404	InvalidShowList.NotFound	%s
500	InternalError	%s

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

Change history

Change time	Summary of changes	Operation

No change history