Versions Compared

Old Version 2

changes.mady.by.user Former user

Saved on

compared with

New Version Current

changes.mady.by.user Former user

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Localtabgroup
Localtab
activetrue
titleCLI
Get

Getting details of cartridge groups via the CLI

Overview
CLI command

list-cartridge-groups

DescriptionList all the available cartridge groups.
Example

List the cartridge groups that are currently available in Private PaaS

Code Block
list-cartridge-groups
Sample output
Code Block
Cartridge Groups found:
+---------------------------------+-------------------+--------------+
| Name                            | No. of cartridges | No of groups |
+---------------------------------+-------------------+--------------+
| keymanager-gw-manager-gw-worker | 3                 | 0            |
+---------------------------------+-------------------+--------------+
Localtab
titleREST API
Get

Getting details of cartridge groups via the REST API

Overview
DescriptionRetrieve details of all the cartridge groups that have been added.
Resource PathcartridgeGroups
HTTP MethodGET
Request/Response Formatapplication/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/cartridgeGroups
Info
  • The path to the JSON file that defines the cartridge group needs to be defined as the <JSON_PAYLOAD> value.
  • 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

Add a cartridge group that has been defined in the <PRIVATE_PAAS_SAMPLES>/wso2am/1.9.0/samples/cartridge-groups/wso2am-190/wso2am-190-group1.json file.

Code Block
curl -X GET -H "Content-Type: application/json" -k -v -u admin:admin https://localhost:9443/api/cartridgeGroups
Sample output
Code Block
> GET /api/cartridgeGroups 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: Wed, 07 Oct 2015 06:12:29 GMT
< Content-Type: application/json
< Transfer-Encoding: chunked
< Server: WSO2 Carbon Server
< 
[{"cartridges":["wso2am-190-gw-manager","wso2am-190-gw-worker","wso2am-190-km"],"dependencies":{"terminationBehaviour":"terminate-none"},"name":"keymanager-gw-manager-gw-worker"}]

You will come across the following HTTP status codes while getting the details of the cartridge groups in Private PaaS:

HTTP status code

200, 500

See the descriptions of the HTTP status codes here.

...