as — Auto Scaling
as · 2018-04-19
CreateScheduledAction
POST
Create a scheduled task.
Wire call
Converge Cloud is RPC over HTTP. There is one path — / — and the action travels in the X-TC-Action header. The /as/CreateScheduledAction path used in the OpenAPI document is a documentation convenience so each action is addressable; it is not a route on the server.
curl
curl -sS https://as.api3.convergecloud.com/ \
-H 'Authorization: TC3-HMAC-SHA256 Credential=<SecretId>/<YYYY-MM-DD>/as/tc3_request, SignedHeaders=content-type;host;x-tc-action, Signature=<sig>' \
-H 'Content-Type: application/json; charset=utf-8' \
-H 'Host: as.api3.convergecloud.com' \
-H 'X-TC-Action: CreateScheduledAction' \
-H 'X-TC-Version: 2018-04-19' \
-H 'X-TC-Timestamp: <unix-seconds>' \
-H 'X-TC-Region: luzon' \
-d '{"AutoScalingGroupId":"<AutoScalingGroupId>","ScheduledActionName":"<ScheduledActionName>"}'Request parameters
| Field | Type | Required | Description |
|---|---|---|---|
| AutoScalingGroupId | string | Yes | Scaling group ID. obtain available scaling group ids in the following ways:. |
| ScheduledActionName | string | Yes | Scheduled task name, which can only contain letters, numbers, underscores, hyphens ("-"), and decimal points with a maximum length of 60 bytes and must be unique in an auto scaling group. |
| MinSize | integer | Yes | The minimum number of instances set for the auto scaling group when the scheduled task is triggered. |
| StartTime | string | Yes | Initial triggered time of the scheduled task. The value is in `Beijing time` (UTC+8) in the format of `YYYY-MM-DDThh:mm:ss+08:00` according to the `ISO8601` standard. |
| DesiredCapacity | integer | Yes | The desired number of instances set for the auto scaling group when the scheduled task is triggered. |
| MaxSize | integer | Yes | The maximum number of instances set for the auto scaling group when the scheduled task is triggered. |
| EndTime | string | No | End time of the scheduled task. The value is in `Beijing time` (UTC+8) in the format of `YYYY-MM-DDThh:mm:ss+08:00` according to the `ISO8601` standard. This parameter and `Recurrence` need to be specified at the same time. After the end time, the scheduled task will no longer take effect. |
| Recurrence | string | No | The repeating mode of a scheduled task follows the standard Cron format. the Recurrence parameter limits in a scheduled task consist of 5 fields separated by spaces, with the structure: minute, hour, date, month, week. this parameter must be simultaneously specified with `EndTime`. |
| DisableUpdateDesiredCapacity | boolean | No | Disable update DesiredCapacity Indicates the DesiredCapacity is updated normally during scheduled task triggering. |
Response
Fields are returned inside the Response envelope. Converge Cloud answers HTTP 200 for errors as well as successes, so read Response.Error rather than the status code — and test for the presence of that object, because Code is occasionally the empty string.
| Field | Type | Description |
|---|---|---|
| ScheduledActionId | string | Scheduled task ID |
| RequestId | string | The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem. |
Success
{
"Response": {
"ScheduledActionId": …,
"RequestId": "…"
}
}Error
{
"Response": {
"Error": { "Code": "…", "Message": "…" },
"RequestId": "…"
}
}Try it
CredentialThe key never leaves this tab — it signs the request here. The signed request goes to /api-relay/as.
Request bodyvalid JSONPOST as.api3.convergecloud.com · CreateScheduledAction
What failure looks like
Example error responses for this action. Match on Code.
Recorded error 1
{
"Response": {
"Error": {
"Code": "ResourceNotFound.AutoScalingGroupNotFound",
"Message": "The specified auto scaling group `asg-00000000` is not found."
},
"RequestId": "39aac319-9bbb-070b-d6d6-f9a662baadea"
}
}