Overview

DescriptionRetrieve details of a specific auto-scaling policy.
Resource Path

/autoscalingPolicies/{autoscalingPolicyId}

HTTP MethodGET
Request/Response Format

application/json

> GET /api/autoscalingPolicies/autoscaling-policy-1 HTTP/1.1
> Authorization: Basic YWRtaW46YWRtaW4=
> User-Agent: curl/7.24.0 (x86_64-apple-darwin12.0) libcurl/7.24.0 OpenSSL/0.9.8| zlib/1.2.5
> Host: localhost:9443
> Accept: */*
> Content-Type: application/json
>
< HTTP/1.1 200 OK
< Date: Fri, 20 Mar 2015 08:30:09 GMT
< Content-Type: application/json
< Transfer-Encoding: chunked
< Server: WSO2 Carbon Server
<
{"id":"autoscaling-policy-1","instanceRoundingFactor":0,"isPublic":false,"loadThresholds":{"loadAverage":{"threshold":40},"memoryConsumption":{"threshold":40},"requestsInFlight":{"threshold":50}}} 
curl -X GET -H "Content-Type: application/json" -k -v -u admin:admin https://<STRATOS_HOST>:<STRATOS-HTTPS-PORT>/api/autoscalingPolicies/{autoscalingPolicyId}

  • By default, <STRATOS_HOST> is localhost. However, if you are using a public IP, the respective IP address or domain needs to be specified.
  • By default, <STRATOS_HTTPS_PORT> has been set to 9443. However, if the port offset has been incremented by n, the default port value needs to be incremented by n.

For example:

curl -X GET -H "Content-Type: application/json" -k -v -u admin:admin https://localhost:9443/api/autoscalingPolicies/autoscaling-policy-1
 
CLI command
describe-autoscaling-policy
DescriptionRetrieve the details of a specific auto-scaling policy.
Command format
describe-autoscaling-policy <AUTOSCALING_POLICY_ID>

REST API response

HTTP status code

200, 404, 500

See the descriptions of the HTTP status codes here.

Sample JSON response

{
  "id": "autoscaling-policy-1",
  "instanceRoundingFactor": 0,
  "isPublic": false,
  "loadThresholds": {
    "loadAverage": {
      "threshold": 40
    },
    "memoryConsumption": {
      "threshold": 40
    },
    "requestsInFlight": {
      "threshold": 50
    }
  }
}

For information on all the properties that can be used in a auto-scaling policy definition, see the Auto-scaling Policy Resource Definition.

  • No labels