列出函数异步配置
更新时间 2025-09-19 15:36:12
最近更新时间: 2025-09-19 15:36:12
接口功能介绍
列出函数的异步配置
接口约束
无
URI
GET /openapi/v1/async-configs
路径参数 无
Query参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
functionName | 否 | String | 函数名称,若不指定则列出所有函数的异步调用配置 | my-func | |
pageIndex | 否 | Integer | 页码,取值 >= 1,默认值为 1 | 1 | |
pageSize | 否 | Integer | 每页大小,取值范围[1, 100],默认值为 50 | 10 |
请求参数
请求头header参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
regionId | 是 | String | 资源池id,标识不同的地区,如:华东1、西南1 | bb9fdb42056f11eda1610242ac110002 |
请求体body参数 无
响应参数
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
statusCode | Integer | 状态码。0表示成功,其他值表示失败 | 0 | |
error | String | 错误码。CF_0表示成功,其他值表示失败 | CF_0 | |
message | String | 错误描述信息 | ||
returnObj | Object | 返回实体 | ReturnObj | |
表 ReturnObj |
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
data | Array of Objects | 分页数据 | Data | |
pagination | Object | 分页信息 | Pagination | |
表 Pagination |
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
pageIndex | Integer | 页码 | 1 | |
pageSize | Integer | 每页大小 | 10 | |
total | Integer | 总记录数 | 1 | |
表 Data |
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
asyncTask | Boolean | 是否开启异步任务 | true | |
destinationConfig | Object | 目标配置 | DestinationConfig | |
functionName | String | 函数名称 | my-func | |
maxAsyncRetryAttempts | Integer | 异步调用重试次数,取值范围 [0, 8] | 0 | |
maxAsyncEventAgeInSeconds | Integer | 事件最大存活时间,取值范围 [1, 604800],单位为 秒 | 60 | |
qualifier | String | 函数的版本或别名 | LATEST | |
表 DestinationConfig |
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
onSuccess | Object | 成功的回调目标 | Destination | |
onFailure | Object | 失败的回调目标 | Destination | |
表 Destination |
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
byname | String | 版本号或别名 | LATEST | |
flag | String | 版本或别名标志。version:版本,alias:别名 | version | |
ksvc | String | ksvc名称 | my-other-func-xxxx | |
name | String | 函数名称 | my-other-func | |
svc | String | 目标服务。fc:函数计算 | fc |
枚举参数
无
请求示例
请求url
https://{host}/openapi/v1/async-configs
请求头header
regionId: bb9fdb42056f11eda1610242ac110002
请求体body
无
响应示例
{
"statusCode": 0,
"error": "CF_0",
"message": "",
"returnObj": {
"data": [
{
"asyncTask": true,
"destinationConfig": {
"onSuccess": {
"svc": "fc",
"name": "my-other-func",
"flag": "version",
"byname": "LATEST",
"ksvc": "my-other-func-xxxx"
},
"onFailure": {
"svc": "fc",
"name": "my-other-func",
"flag": "version",
"byname": "LATEST",
"ksvc": "my-other-func-xxxx"
}
},
"functionName": "my-func",
"maxAsyncEventAgeInSeconds": 60,
"maxAsyncRetryAttempts": 0,
"qualifier": "LATEST"
}
],
"pagination": {
"pageIndex": 1,
"pageSize": 50,
"total": 1
}
}
}
状态码
请参考 状态码
错误码
请参考 错误码