Overview

DescriptionRetrieve details of all the available deployment policies.
Resource Path/deploymentPolicies
HTTP MethodGET
Request/Response Formatapplication/json
> GET /api/deploymentPolicies 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: Thu, 19 Mar 2015 08:27:01 GMT
< Content-Type: application/json
< Transfer-Encoding: chunked
< Server: WSO2 Carbon Server
<
[{"id":"deployment-policy-2","networkPartitions":[{"id":"network-partition-1","partitionAlgo":"one-after-another","partitions":[{"id":"partition-1","partitionMax":5}]},{"id":"network-partition-2","partitionAlgo":"round-robin","partitions":[{"id":"network-partition-2-partition-1","partitionMax":5},{"id":"network-partition-2-partition-2","partitionMax":5}]}]},{"id":"deployment-policy-1","networkPartitions":[{"id":"network-partition-1","partitionAlgo":"one-after-another","partitions":[{"id":"partition-1","partitionMax":20}]}]}] 
curl -X GET -H "Content-Type: application/json" -k -v -u admin:admin https://<STRATOS_HOST>:<STRATOS_HTTPS_PORT>/api/deploymentPolicies

  • 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/deploymentPolicies 
CLI command

list-deployment-policies

DescriptionList all the deployment policies.
Command format

list-deployment-policies

REST API response

HTTP status code

200, 404, 500

See the descriptions of the HTTP status codes here.

Sample JSON response

[
  {
    "id": "deployment-policy-2",
    "networkPartitions": [
      {
        "id": "network-partition-1",
        "partitionAlgo": "one-after-another",
        "partitions": [
          {
            "id": "partition-1",
            "partitionMax": 5
          }
        ]
      },
      {
        "id": "network-partition-2",
        "partitionAlgo": "round-robin",
        "partitions": [
          {
            "id": "network-partition-2-partition-1",
            "partitionMax": 5
          },
          {
            "id": "network-partition-2-partition-2",
            "partitionMax": 5
          }
        ]
      }
    ]
  },
  {
    "id": "deployment-policy-1",
    "networkPartitions": [
      {
        "id": "network-partition-1",
        "partitionAlgo": "one-after-another",
        "partitions": [
          {
            "id": "partition-1",
            "partitionMax": 20
          }
        ]
      }
    ]
  }
] 

For information on the property definitions, see the Deployment Policy Resource Definition.

  • No labels