Page Comparison

You can get details of an auto-scaling policy using the CLI tool, REST API or the management console (UI) as shown below:

Localtabgroup

Localtab

active	true
title	CLI

Get details of an auto-scaling policy via the CLI

Overview

CLI command

describe-autoscaling-policy

Description

Retrieve the details of a specific auto-scaling policy.

Command format

Code Block
describe-autoscaling-policy <AUTOSCALING_POLICY_ID>

Parameter definition

Short option	Long option	Description	Required	Example value
N/A	N/A	Unique ID of the auto-scaling policy	Yes	economy

Example

Retrieve the definition details of the auto-scaling policy with the ID: autoscaling-policy-1

Code Block
describe-autoscaling-policy autoscaling-policy-1

Sample output

Code Block

Autoscalingpolicy: autoscaling-policy-1
{
  "id": "autoscaling-policy-1",
  "loadThresholds": {
    "requestsInFlight": {
      "threshold": 20.0
    },
    "memoryConsumption": {
      "threshold": 80.0
    },
    "loadAverage": {
      "threshold": 120.0
    }
  }
}

Localtab

title	REST API

Get details of an auto-scaling policy via the REST API

Overview

Description Retrieve details of a specific auto-scaling policy.

Resource Path

/autoscalingPolicies/{autoscalingPolicyId}

HTTP Method GET

Request/Response Format

application/json

Command format

Code Block
curl -X GET -H "Content-Type: application/json" -k -v -u <USERNAME>:<PASSWORD> https://<PRIVATE_PAAS_HOST>:<PRIVATE_PAAS_HTTPS_PORT>/api/autoscalingPolicies/{autoscalingPolicyId}

Info
By default, `<USERNAME>:<PASSWORD>` is `admin:admin.` By default, `<PRIVATE_PAAS_HOST>` is `localhost.` However, if you are using a public IP, the respective IP address or domain needs to be specified. By default, `<PRIVATE_PAAS_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`.

Example

Retrieve the definition details of the auto-scaling policy with the ID: autoscaling-policy-1

Code Block
curl -X GET -H "Content-Type: application/json" -k -v -u admin:admin https://localhost:9443/api/autoscalingPolicies/autoscaling-policy-1

Sample output

Code Block

> GET /api/autoscalingPolicies/autoscaling-policy-1 HTTP/1.1
> Host: localhost:9443
> Authorization: Basic YWRtaW46YWRtaW4=
> User-Agent: curl/7.43.0
> Accept: */*
> Content-Type: application/json
> 
< HTTP/1.1 200 OK
< Date: Mon, 05 Oct 2015 11:48:50 GMT
< Content-Type: application/json
< Transfer-Encoding: chunked
< Server: WSO2 Carbon Server
< 
{"id":"autoscaling-policy-1","loadThresholds":{"loadAverage":{"threshold":120},"memoryConsumption":{"threshold":80},"requestsInFlight":{"threshold":20}}}

You will come across the following HTTP status codes while getting details of an auto-scaling policy:

HTTP status code

200, 404, 500

See the descriptions of the HTTP status codes here.

Localtab

title	Management console

Get details of an auto-scaling policy via the management console

...

Versions Compared

Old Version 1

New Version 2

Key

Get details of an auto-scaling policy via the CLI

Overview

Parameter definition

Example

Sample output

Get details of an auto-scaling policy via the REST API

Overview

Example

Sample output

Get details of an auto-scaling policy via the management console