获取异步配置
更新时间 2025-09-19 15:31:28
最近更新时间: 2025-09-19 15:31:28
接口功能介绍
查询函数的异步配置
接口约束
无
URI
GET /openapi/v1/functions/*/async
路径参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| functionName | 是 | String | 函数名称 | my-func |
Query参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| qualifier | 否 | String | 函数的版本或别名，默认为 LATEST | LATEST |
请求参数
请求头header参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| regionId | 是 | String | 资源池id，标识不同的地区，如：华东1、西南1 | bb9fdb42056f11eda1610242ac110002 |
请求体body参数 无
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| statusCode | Integer | 状态码。0表示成功，其他值表示失败 | 0 | |
| error | String | 错误码。CF_0表示成功，其他值表示失败 | CF_0 | |
| message | String | 错误描述信息 | ||
| returnObj | Object | 返回实体 | ReturnObj | |
| 表 ReturnObj |
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| asyncTask | Boolean | 是否开启异步任务 | true | |
| destinationConfig | Object | 目标配置 | DestinationConfig | |
| maxAsyncRetryAttempts | Integer | 异步调用重试次数，取值范围 [0, 8] | 0 | |
| maxAsyncEventAgeInSeconds | Integer | 事件最大存活时间，取值范围 [1, 604800]，单位为 秒 | 60 | |
| 表 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/functions/my-func/async
请求头header
regionId: bb9fdb42056f11eda1610242ac110002
请求体body
无
响应示例
{
"statusCode": 0,
"error": "CF_0",
"message": "",
"returnObj": {
"asyncTask": true,
"maxAsyncRetryAttempts": 0,
"maxAsyncEventAgeInSeconds": 60,
"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"
}
}
}
}
状态码
请参考 状态码
错误码
请参考 错误码
