Skip to content

Change a group's size, policies, timings or batch size

Synchronous. Never changes the launch spec: use PUT …/launch-spec.

PATCH
https://compute-api.ezghcloud.com/v1/organizations/{orgId}/projects/{projectId}/autoscaling-groups/{group}

Authorization

  • apiKeyoptionalHTTP
  • oauthoptionalHTTP
  • sessionCookieoptionalAPI key in cookie

Path parameters

  • orgIdstringrequired

    UUID or prefixed ID (org_…)

  • projectIdstringrequired

    UUID or prefixed ID (prj_…)

  • groupstringrequired

    The group's prefixed ID (asg_…) or its UUID.

Header parameters

  • Idempotency-Keyoptionalstring

    Makes a retry safe: the same key and request get the stored response.

    pattern: ^[\x21-\x7e]{1,200}$
  • If-Matchoptionalstring

    The ETag you read, or *. A stale one is 412 precondition_failed and changes nothing.

Request bodyJSONrequired

  • desiredCapacityoptionalinteger

    Between minSize and maxSize. On create, omitted is minSize.

    maximum: 100, minimum: 0
  • healthCheckGraceSecondsoptionalinteger
    minimum: 0
    Default: 300
  • instanceWarmupSecondsoptionalinteger
    minimum: 0
    Default: 300
  • maxSizeoptionalinteger
    maximum: 100, minimum: 0
  • minSizeoptionalinteger
    maximum: 100, minimum: 0
  • policiesoptionalarray ofobject

    Names are unique within the group.

    3 properties
    • metricobjectrequired
      2 properties
      • kindcpuUtilizationormemoryUtilizationorpromqlrequired
      • querystring | nullrequired

        Required for promql (an instant vector of exactly one series; asg_instances is replaced by a regex of the warm members' ins_ IDs), null otherwise. At most 8 KiB.

        maxLength: 8192
    • namestringrequired
      maxLength: 100, minLength: 1
    • targetstringrequired

      A positive decimal string.

  • releaseoptionalobject
    1 properties
    • batchPercentoptionalinteger
      maximum: 100, minimum: 1
      Default: 25
  • scaleInCooldownSecondsoptionalinteger
    minimum: 0
    Default: 300
  • targetGroupsoptionalarray ofstring

    Load balancer target groups the group's members register with.

Returns

200

The group, changed.

JSON
  • createdAtstringrequired
    format: date-time
  • desiredCapacityintegerrequired
  • healthCheckGraceSecondsintegerrequired
  • idstringrequired

    asg_…

  • instanceWarmupSecondsintegerrequired
  • lastErrorobject | nullrequired
    3 properties
    • atstringrequired
      format: date-time
    • codestringrequired
    • messagestringrequired
  • launchSpecobjectrequired
    11 properties
    • botstring | nullrequired
    • imagestringrequired
    • instanceTypestringrequired
    • networkInterfacesarray ofobjectrequired
      4 properties
      • firewallIdsarray | nullrequired

        null: the project's default firewall. []: none.

      • ipv4boolean | nullrequired
      • ipv6boolean | nullrequired
      • subnetstring | nullrequired
    • resolvedImagestringrequired

      The image (img_…) every member launches: resolved when the launch spec was written.

    • rootVolumeobjectrequired
      4 properties
      • iopsinteger | nullrequired
      • sizeGiBinteger | nullrequired
      • throughputMBpsinteger | nullrequired
      • volumeTypestring | nullrequired
    • sshKeyIdsarray ofstringrequired
    • tagsmap ofstringrequired

      At most 50; keys 1-128 characters, values at most 256, keys starting with ezgh: are reserved.

    • userDatanullrequired

      Always null: user data is never returned.

    • userDataPresentbooleanrequired
    • volumesarray ofobjectrequired
      4 properties
      • iopsinteger | nullrequired
      • sizeGiBinteger | nullrequired
      • throughputMBpsinteger | nullrequired
      • volumeTypestring | nullrequired
  • launchSpecVersionintegerrequired
  • maxSizeintegerrequired
    maximum: 100
  • minSizeintegerrequired
  • namestringrequired
  • policiesarray ofobjectrequired
    3 properties
    • metricobjectrequired
      2 properties
      • kindcpuUtilizationormemoryUtilizationorpromqlrequired
      • querystring | nullrequired

        Required for promql (an instant vector of exactly one series; asg_instances is replaced by a regex of the warm members' ins_ IDs), null otherwise. At most 8 KiB.

        maxLength: 8192
    • namestringrequired
      maxLength: 100, minLength: 1
    • targetstringrequired

      A positive decimal string.

  • releaseobjectrequired
    6 properties
    • batchPercentintegerrequired
    • reasonstring | nullrequired
    • remainingintegerrequired

      Non-retiring members below the target version.

    • replacedintegerrequired

      Non-retiring members on the target version.

    • statusinProgressorsucceededorfailedorcancelledornullrequired
    • targetVersioninteger | nullrequired
  • resourceNamestringrequired

    ezgh::org_…:prj_…:asg_…

  • scaleInCooldownSecondsintegerrequired
  • statuscreatingoractiveorupdatingordeletingorfailedrequired
  • targetGroupsarray ofstringrequired

    Load balancer target groups the group's members register with.

  • updatedAtstringrequired
    format: date-time

400

invalid_request (with issues), invalid_cursor, or the endpoint's own 400 codes.

JSON
  • errorobjectrequired
    4 properties
    • codestringrequired
      maxLength: 64, pattern: ^[a-z][a-z0-9_]*$
    • messagestringrequired
      maxLength: 1024
    • issuesoptionalarray ofobject

      invalid_request: one entry per problem, at a dotted path.

      2 properties
      • messagestringrequired
      • pathstringrequired
    • quotaoptionalobject

      quota_exceeded: the quota that refused the request. Never with Retry-After.

      11 properties
      • idstringrequired
      • kindallocationorrateorusageorconcurrencyrequired
      • limitintegerrequired
        minimum: 0
      • scopeorganizationorprojectorresourcerequired
      • inFlightoptionalinteger
        minimum: 0
      • periodStartoptionalstring
        format: date-time
      • regionoptionalstring
      • resetsAtoptionalstring
        format: date-time
      • scopeResourceNameoptionalstring
      • usedoptionalinteger
        minimum: 0
      • windowoptionalstring

        rate only: an ISO 8601 duration, PT1S to PT1H.

401

unauthenticated: no credential, or one that doesn't check out.

JSON
  • errorobjectrequired
    4 properties
    • codestringrequired
      maxLength: 64, pattern: ^[a-z][a-z0-9_]*$
    • messagestringrequired
      maxLength: 1024
    • issuesoptionalarray ofobject

      invalid_request: one entry per problem, at a dotted path.

      2 properties
      • messagestringrequired
      • pathstringrequired
    • quotaoptionalobject

      quota_exceeded: the quota that refused the request. Never with Retry-After.

      11 properties
      • idstringrequired
      • kindallocationorrateorusageorconcurrencyrequired
      • limitintegerrequired
        minimum: 0
      • scopeorganizationorprojectorresourcerequired
      • inFlightoptionalinteger
        minimum: 0
      • periodStartoptionalstring
        format: date-time
      • regionoptionalstring
      • resetsAtoptionalstring
        format: date-time
      • scopeResourceNameoptionalstring
      • usedoptionalinteger
        minimum: 0
      • windowoptionalstring

        rate only: an ISO 8601 duration, PT1S to PT1H.

403

access_denied: the caller's policies don't allow the action; forbidden_origin: a cookie-authenticated write from an origin that isn't allowed; spend_limit_reached.

JSON
  • errorobjectrequired
    4 properties
    • codestringrequired
      maxLength: 64, pattern: ^[a-z][a-z0-9_]*$
    • messagestringrequired
      maxLength: 1024
    • issuesoptionalarray ofobject

      invalid_request: one entry per problem, at a dotted path.

      2 properties
      • messagestringrequired
      • pathstringrequired
    • quotaoptionalobject

      quota_exceeded: the quota that refused the request. Never with Retry-After.

      11 properties
      • idstringrequired
      • kindallocationorrateorusageorconcurrencyrequired
      • limitintegerrequired
        minimum: 0
      • scopeorganizationorprojectorresourcerequired
      • inFlightoptionalinteger
        minimum: 0
      • periodStartoptionalstring
        format: date-time
      • regionoptionalstring
      • resetsAtoptionalstring
        format: date-time
      • scopeResourceNameoptionalstring
      • usedoptionalinteger
        minimum: 0
      • windowoptionalstring

        rate only: an ISO 8601 duration, PT1S to PT1H.

404

not_found: unknown, malformed, or in an organization the caller isn't in.

JSON
  • errorobjectrequired
    4 properties
    • codestringrequired
      maxLength: 64, pattern: ^[a-z][a-z0-9_]*$
    • messagestringrequired
      maxLength: 1024
    • issuesoptionalarray ofobject

      invalid_request: one entry per problem, at a dotted path.

      2 properties
      • messagestringrequired
      • pathstringrequired
    • quotaoptionalobject

      quota_exceeded: the quota that refused the request. Never with Retry-After.

      11 properties
      • idstringrequired
      • kindallocationorrateorusageorconcurrencyrequired
      • limitintegerrequired
        minimum: 0
      • scopeorganizationorprojectorresourcerequired
      • inFlightoptionalinteger
        minimum: 0
      • periodStartoptionalstring
        format: date-time
      • regionoptionalstring
      • resetsAtoptionalstring
        format: date-time
      • scopeResourceNameoptionalstring
      • usedoptionalinteger
        minimum: 0
      • windowoptionalstring

        rate only: an ISO 8601 duration, PT1S to PT1H.

409

quota_exceeded (an allocation quota, with quota), idempotency_conflict, idempotency_in_progress (with Retry-After), organization_deletion_pending, operation_in_progress, or the endpoint's own 409 codes.

JSON
  • errorobjectrequired
    4 properties
    • codestringrequired
      maxLength: 64, pattern: ^[a-z][a-z0-9_]*$
    • messagestringrequired
      maxLength: 1024
    • issuesoptionalarray ofobject

      invalid_request: one entry per problem, at a dotted path.

      2 properties
      • messagestringrequired
      • pathstringrequired
    • quotaoptionalobject

      quota_exceeded: the quota that refused the request. Never with Retry-After.

      11 properties
      • idstringrequired
      • kindallocationorrateorusageorconcurrencyrequired
      • limitintegerrequired
        minimum: 0
      • scopeorganizationorprojectorresourcerequired
      • inFlightoptionalinteger
        minimum: 0
      • periodStartoptionalstring
        format: date-time
      • regionoptionalstring
      • resetsAtoptionalstring
        format: date-time
      • scopeResourceNameoptionalstring
      • usedoptionalinteger
        minimum: 0
      • windowoptionalstring

        rate only: an ISO 8601 duration, PT1S to PT1H.

412

precondition_failed: the group changed since the ETag in If-Match was read.

413

payload_too_large: the body is over the endpoint's limit (1 MiB unless it says otherwise).

JSON
  • errorobjectrequired
    4 properties
    • codestringrequired
      maxLength: 64, pattern: ^[a-z][a-z0-9_]*$
    • messagestringrequired
      maxLength: 1024
    • issuesoptionalarray ofobject

      invalid_request: one entry per problem, at a dotted path.

      2 properties
      • messagestringrequired
      • pathstringrequired
    • quotaoptionalobject

      quota_exceeded: the quota that refused the request. Never with Retry-After.

      11 properties
      • idstringrequired
      • kindallocationorrateorusageorconcurrencyrequired
      • limitintegerrequired
        minimum: 0
      • scopeorganizationorprojectorresourcerequired
      • inFlightoptionalinteger
        minimum: 0
      • periodStartoptionalstring
        format: date-time
      • regionoptionalstring
      • resetsAtoptionalstring
        format: date-time
      • scopeResourceNameoptionalstring
      • usedoptionalinteger
        minimum: 0
      • windowoptionalstring

        rate only: an ISO 8601 duration, PT1S to PT1H.

429

too_many_requests, with Retry-After; or quota_exceeded (a rate, usage or concurrency quota, with quota), never with Retry-After.

JSON
  • errorobjectrequired
    4 properties
    • codestringrequired
      maxLength: 64, pattern: ^[a-z][a-z0-9_]*$
    • messagestringrequired
      maxLength: 1024
    • issuesoptionalarray ofobject

      invalid_request: one entry per problem, at a dotted path.

      2 properties
      • messagestringrequired
      • pathstringrequired
    • quotaoptionalobject

      quota_exceeded: the quota that refused the request. Never with Retry-After.

      11 properties
      • idstringrequired
      • kindallocationorrateorusageorconcurrencyrequired
      • limitintegerrequired
        minimum: 0
      • scopeorganizationorprojectorresourcerequired
      • inFlightoptionalinteger
        minimum: 0
      • periodStartoptionalstring
        format: date-time
      • regionoptionalstring
      • resetsAtoptionalstring
        format: date-time
      • scopeResourceNameoptionalstring
      • usedoptionalinteger
        minimum: 0
      • windowoptionalstring

        rate only: an ISO 8601 duration, PT1S to PT1H.

500

internal_error: a bug; the details are in the logs, under the request ID.

JSON
  • errorobjectrequired
    4 properties
    • codestringrequired
      maxLength: 64, pattern: ^[a-z][a-z0-9_]*$
    • messagestringrequired
      maxLength: 1024
    • issuesoptionalarray ofobject

      invalid_request: one entry per problem, at a dotted path.

      2 properties
      • messagestringrequired
      • pathstringrequired
    • quotaoptionalobject

      quota_exceeded: the quota that refused the request. Never with Retry-After.

      11 properties
      • idstringrequired
      • kindallocationorrateorusageorconcurrencyrequired
      • limitintegerrequired
        minimum: 0
      • scopeorganizationorprojectorresourcerequired
      • inFlightoptionalinteger
        minimum: 0
      • periodStartoptionalstring
        format: date-time
      • regionoptionalstring
      • resetsAtoptionalstring
        format: date-time
      • scopeResourceNameoptionalstring
      • usedoptionalinteger
        minimum: 0
      • windowoptionalstring

        rate only: an ISO 8601 duration, PT1S to PT1H.

503

unavailable: a dependency the request needs is down. Retry after Retry-After.

JSON
  • errorobjectrequired
    4 properties
    • codestringrequired
      maxLength: 64, pattern: ^[a-z][a-z0-9_]*$
    • messagestringrequired
      maxLength: 1024
    • issuesoptionalarray ofobject

      invalid_request: one entry per problem, at a dotted path.

      2 properties
      • messagestringrequired
      • pathstringrequired
    • quotaoptionalobject

      quota_exceeded: the quota that refused the request. Never with Retry-After.

      11 properties
      • idstringrequired
      • kindallocationorrateorusageorconcurrencyrequired
      • limitintegerrequired
        minimum: 0
      • scopeorganizationorprojectorresourcerequired
      • inFlightoptionalinteger
        minimum: 0
      • periodStartoptionalstring
        format: date-time
      • regionoptionalstring
      • resetsAtoptionalstring
        format: date-time
      • scopeResourceNameoptionalstring
      • usedoptionalinteger
        minimum: 0
      • windowoptionalstring

        rate only: an ISO 8601 duration, PT1S to PT1H.

Navigation

Type to search…

↑↓ navigate↵ selectEsc close