1. Interface Description
Interface request domain name: as.api3.convergecloud.com.
This API (ModifyScheduledAction) is used to modify a scheduled task.
Default interface request rate limit: 20 times per second.
Interface update time: 2019-10-31 16:54:15.
The interface only verifies the signature but does not authenticate.
2. Input Parameters
The following list of request parameters only lists interface request parameters and some public parameters, For a complete list of public parameters see public request parameters.
| Parameter name | Required | Allow NULL | Type | Description |
|---|---|---|---|---|
| Action | Yes | No | String | Public parameter, The value of this interface: ModifyScheduledAction |
| Version | Yes | No | String | Public parameter, The value of this interface: 2018-04-19 |
| Region | No | No | String | Public parameter,Regional information A list of supported geographies is available through the DescribeRegions interface |
| ScheduledActionId | Yes | No | String | ID of the scheduled task to be modified. Example: asst-chwbkq4c |
| ScheduledActionName | No | No | String | Name of the scheduled task. The name can contain only letters, digits, underscores (_), hyphens (-), and decimal points (.) and must be up to 60 bytes in length. The name must be unique within the same scaling group. Example: scheduled-action-0 |
| MaxSize | Yes | No | Uint64 | Maximum number of instances set for the scaling group when the scheduled task is triggered. Example: 5 |
| MinSize | Yes | No | Uint64 | Minimum number of instances set for the scaling group when the scheduled task is triggered. Example: 0 |
| DesiredCapacity | No | No | Uint64 | Desired number of instances set for the scaling group when the scheduled task is triggered. Example: 3 |
| StartTime | No | No | Datetime_iso | First triggering time of the scheduled task. Format: YYYY-MM-DDThh:mm:ss+08:00.Example: 2018-08-28T23:00:00+08:00 |
| EndTime | No | No | Datetime_iso | Scheduled task end time, which is region time (UTC+8). The value follows the ISO 8601 standard. Format: YYYY-MM-DDThh:MM:ss+08:00.This parameter should be specified together with Recurrence. The scheduled task will no longer take effect when the end time arrives.Example: 2019-01-01T00:00:00+08:00 |
| Recurrence | No | No | String | Repeating mode of the scheduled task, which must be in standard cron format. This parameter and the EndTimeparameter must be specified at the same time.Example: 0 23 /1 * |
3. Output Parameters
| Parameter name | Type | Description |
|---|---|---|
| RequestId | String | Unique request id, Each request will return. The RequestId of the request needs to be provided when locating the problem. |
4. Error Code
The following lists only the error codes related to the interface business logic, For other error codes, see public ErrorCode.
| Error Code | Description |
|---|---|
| LimitExceeded.DesiredCapacityLimitExceeded | The desired number of instances exceeds the limit. |
| InvalidParameterValue.TooLong | Too many values. |
| LimitExceeded.ScheduledActionLimitExceeded | The number of scheduled tasks exceeds the limit. |
| InvalidParameterValue.InvalidScheduledActionNameIncludeIllegalChar | The scheduled task name contains invalid characters. |
| LimitExceeded.MaxSizeLimitExceeded | The maximum number of instances exceeds the limit. |
| InvalidParameterValue.CronExpressionIllegal | The cron expression specified for the scheduled task is invalid. |
| InvalidParameterValue.Size | The value of maximum, minimum, or desired number of instances in the auto scaling group is invalid. |
| LimitExceeded.MinSizeLimitExceeded | The minimum number of instances is below the limit. |
| InvalidParameterValue.ScheduledActionNameDuplicate | The scheduled task name already exists. |
| InvalidParameterValue.EndTimeBeforeStartTime | The end time of the scheduled task is before the start time. |
| InvalidParameterValue.StartTimeBeforeCurrentTime | The start time of the scheduled task is before the current time. |
| ResourceNotFound.ScheduledActionNotFound | The specified scheduled task does not exist. |
| InvalidParameterValue.TimeFormat | Wrong time format. |
| InternalError | Internal error. |