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

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

 

Getting details of an application policy via the CLI

Overview
CLI command

describe-application-policy

DescriptionRetrieve details of an application policy.
Command format
describe-application-policy <APPLICATION_POLICY_ID>
Parameter definition
Short optionLong optionDescriptionRequiredExample value
N/AN/AUnique ID of the application policy.Yesapplication-policy- 1
Example

Retrieve details on the application policy named: application-policy-1 .

describe-application-policy application-policy-1
Sample output
Applicationpolicy: application-policy-1
{
  "id": "application-policy-1",
  "algorithm": "one-after-another",
  "networkPartitions": [
    "network-partition-mock"
  ]
}

Getting details of an application policy via the REST API

Overview
DescriptionRetrieve details of a specific application policy.
Resource Path/applicationPolicies/{applicationPolicyId}
HTTP MethodGET
Request/Response Formatapplication/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/applicationPolicies/{applicationPolicyId}
  • 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 details on the application policy named:  application-policy-1 .

cd <PRIVATE_PAAS_CARTRIDGES>/wso2am/1.9.0/samples
curl -X GET -H "Content-Type: application/json" -k -v -u admin:admin https://localhost:9443/api/applicationPolicies/application-policy-1
Sample output
> GET /api/applicationPolicies/application-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: Thu, 08 Oct 2015 08:38:50 GMT
< Content-Type: application/json
< Transfer-Encoding: chunked
< Server: WSO2 Carbon Server
< 
{"algorithm":"one-after-another","id":"application-policy-1","networkPartitions":["network-partition-mock"]}

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

HTTP status code

200, 404, 500

See the descriptions of the HTTP status codes here.

Getting details of an application policy via the PPaaS Console

Follow the instructions below to view the details of an application policy:

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

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

 

 

  • No labels
||