最近更新时间:2023.08.14 16:44:51
首次发布时间:2023.02.15 19:04:54
本接口用于根据函数域名获取触发规则列表。
名称 | 位置 | 类型 | 是否必填 | 示例值 | 描述 |
---|---|---|---|---|---|
Action | Query | String | 是 | ListCronJob | 要执行的操作。取值:ListCronJob |
domain | Query | String | 是 | test-sparrow.test.test | 函数域名 |
search_type | Query | String | 否 | job_name | 搜索类型
|
search | Query | String | 否 | fetch | 搜索内容 |
page | Query | Int32 | 否 | 1 | 页码 |
limit | Query | Int32 | 否 | 10 | 每页条数 |
order_by | Query | Int32 | 否 | 2 | 数据顺序,1为降序,2为升序(默认按照create_time的升序排列) |
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
jobs | []Job | 见下文说明 | 任务列表 |
total_count | Int64 | 1 | 任务总数 |
Job
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
job_name | String | cron1 | 任务名称。名称需同时满足如下要求:
|
cron_expression | String | */1 * * * * | 执行表达式。名称需同时满足如下要求:
|
parameter | String | cron | 执行参数 |
description | String | test | 任务描述 |
job_state | Int64 | 1 | 任务状态 |
cron_type | Int32 | 1 | 调度类型
|
create_time | Int64 | 1638326159 | 创建时间 |
update_time | Int64 | 1638326159 | 更新时间 |
GET https://veefedge.volcengineapi.com/?Action=ListCronJob &domain=test-sparrow.test.test &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 } }