接口功能介绍

创建触发器

接口约束

无

URI

POST /openapi/v1/functions/*/triggers

路径参数

参数	是否必填	参数类型	说明	示例	下级对象
functionName	是	String	函数名称	testfunc

Query参数
无

请求参数

请求头header参数

参数	是否必填	参数类型	说明	示例	下级对象
regionId	是	String	资源池id	test

请求体body参数

参数	是否必填	参数类型	说明	示例	下级对象
triggerName	是	String	触发器名称	myTrigger
triggerConfig	是	String	触发器配置，JSON字符串，不同触发器类型配置不同，详情请查看`创建触发器`的附录TriggerConfig
triggerType	是	String	触发器类型	schedule
version	是	String	版本或别名
enable	是	Boolean	触发器是否立即启用，创建场景下固定为启用	true
methods	是	Array of Strings	不填默认为全部	[GET, POST, PUT, DELETE, HEAD]	-
accessInternet	是	Boolean	是否允许公网访问	true	-
authType	是	String	认证类型：anonymous和jwt	anonymous	-
authConfig	否	Object	认证配置信息		见下方`authConfig`
jwks	是	String	json 格式字符串，包含一个或多个 JWK	完整示例请看jwks	-
tokenConfig	否	Array of Objects	Token解析的相关配置		见下方`tokenConfig`
claimTrans	否	Array of Objects	将 JWT 的 claim 映射到请求的某个位置		见下方`claimTrans`
matchMode	否	Object	配置需要对哪些 HTTP 请求进行 JWT 认证		见下方`matchMode`
location	是	String	Token的存储位置	Header	-
name	是	String	Token的名称	Authorization	-
removePrefix	否	String	要移除的前缀	Bearer	-
claimName	是	String	需要转换的Claim名称	role	-
transLocation	是	String	转换后的存储位置	Header	-
targetName	是	String	转换后的名称	X-User-Role	-
mode	是	String	匹配模式: All, Black, White	All	-
path	是	Array of Strings	匹配的路径	/api	-
cronExpr	是	String	定时表达式，用于设定任务的执行时间	0 0 12 * * ?
data	否	String	传递给函数的数据	example data
instanceId	是	String	实例的唯一标识	instance-123	-
topic	是	String	订阅的主题	topic-name	-
consumerGroup	是	Object	消费组配置		见下方consumerGroup
consumerNum	是	Integer	消费者数量	5	-
offset	是	Integer	消费位点 1:最早位点；2:最新位点	1	-
synchronize	是	Boolean	是否同步消费	true	-
autoCreate	是	Boolean	是否自动创建消费组	true	-
groupId	否	String	消费组的唯一标识，autoCreate为true时不需要	group-123	-
instanceId	是	String	实例的唯一标识	instance-123	-
topic	是	String	订阅的主题	topic-name	-
consumerGroup	是	Object	消费组配置		见下方`consumerGroup`
consumeFrom	是	Integer	0:最新位点;1:最早位点；2:指定时间戳	0	-
consumeTimestamp	否	String	消费起始时间戳（如果指定时间戳，格式yyyyMMddHHmmss）	20241008120000	-
synchronize	是	Boolean	是否同步消费	true	-
auth	是	Object	认证信息		见下方`auth`
autoCreate	是	Boolean	rocketmq不支持自动创建，固定false	false	-
groupId	是	String	消费组的唯一标识	group-123	-
accessKey	是	String	rocketmq的用户名	AK123456789	-
secretKey	是	String	rocketmq的密码	SK987654321	-
gatewayInstanceId	是	String	网关实例的ID	97a173e238f3414e968f983380da77ab	-
vpceId	是	String	VPC终端节点ID,uuid格式	16ea21b9-3ef3-49b8-b17c-0136176f2345	-
domain	是	Array of Strings	绑定的域名		-
path	是	String	请求路径	/api/v1/resource	-
methods	是	Array of Strings	请求方法列表	[GET, POST, PUT, DELETE, HEAD]	-
priority	是	Integer	路由的优先级，值越大优先级越高，路由将被优先匹配，默认值为0	0	-
headerPredicates	否	Array of Objects	请求头匹配		见下方`predicates`
queryPredicates	否	Array of Objects	查询参数匹配		见下方`predicates`
key	是	String	请求头或查询参数的键	Authorization	-
type	是	String	匹配类型，精确匹配：`==`, 正则匹配：`~~`	==	-
value	是	String	请求头或查询参数的值	Bearer token	-

响应参数

参数	参数类型	说明	示例	下级对象
statusCode	Integer	状态码,0表示成功，非0表示不成功	0
code	String	错误码	CF_0
message	String	信息
returnObj	Object	返回实体		ReturnObj

表 ReturnObj

参数	参数类型	说明	示例
createdAt	String	创建时间	2024-09-30T16:20:51.645525+08:00
updatedAt	String	更新时间	2024-09-30T16:28:40.899116+08:00
creator	Integer	创建者ID	17250
editor	Integer	编辑者ID	17250
triggerName	String	触发器名称	myTrigger
triggerConfig	String	触发器配置，JSON字符串，不同触发器类型配置不同，详情请查看`创建触发器`的附录TriggerConfig
triggerType	String	触发器类型	schedule
status	Integer	1:启用；2:禁用；3:系统禁用	1
version	String	别名或版本	LATEST
region	String	区域ID	bb9fdb42056f11eda1610242ac110002
functionId	Integer	函数ID	0
urlInternet	String	外网URL ，非http触发器无值
urlIntranet	String	内网URL
isVersion	Boolean	是否是版本	true

枚举参数

参数名 type

枚举值	类型	说明
schedule	String	定时触发器
http	String	http触发器
kafka	String	Kafka触发器
rocketmq	String	Rocketmq触发器
apigateway	String	云原生网关触发器

请求示例

请求url

https://{host}/openapi/v1/functions/{functionName}/triggers

请求头header

无

请求体body

{
"enable": true,
"triggerConfig": "{\"cronExpr\": \"* * * * *\",\"data\": \"{\\\"key\\\":\\\"chaco\\\", \\\"value\\\":\\\"good\\\"}\"}",
"triggerName": "test-trigger-4",
"triggerType": "schedule",
"version": "LATEST"
}

响应示例

{ "statusCode": 0, "code": "CF_0", "message": "", "returnObj": { "createdAt": "2024-09-30T16:20:51.645525+08:00", "updatedAt": "2024-09-30T16:28:40.899116+08:00", "creator": 17250, "editor": 17250, "triggerName": "ttttt", "triggerConfig": "{\"cronExpr\": \"* * * * *\",\"data\": \"{\\\"key\\\":\\\"chaco\\\", \\\"value\\\":\\\"good\\\"}\"}", "triggerType": "schedule", "status": 2, "version": "LATEST", "region": "bb9fdb42056f11eda1610242ac110002", "functionId": 0, "urlInternet": "", "urlIntranet": "", "isVersion": true } }

状态码

请参考状态码

错误码

请参考错误码

应用商城

合作伙伴

开发者

支持与服务

了解天翼云

查看所有产品

函数计算

函数计算

接口功能介绍

接口约束

URI

请求参数

响应参数

枚举参数

请求示例

响应示例

状态码

错误码

活动

应用商城

合作伙伴

开发者

支持与服务

了解天翼云

查看所有产品

函数计算

函数计算

接口功能介绍

接口约束

URI

请求参数

响应参数

枚举参数

请求示例

响应示例

状态码

错误码