查询边缘转码任务列表_视频直播(LIVE)-阿里云帮助中心

使用说明

本接口用于查询边缘转码任务列表。
用户需要具有访问边缘转码服务的权限，才能正常调用本接口。
本接口只返回距今180天内的任务，且最后一次操作时间需要在这180天之内。

QPS限制

本接口的单用户QPS限制为6000次/分钟。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。更多信息，请参见QPS限制。

调试

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

请求参数

名称	类型	是否必选	示例值	描述
Action	String	是	ListEdgeTranscodeJob	系统规定参数。取值：ListEdgeTranscodeJob。
ClusterId	String	是	cluster-1	机房ID。
Type	String	否	common	边缘转码类型，枚举： common，通用(普通+窄带高清1.0)。 nbhd-2，窄带高清2.0。 ultra-hd，超高清。说明该参数不填写时，会展示用户有对应转码类型权限的转码模板
Status	Integer	否	0	边缘转码任务状态，枚举： 0 未启动。 1 运行中。
PageNo	Integer	否	1	当前页码。默认值为1.
PageSize	Integer	否	20	分页大小，即每页显示条数。默认值为10，最大值为100。
SortBy	String	否	desc	排序规则，按CreateTime排序。默认是desc，枚举： desc 降序排序。 asc 升序排序。
Keyword	String	否	test	搜索关键词，枚举：任务ID，任务ID支持精确匹配。任务名称，任务名称支持模糊搜索。

请求参数使用说明

本接口支持按转码类型(Type)、转码任务状态(Status)筛选查询结果。
本接口支持按任务创建时间(CreateTime)对查询结果排序，默认为降序。
本接口支持以任务ID（精确匹配）、任务名称（模糊查询）为关键字(Keyword)进行查询。

返回数据

名称	类型	示例值	描述
JobList	Array of Job		边缘转码任务列表。
Job
CreateTime	String	2023-07-24T16:44:55Z	任务创建时间。
JobId	String	**20b48fb04483915d4f2cd8ac**	任务ID。
LastStartAt	String	2023-07-25T02:48:58Z	任务上一次启动的时间。
LastStopAt	String	2023-07-25T05:48:58Z	任务上一次停止的时间。
Name	String	my_job	任务名称。
Status	String	0	边缘转码任务状态，枚举： 0 未启动。 1 运行中。
StreamInput	String	rtmp://mydomain/app/stream1	输入流地址。
StreamOutput	String	rtmp://testdomain/app/stream2	输出流地址。
TemplateId	String	9b1571b513cb44f7a1ba6ae561ff****	任务使用的边缘转码模板ID。
TemplateName	String	my_template	任务使用的边缘转码模板名。
Type	String	common	边缘转码类型，枚举： common，通用(普通+窄带高清1.0)。 nbhd-2，窄带高清2.0。 ultra-hd，超高清。
RequestId	String	****3B-0E1A-586A-AC29-742247****	请求ID。
TotalCount	Integer	100	总数。

示例

请求示例

http(s)://[live.aliyuncs.com]/?Action=ListEdgeTranscodeJob
&ClusterId=cluster-1
&Type=common
&Status=0
&PageNo=1
&PageSize=20
&SortBy=desc
&Keyword=test
&公共请求参数

正常返回示例

XML格式

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

<ListEdgeTranscodeJobResponse>
    <JobList>
        <CreateTime>2023-07-24T16:44:55Z</CreateTime>
        <JobId>****20b48fb04483915d4f2cd8ac****</JobId>
        <LastStartAt>2023-07-25T02:48:58Z</LastStartAt>
        <LastStopAt>2023-07-25T05:48:58Z</LastStopAt>
        <Name>my_job</Name>
        <Status>0</Status>
        <StreamInput>rtmp://mydomain/app/stream1</StreamInput>
        <StreamOutput>rtmp://testdomain/app/stream2</StreamOutput>
        <TemplateId>9b1571b513cb44f7a1ba6ae561ff****</TemplateId>
        <TemplateName>my_template</TemplateName>
        <Type>common</Type>
    </JobList>
    <RequestId>******3B-0E1A-586A-AC29-742247******</RequestId>
    <TotalCount>100</TotalCount>
</ListEdgeTranscodeJobResponse>

JSON格式

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

{
  "JobList" : [ {
    "CreateTime" : "2023-07-24T16:44:55Z",
    "JobId" : "****20b48fb04483915d4f2cd8ac****",
    "LastStartAt" : "2023-07-25T02:48:58Z",
    "LastStopAt" : "2023-07-25T05:48:58Z",
    "Name" : "my_job",
    "Status" : "0",
    "StreamInput" : "rtmp://mydomain/app/stream1",
    "StreamOutput" : "rtmp://testdomain/app/stream2",
    "TemplateId" : "9b1571b513cb44f7a1ba6ae561ff****",
    "TemplateName" : "my_template",
    "Type" : "common"
  } ],
  "RequestId" : "******3B-0E1A-586A-AC29-742247******",
  "TotalCount" : 100
}

错误码

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