Converge Studios
as — Auto Scaling
as · 2018-04-19

CreateScalingPolicy

POST

Create an alarm trigger policy.

Wire call

Converge Cloud is RPC over HTTP. There is one path — / — and the action travels in the X-TC-Action header. The /as/CreateScalingPolicy 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: CreateScalingPolicy' \
  -H 'X-TC-Version: 2018-04-19' \
  -H 'X-TC-Timestamp: <unix-seconds>' \
  -H 'X-TC-Region: luzon' \
  -d '{"AutoScalingGroupId":"<AutoScalingGroupId>","ScalingPolicyName":"<ScalingPolicyName>"}'

Request parameters

FieldTypeRequiredDescription
AutoScalingGroupIdstringYesScaling group ID. obtain the scaling group ID by logging in to the console or calling the api DescribeAutoScalingGroups, and retrieve AutoScalingGroupId from the returned information.
ScalingPolicyNamestringYesThe Alarm policy name must be unique in your account. the name length cannot exceed 60 characters. the name only supports chinese, english, digits, underscores, hyphens, and decimal points.
ScalingPolicyTypestringNoAlarm trigger policy type. default: SIMPLE. valid values:.
AdjustmentTypestringNoAfter an Alarm is triggered, specifies the method for modifying the expected number of instances. required in the scenario of simple policies. valid values:.
AdjustmentValueintegerNoAdjustment value for the expected number of instances after an Alarm is triggered, which is applicable only to simple policies and required in simple policy scenarios.
CooldownintegerNoCooldown period (in seconds). This parameter is only applicable to a simple policy. Default value: 300.
MetricAlarmMetricAlarmNoAlarm monitoring metric, apply only to simple policies, required in the scenario of simple policy.
PredefinedMetricTypestringNoPredefined monitoring item, applicable only to target tracking policies. required in the scenario. value range:.
TargetValueintegerNoTarget value, applicable only to the target tracking policy, required in the scenario.
EstimatedInstanceWarmupintegerNoInstance warm-up period (in seconds). It is only available when `ScalingPolicyType` is `TARGET_TRACKING`. Value range: 0-3600. Default value: 300.
DisableScaleInbooleanNoWhether to disable scale-in, which is applicable only to target tracking policies. Default value: false. Valid values:
NotificationUserGroupIdsstring[]NoThis parameter is diused. Please use CreateNotificationConfiguration instead.

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.

FieldTypeDescription
AutoScalingPolicyIdstringAlarm trigger policy ID.
RequestIdstringThe 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": {
    "AutoScalingPolicyId": …,
    "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 · CreateScalingPolicy

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": "98a774c7-1dbe-7be8-4864-31d115400935"
  }
}