设置函数版本预留实例配置
更新时间 2025-09-19 16:01:03
最近更新时间: 2025-09-19 16:01:03
接口功能介绍
设置函数版本预留实例配置
接口约束
无
URI
PUT /openapi/v1/resources/functions/*/provision-config
路径参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
functionName | 是 | String | 函数名称 | my-func |
Query参数 无
请求参数
请求头header参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
regionId | 是 | String | 资源池id,标识不同的地区,如:华东1、西南1 | bb9fdb42056f11eda1610242ac110002 |
请求体body参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
idleMode | 否 | Boolean | 闲置模式 | false | |
qualifier | 否 | String | 函数别名。函数版本、函数别名必须填其中一个 | my-alias | |
version | 否 | String | 函数版本。函数版本、函数别名必须填其中一个 | LATEST | |
target | 是 | Integer | 目标资源个数 | 1 | |
scheduledActions | 否 | Array of Objects | 定时策略配置 | ScheduledActions | |
表 ScheduledActions |
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
scheduleExpression | 是 | String | 定时配置表达式 | cron(0 0 4 1 * *) | |
name | 否 | String | 定时策略名称。如果不指定将根据如下规则自动生成名称:schedule-{数字与大小写字母组成的10位随机值} | my-schedule | |
startTime | 否 | String | 策略生效时间 | 2024-05-01T00:00:00Z | |
endTime | 否 | String | 策略失效时间 | 2024-06-01T00:00:00Z | |
target | 否 | Integer | 预留目标实例数,默认值为 0 | 1 | |
timezone | 否 | String | 时区,默认值为 Asia/Shanghai | Asia/Shanghai |
响应参数
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
statusCode | Integer | 状态码。0表示成功,其他值表示失败 | 0 | |
error | String | 错误码。CF_0表示成功,其他值表示失败 | CF_0 | |
message | String | 错误描述信息 | ||
returnObj | Object | 返回实体 | ReturnObj | |
表 ReturnObj |
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
current | Integer | 实际资源个数 | 1 | |
currentError | String | 预留实例创建失败时的错误信息 | ||
functionId | String | 函数id | 1234567890 | |
functionName | String | 函数名称 | my-func | |
ksvcName | String | ksvc名称 | my-func-xxxx | |
version | String | 函数版本 | LATEST | |
target | Integer | 目标资源个数 | 1 | |
idleMode | Boolean | 是否为闲置模式 | false | |
qualifier | String | 函数别名 | my-alias | |
scheduledActions | Array of Objects | 定时策略配置 | ScheduledActions | |
表 ScheduledActions |
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
scheduleExpression | String | 定时配置表达式 | cron(0 0 4 1 * *) | |
name | String | 定时策略名称 | my-schedule | |
startTime | String | 策略生效时间 | 2024-05-01T00:00:00Z | |
endTime | String | 策略失效时间 | 2024-06-01T00:00:00Z | |
target | Integer | 预留目标实例数 | 1 | |
timezone | String | 时区 | Asia/Shanghai |
枚举参数
无
请求示例
请求url
https://{host}/openapi/v1/resources/functions/my-func/provision-config
请求头header
regionId: bb9fdb42056f11eda1610242ac110002
请求体body
{
"idleMode": false,
"qualifier": "my-alias",
"target": 1,
"scheduledActions": [
{
"scheduleExpression": "cron(0 0 4 1 * *)",
"name": "my-schedule",
"startTime": "2024-05-01T00:00:00Z",
"endTime": "2024-06-01T00:00:00Z",
"target": 1,
"timezone": "Asia/Shanghai"
}
]
}
响应示例
{
"statusCode": 0,
"error": "CF_0",
"message": "",
"returnObj": {
"functionName": "my-func",
"ksvcName": "my-func-xxxx",
"functionId": "1234567890",
"qualifier": "my-alias",
"version": "",
"target": 1,
"current": 0,
"currentError": "",
"idleMode": false,
"scheduledActions": [
{
"name": "my-schedule",
"target": 1,
"scheduleExpression": "cron(0 0 4 1 * *)",
"startTime": "2024-05-01T00:00:00Z",
"endTime": "2024-06-01T00:00:00Z",
"timezone": "Asia/Shanghai"
}
]
}
}
状态码
请参考 状态码
错误码
请参考 错误码