接口功能介绍
查询函数版本预留实例配置列表
接口约束
无
URI
GET /openapi/v1/resources/provision-configs
路径参数
无
Query参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| functionName | 否 | String | 函数名称或别名，若不指定则列出所有函数的预留配置 | ||
| pageIndex | 否 | Integer | 预留配置查询页，默认值：1 | ||
| pageSize | 否 | Integer | 查询页大小，默认值：10 | ||
| functionId | 否 | String | 函数id |
请求参数
请求头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 |
表 Data
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| scheduledActions | Array of Objects | 定时策略配置 | ScheduledActions | |
| alwaysAllocateCPU | Boolean | 是否始终分配 CPU 给函数实例 | ||
| qualifier | String | 函数别名 | ||
| functionId | String | 函数id | ||
| functionName | String | 函数名称 | ||
| version | String | 函数版本 | ||
| target | Integer | 目标资源个数 | ||
| idleMode | Boolean | 闲置模式 | ||
| current | Integer | 实际资源个数 | ||
| currentError | String | 预留实例创建失败时的错误信息 |
表 Pagination
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| pageIndex | Integer | 页码 | ||
| pageSize | Integer | 每页大小 | ||
| total | Integer | 总记录数 |
表 ScheduledActions
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| scheduleExpression | String | 定时配置 | ||
| name | String | 定时策略名称 | ||
| startTime | String | 策略生效时间 | ||
| endTime | String | 策略失效时间 | ||
| target | Integer | 预留目标实例数 |
枚举参数
无
请求示例
请求url
https://{host}/openapi/v1/resources/provision-configs
请求头header
无
请求体body
无
响应示例
{
"statusCode": 0,
"message": "",
"returnObj": {
"data": [
{
"functionName": "test-node",
"ksvcName": "test-node-6559-oayiukfvza",
"functionId": "3856",
"qualifier": "",
"version": "LATEST",
"status": "",
"target": 1,
"current": 1,
"currentError": "",
"idleMode": false,
"scheduledActions": [
{
"name": "schedule-2",
"target": 1,
"scheduleExpression": "cron(0 0 4 * * *)",
"startTime": "0001-01-01T00:00:00Z",
"endTime": "0001-01-01T00:00:00Z"
},
{
"name": "schedule-QCQPMtDrdW",
"target": 2,
"scheduleExpression": "cron(0 0 8 * * *)",
"startTime": "0001-01-01T00:00:00Z",
"endTime": "0001-01-01T00:00:00Z"
}
]
},
{
"functionName": "test-py",
"ksvcName": "test-py-6559-pzvlmkgajm",
"functionId": "3629",
"qualifier": "",
"version": "LATEST",
"status": "",
"target": 1,
"current": 1,
"currentError": "",
"idleMode": true,
"scheduledActions": []
}
],
"pagination": {
"pageIndex": 1,
"pageSize": 10,
"total": 2
}
}
}
状态码
请参考 状态码
错误码
请参考 错误码
