UpdateTimer--函数服务-火山引擎

文档中心

立即注册

导航

UpdateTimer

最近更新时间：2024.11.29 17:12:07首次发布时间：2024.11.29 17:12:07

调用 UpdateTimer 接口，更新 Timer 触发器的配置。

请求说明

请求方式：POST
请求地址：http://open.volcengineapi.com/?Action=UpdateTimer&Version=2024-06-06

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

参数	类型	是否必选	示例值	描述
Action	String	是	UpdateTimer	接口名称。当前 API 的名称为 `UpdateTimer`。
Version	String	是	2024-06-06	接口版本。当前 API 的版本为 `2024-06-06`。
FunctionId	String	是	wrwsk**	Timer 触发器所属函数的 ID。
Id	String	是	nwwzo**	Timer 触发器 ID。
Description	String	否	Timer触发器	Timer 触发器的备注信息。
Enabled	Boolean	否	true	Timer 触发器是否启用。 true：启用 false：关闭
Crontab	String	否	`/5 * * *`	Timer 触发器的触发时间。时间格式为 crontab 表达式，您可以访问crontab.guru 查看 crontab 表达式含义。
Payload	String	否	`{"body": "update event payload"}`	Timer 触发器发送请求的 payload，即触发消息。
EnableConcurrency	Boolean	否	false	Timer 触发器是否允许并发。 true：允许并发 false：禁止并发
Retries	Integer	否	0	Timer 触发器的重试次数。

请求示例

POST http://open.volcengineapi.com/?Action=UpdateTimer&Version=2024-06-06 HTTP/1.1
Content-Type: application/json
{
    "FunctionId": "qtqzj**",
    "Id": "ing3qa**",
    "Description": "Timer触发器",
    "Enabled": false,
    "Crontab": "*/5 * * * *",
    "EnableConcurrency": true
}

返回参数

参数	类型	示例值	描述
FunctionId	String	wrwsk**	函数 ID。
Id	String	nwwzo**	Timer 触发器 ID。
Name	String	doc-timer	Timer 触发器名称。
Description	String	Timer触发器	Timer 触发器的备注信息。
Enabled	Boolean	true	Timer 触发器是否开启，`true`表示开启。
Crontab	String	`/5 * * *`	Timer 触发器的执行时间，格式为 crontab 表达式。
Payload	String	`{"body": "update event payload"}`	Timer 触发器发送请求的 payload，即触发消息。
CreationTime	String	2024-06-14 15:31:07.143863441 +0800 CST m=+88714.902440864	Timer 触发器创建时间。
LastUpdateTime	String	2024-06-14 15:31:07.143863441 +0800 CST m=+88714.902440864	Timer 触发器更新时间。
EnableConcurrency	Boolean	true	Timer 触发器是否允许并发，`true`表示允许并发。
Retries	Integer	0	Timer 触发器的重试次数。

返回示例

HTTP/1.1 200 OK
Content-Type: application/json
{
    "ResponseMetadata": {
        "RequestId": "202411291622408A1DCA972BE**",
        "Action": "UpdateTimer",
        "Version": "2024-06-06",
        "Service": "vefaas",
        "Region": "cn-beijing"
    },
    "Result": {
        "FunctionId": "qtqzj**",
        "Id": "ing3qa**",
        "Name": "doc-timer",
        "Description": "Timer触发器",
        "Enabled": false,
        "Crontab": "*/5 * * * *",
        "Payload": "",
        "CreationTime": "2024-11-29 08:16:31.54 +0000 UTC",
        "LastUpdateTime": "2024-11-29 16:22:40.412373364 +0800 CST m=+66137.231040950",
        "EnableConcurrency": true,
        "Retries": 0
    }
}

错误码

当前接口暂无独立错误码，若接口调用返回异常，可参考公共错误码进行故障排查。