This documentation is for WSO2 Private PaaS 4.1.0. View documentation for the latest release.
Getting Details of a Deployment Policy - WSO2 Private PaaS 4.1.0 - WSO2 Documentation
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     
||
Skip to end of metadata
Go to start of metadata

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

 

Getting details of a deployment policy via the CLI

Overview
CLI command
describe-deployment-policy
DescriptionRetrieve the details of a deployment policy.
Command format
describe-deployment-policy <DEPLOYMENT_POLICY_ID>
Parameter definition
Short optionLong optionDescriptionRequiredExample value
N/AN/AUnique ID of the deployment policyYes

deployment-policy-1

Example

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

describe-deployment-policy deployment-policy-1
Sample output
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"
    }
  ]
}

Getting details of a deployment policy via the REST API

Overview
DescriptionRetrieve details of a specific deployment policy.
Resource Path

/deploymentPolicies/{deploymentPolicyId}

HTTP MethodGET
Request/Response Format

application/json

Command format
curl -X GET -H "Content-Type: application/json" -k -v -u <USERNAME>:<PASSWORD> https://<PRIVATE_PAAS_HOST>:<PRIVATE_PAAS_HTTPS_PORT>/api/deploymentPolicies/{deploymentPolicyId}
  • 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 .

curl -X GET -H "Content-Type: application/json" -k -v -u admin:admin https://localhost:9443/api/deploymentPolicies/deployment-policy-1
Sample output
> 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.

Getting details of a deployment policy via the PPaaS Console

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

  1. Click Configurations on the home page.
  2. Click Deployment Policies.
  3. Hover your mouse pointer over the deployment policy that you wish to view for the Details button to appear and click Details.
     
    The deployment policy definition appears in the UI editor.

    If you wish to see the JSON schema of the selected deployment policy, click on the toggle view to switch to the JSON view.
    The deployment policy definition appears in the JSON editor.

 


 

  • No labels