获取触发规则列表--边缘计算节点-火山引擎

文档中心

立即注册

导航

边缘计算节点

获取触发规则列表

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

本接口用于根据函数域名获取触发规则列表。

请求说明

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

请求参数

Query

参数	类型	是否必选	示例值	描述
Action	String	是	ListCronJob	公共参数。该参数表示接口名称。取值：ListCronJob
Version	String	是	2021-04-30	公共参数。该参数表示接口版本。取值：2021-04-30。
veef_id	String	是	bc36dc7c50b9f125d186df****	函数ID
search_type	String	否	job_name	搜索类型任务名称(job_name) 参数关键字(parameter)
search	String	否	fetch	搜索内容
page	Int32	否	1	页码
limit	Int32	否	10	每页条数
order_by	Int32	否	2	数据顺序，1为降序，2为升序(默认按照create_time的升序排列)

返回参数

参数	类型	示例值	描述
jobs	[]Job	见下文说明	任务列表
total_count	Int64	1	任务总数

Job

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

请求示例

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

返回示例

正常返回示例

{
    "ResponseMetadata": {
        "RequestId": "20211207213413010225146063****",
        "Action": "ListCronJob",
        "Version": "2021-04-30",
        "Service": "veefedge",
        "Region": "cn-north-1"
    }，
    "Result": {
        "jobs": [
            {
                "job_name": "cron2",
                "cron_expression": "*/59 * * * *",
                "parameter": "cron_all",
                "description": "",
                "job_state": 0,
                "cron_type": 2,
                "operator": "****",
                "create_time": 1638871686,
                "update_time": 1638871686
            }
        ],
        "total_count": 1
    }
}

错误码

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