Scaling Policies HTTP API
The /scaling/policies
and /scaling/policy/
endpoints are used to list and view scaling policies.
List Scaling Policies Beta
This endpoint returns the scaling policies from all jobs.
Method | Path | Produces |
---|---|---|
GET | /scaling/policies | application/json |
The table below shows this endpoint's support for blocking queries, consistency modes and required ACLs.
Blocking Queries | Consistency Modes | ACL Required |
---|---|---|
YES | all | namespace:list-scaling-policies |
Sample Request
$ curl \ https://localhost:4646/v1/scaling/policies
Sample Response
[ { "CreateIndex": 10, "Enabled": true, "ID": "5e9f9ef2-5223-6d35-bac1-be0f3cb974ad", "ModifyIndex": 10, "Target": { "Group": "cache", "Job": "example", "Namespace": "default" } }]
Read Scaling Policy Beta
This endpoint reads a specific scaling policy.
Method | Path | Produces |
---|---|---|
GET | /scaling/policy/:policy_id | application/json |
The table below shows this endpoint's support for blocking queries, consistency modes and required ACLs.
Blocking Queries | Consistency Modes | ACL Required |
---|---|---|
YES | all | namespace:read-scaling-policy |
Parameters
:policy_id
(string: <required>)
- Specifies the ID of the scaling policy (as returned by the scaling policy list endpoint). This is specified as part of the path.
Sample Request
$ curl \ https://localhost:4646/v1/scaling/policy/5e9f9ef2-5223-6d35-bac1-be0f3cb974ad
Sample Response
{ "CreateIndex": 10, "Enabled": true, "ID": "5e9f9ef2-5223-6d35-bac1-be0f3cb974ad", "Max": 10, "Min": 0, "ModifyIndex": 10, "Policy": { "engage": true, "foo": "bar", "howdy": "doody", "value": 6.0 }, "Target": { "Group": "cache", "Job": "example", "Namespace": "default" }}