创建定时任务
最近更新时间: 2024-10-18 10:38:34
1. 接口描述
接口请求域名： as.api3.fincloud.tencent.cn。
本接口（CreateScheduledAction）用于创建定时任务。
默认接口请求频率限制：20次/秒。
接口更新时间：2019-10-31 16:54:41。
接口只验签名不鉴权。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。
| 参数名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Action | 是 | 否 | String | 公共参数，本接口取值：CreateScheduledAction |
| Version | 是 | 否 | String | 公共参数，本接口取值：2018-04-19 |
| Region | 是 | 否 | String | 公共参数，详见产品支持的地域列表(TODO) |
| AutoScalingGroupId | 是 | 否 | String | 伸缩组ID |
| ScheduledActionName | 是 | 否 | String | 定时任务名称。名称仅支持中文、英文、数字、下划线、分隔符"-"、小数点，最大长度不能超60个字节。同一伸缩组下必须唯一。 |
| MaxSize | 是 | 否 | Uint64 | 当定时任务触发时，设置的伸缩组最大实例数。 |
| MinSize | 是 | 否 | Uint64 | 当定时任务触发时，设置的伸缩组最小实例数。 |
| DesiredCapacity | 是 | 否 | Uint64 | 当定时任务触发时，设置的伸缩组期望实例数。 |
| StartTime | 是 | 否 | Datetime_iso | 定时任务的首次触发时间，取值为北京时间（UTC+8），按照ISO8601标准，格式：YYYY-MM-DDThh:mm:ss+08:00。 |
| EndTime | 否 | 否 | Datetime_iso | 定时任务的结束时间，取值为北京时间（UTC+8），按照ISO8601标准，格式：YYYY-MM-DDThh:mm:ss+08:00。<br><br>此参数与Recurrence需要同时指定，到达结束时间之后，定时任务将不再生效。 |
| Recurrence | 否 | 否 | String | 定时任务的重复方式。为标准 Cron 格式<br><br>此参数与EndTime需要同时指定。 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| ScheduledActionId | String | 定时任务ID |
| RequestId | String | 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 |
4. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见公共错误码。
| 错误码 | 描述 |
|---|---|
| LimitExceeded.DesiredCapacityLimitExceeded | |
| InvalidParameterValue.TooLong | |
| LimitExceeded.ScheduledActionLimitExceeded | |
| InvalidParameterValue.InvalidScheduledActionNameIncludeIllegalChar | |
| LimitExceeded.MaxSizeLimitExceeded | |
| ResourceNotFound.AutoScalingGroupIdNotFound | |
| InvalidParameterValue.CronExpressionIllegal | |
| InvalidParameterValue.Size | |
| MissingParameter | |
| LimitExceeded.MinSizeLimitExceeded | |
| InvalidParameterValue.ScheduledActionNameDuplicate | |
| InvalidParameterValue.EndTimeBeforeStartTime | |
| InvalidParameterValue.StartTimeBeforeCurrentTime | |
| InvalidParameterValue.TimeFormat | |
| InternalError |