Page Comparison

You can get details of a deployment policy using the CLI tool, REST API or the PPaaS Console as shown below:

Localtabgroup

Localtab

active	true
title	CLI

Getting details of a deployment policy via the CLI

Overview

CLI command

describe-deployment-policy

Description

Retrieve the details of a deployment policy.

Command format

Code Block
describe-deployment-policy <DEPLOYMENT_POLICY_ID>

Parameter definition

Short option	Long option	Description	Required	Example value
N/A	N/A	Unique ID of the deployment policy	Yes	`deployment-policy-1`

Example

Retrieve the definition details of the deployment policy with the ID: deployment-policy-1.

Code Block
describe-deployment-policy deployment-policy-1

Sample output

Code Block

Deploymentpolicy: deployment-policy-1
{
  "id": "deployment-policy-1",
  "networkPartitions": [
    {
      "id": "network-partition-mock",
      "partitions": [
        {
          "id": "partition-1",
          "partitionMax": 2
        },
        {
          "id": "partition-2",
          "partitionMax": 2
        }
      ],
      "partitionAlgo": "round-robin"
    }
  ]
}

Localtab

title	REST API

Getting details of a deployment policy via the REST API

Overview

Description Retrieve details of a specific deployment policy.

Resource Path

/deploymentPolicies/{deploymentPolicyId}

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/deploymentPolicies/{deploymentPolicyId}

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 deployment policy with the ID: deployment-policy-1 .

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

Sample output

Code Block

> GET /api/deploymentPolicies/deployment-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 05:43:35 GMT
< Content-Type: application/json
< Transfer-Encoding: chunked
< Server: WSO2 Carbon Server
< 
{"id":"deployment-policy-1","networkPartitions":[{"id":"network-partition-mock","partitionAlgo":"round-robin","partitions":[{"id":"partition-1","partitionMax":2}]}]}

You will come across the following HTTP status codes while getting the details of a deployment policy:

HTTP status code

200, 404, 500

See the descriptions of the HTTP status codes here.

Localtab

title	PPaaS Console

Getting details of a deployment policy via the PPaaS Console

Follow the instructions below to view the details of a deployment policy:

Click Configurations on the home page.
Image Added
Click Deployment Policies.
Image Added
Hover your mouse pointer over the deployment policy that you wish to view for the Details button to appear and click Details.
Image Added
The deployment policy definition appears in the UI editor.
Image Added
If you wish to see the JSON schema of the selected deployment policy, click on the toggle view to switch to the JSON view.
Image AddedThe deployment policy definition appears in the JSON editor.
Image Added