接口功能介绍
列出函数异步配置
接口约束
无
URI
GET /openapi/v1/async-configs
路径参数
无
Query参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| functionName | 是 | String | 函数名称，若不指定则列出所有函数的异步调用配置 | my-func | |
| pageIndex | 是 | Integer | 页码。取值>=1 | 1 | |
| pageSize | 是 | Integer | 页大小。取值范围[1,100]，默认50 | 10 |
请求参数
请求头header参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| regionId | 是 | String | 资源池id | test |
请求体body参数
无
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| statusCode | Integer | 状态码,0表示成功，非0表示不成功 | 0 | |
| error | String | 错误码 | CF_0 | |
| message | String | 信息 | ||
| returnObj | Object | 返回实体 | ReturnObj |
表 ReturnObj
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| data | Array of Objects | 分页数据 | Data | |
| pagination | Object | 分页信息 | Pagination |
表 Pagination
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| pageIndex | Integer | 页码 | ||
| pageSize | Integer | 每页大小 | ||
| total | Integer | 总记录数 |
表 Data
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| functionName | String | 函数名称 | ||
| qualifier | String | 函数的版本或别名 | ||
| asyncTask | Boolean | 是否开启异步任务 | ||
| maxAsyncRetryAttempts | Integer | 异步调用重试次数 | ||
| maxAsyncEventAgeInSeconds | Integer | 事件最大存活时间，单位为秒 | ||
| destinationConfig | Object | 目标配置 | DestinationConfig |
表 DestinationConfig
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| onSuccess | Object | 成功回调 | OnSuccess | |
| onFailure | Object | 失败回调 | OnFailure |
表 OnSuccess
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| svc | String | 目标服务。fc：函数计算 | ||
| name | String | 函数名称 | ||
| flag | String | 版本或别名标志。version-版本，alias-别名 | ||
| byname | String | 版本号或别名 | ||
| ksvc | String | ksvc名称 |
表 OnFailure
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| svc | String | 目标服务。fc：函数计算 | ||
| name | String | 函数名称 | ||
| flag | String | 版本或别名标志。version-版本，alias-别名 | ||
| byname | String | 版本号或别名 | ||
| ksvc | String | ksvc名称 |
枚举参数
无
请求示例
请求url
https://{host}/openapi/v1/async-configs
请求头header
无
请求体body
无
响应示例
{
"statusCode": 0,
"message": "",
"returnObj": {
"pagination": {
"pageIndex": 1,
"pageSize": 10,
"total": 2
},
"data": [
{
"functionName": "func1",
"qualifier": "LATEST",
"asyncTask": true,
"maxAsyncRetryAttempts": 3,
"maxAsyncEventAgeInSeconds": 86400,
"destinationConfig": {
"onSuccess": {
"svc": "fc",
"name": "func11",
"flag": "version",
"byname": "LATEST",
"ksvc": "Duis"
},
"onFailure": {
"svc": "fc",
"name": "func12",
"flag": "alias",
"byname": "abc",
"ksvc": "laboris"
}
}
},
{
"functionName": "func2",
"qualifier": "LATEST",
"asyncTask": false,
"maxAsyncRetryAttempts": 1,
"maxAsyncEventAgeInSeconds": 86400,
"destinationConfig": {
"onSuccess": {
"svc": "fc",
"name": "func21",
"flag": "version",
"byname": "1",
"ksvc": "xxxxx"
},
"onFailure": {
"svc": "fc",
"name": "func22",
"flag": "alias",
"byname": "abc",
"ksvc": "yyyyy"
}
}
}
]
}
}
状态码
请参考 状态码
错误码
请参考 错误码
