获取调度记录列表--边缘计算节点-火山引擎

文档中心

立即注册

导航

边缘计算节点

获取调度记录列表

最近更新时间：2024.11.21 11:22:08首次发布时间：2023.02.15 19:04:54

本接口用于获取触发任务的调度记录。

请求说明

请求方式：GET
请求地址：https://veefedge.volcengineapi.com/?Action=ListCronJobTask&Version=2021-04-30

请求参数

Query

参数	类型	是否必选	示例值	描述
Action	String	是	ListCronJobTask	公共参数。该参数表示接口名称。取值：ListCronJobTask
Version	String	是	2021-04-30	公共参数。该参数表示接口版本。取值：2021-04-30。
veef_id	String	是	bc36dc7c50b9f125d186df****	函数ID
job_name	String	是	cron1	任务名称。名称需同时满足如下要求: 每个函数的任务名不能有重复长度不超过128个字符
search_type	String	否	cron_expression	搜索类型执行表达式(cron_expression) 参数关键字(parameter)
search	String	否	fetch	搜索内容
page	Int32	否	1	页码
limit	Int32	否	10	每页条数
order_by	Int32	否	2	数据顺序，1为降序，2为升序(默认按照create_time的升序排列)

返回数据

参数	类型	示例值	描述
tasks	[]Task	见下文说明	调度记录列表
total_count	Int64	1	调度记录总数

Task

参数	类型	示例值	描述
job_name	String	cron1	任务名称。名称需同时满足如下要求: 每个函数的任务名不能有重复长度不超过128个字符
cron_expression	String	/1 * * *	执行表达式。名称需同时满足如下要求: 支持cron表达式(不支持秒级触发)
parameter	String	cron	执行参数
cron_task_status	Int64	1	调度状态
description	String	test	任务描述
uuid	String	2xju****	调度唯一标志符
create_time	Int64	1638326159	创建时间
update_time	Int64	1638326159	更新时间

请求示例

GET https://veefedge.volcengineapi.com/?Action=ListCronJobTask
&veef_id=bc36dc7c50b9f125d186df****
&job_name=cron1
&<公共请求参数>

返回示例

正常返回示例

{
    "ResponseMetadata": {
        "RequestId": "20211207213413010225146063****",
        "Action": "ListCronJobTask",
        "Version": "2021-04-30",
        "Service": "veefedge",
        "Region": "cn-north-1"
    }，
    "Result": {
        "tasks": [
            {
                "job_name": "cron1",
                "cron_expression": "*/30 * * * *",
                "parameter": "cron_all",
                "job_state": 1,
                "cron_task_status": 6,
                "description": "",
                "uuid": "2xl2****",
                "create_time": 1639625400,
                "update_time": 1639625401
            }
        ],
        "total_count": 1
    }
}

错误码

如果响应正文中包含 Error 字段，则表示 API 请求失败。关于错误码的更多信息，参见错误码。