You can get details of a cartridge group using the CLI tool, REST API or the management console (UI) as shown below:
| Localtabgroup |
|---|
| Localtab |
|---|
| Get details of a cartridge group via the CLIOverview| CLI command | describe-cartridge-group | | Description | Retrieve details of a specific cartridge group. | | Command format | describe-cartridge-group <CARTRIDGE_GROUP_NAME> |
Parameter definition| Short option | Long option | Description | Required | Example value |
|---|
N/A | N/A | Defined name of the cartridge group | yes | keymanager-gw-manager-gw-worker
|
ExampleRetrieve details on the cartridge group named keymanager-gw-manager-gw-worker. | Code Block |
|---|
describe-cartridge-group keymanager-gw-manager-gw-worker |
Sample output| Code Block |
|---|
ServiceGroup: keymanager-gw-manager-gw-worker
{
"name": "keymanager-gw-manager-gw-worker",
"cartridges": [
"wso2am-190-gw-manager",
"wso2am-190-gw-worker",
"wso2am-190-km"
],
"dependencies": {
"terminationBehaviour": "terminate-none"
}
} |
|
| Localtab |
|---|
| Get details of a cartridge group via the REST APIOverview| Description | Retrieve details of a cartridge group. | | Resource Path | /cartridgeGroups/{groupDefinitionName} | | 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/cartridgeGroups/{groupDefinitionName} |
| 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.
|
|
ExampleRetrieve details on the cartridge group named keymanager-gw-manager-gw-worker. | Code Block |
|---|
curl -X GET -H "Content-Type: application/json" -k -v -u admin:admin https://localhost:9443/api/cartridgeGroups/keymanager-gw-manager-gw-worker |
Sample output| Code Block |
|---|
> GET /api/cartridgeGroups/keymanager-gw-manager-gw-worker 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:30:46 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 a cartridge group: | HTTP status code | 200, 404, 500 See the descriptions of the HTTP status codes here. |
|
| Localtab |
|---|
| Get details of a cartridge group via the management console |
|
...