全部产品
Search
文档中心

视频直播:DescribeAutoShowListTasks - 查询自动启停的定时任务

更新时间:Dec 05, 2024

查询自动启停的定时任务。

接口说明

本接口支持查询您已创建的自动启停定时任务相关信息,调用时请保证参数设置符合要求。

QPS 限制

本接口的单用户 QPS 限制为 10 次/秒。超过限制,API 调用会被限流,这可能会影响您的业务,请合理调用。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
live:DescribeAutoShowListTasksget
*Caster
acs:live:*:{#accountId}:caster/{#CasterId}

请求参数

名称类型必填描述示例值
CasterIdstring

需要查询定时任务的导播台 ID。

说明 如果您通过 InitializeAutoShowListTask 接口创建定时任务,请查看 InitializeAutoShowListTask 接口返回参数 CasterId 值。若不填,默认查询 OwnerId 下的全量定时任务。
53200b81-b761-4c10-842a-a0726d97****

返回参数

名称类型描述示例值
object
AutoShowListTasksstring

定时任务列表。包含:

  • Status:任务状态。0 为暂停,1 为启动。

  • LiveTemplate:转码配置列表。

  • TranscodeConfig:拉流地址的转码分辨率说明。

  • CasterId :导播台 ID。

{"Status":0,"TranscodeConfig":{"CasterTemplate":"lp_hd", "LiveTemplate":["lhd","lsd"]}, "CasterId":"cce04ef3-2226-4865-8704-f84b8375****"}
RequestIdstring

请求 ID。

16A96B9A-F203-4EC5-8E43-CB92E68F4CD8

示例

正常返回示例

JSON格式

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

错误码

HTTP status code错误码错误信息
400InvalidUserId.Malformed%s
400InvalidParameter.Malformed%s
400InvalidCasterId.Malformed%s
400InvalidVodUrl.Malformed%s
400MissingParameter%s
401IllegalOperation%s
404InvalidShowList.NotFound%s
500InternalError%s

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
暂无变更历史

代码示例

    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));

    }