GET Kubernetes Application Group REST API Operation

This operation returns a list of Kubernetes application groups in the Command Center.

Request

Syntax

GET webservice /v4/Kubernetes/ApplicationGroups HTTP/1.1
Host: host name
Accept: application/json
Authtoken: authentication token

where <webservice> is the root path used to route the API requests to the Web Server.

For more information, see Available Web Services for REST API.

Request Headers

Name	Description
Host	The host name of the Web Server or Web Console used in the API request.
Accept	The format of the response. Valid value is application/json.
Authtoken	The authentication token received after successfully logging on. For information about receiving an authentication token, see Authentication.

Name

Description

Host

The host name of the Web Server or Web Console used in the API request.

The format of the response.

Valid value is application/json.

Authtoken

The authentication token received after successfully logging on.

For information about receiving an authentication token, see Authentication.

Response

Response Parameters

Parameter	Description	Element
applicationGroupCount	The total number of application groups that are displayed.
name	The name of the application group.	applicationGroups
clusterType	The type of VSA Cluster. Valid value is 20.	applicationGroups
id	The ID of the application group.	applicationGroup
id	The ID of the cluster for the application.	Cluster
name	The name of the cluster for the application group.	cluster
displayName	The display name of the cluster for the application group.	cluster
status		applicationGroups
time	The time of the most recent backup job in epoch.	lastBackup
jobId	The ID of the most recent backup job.	lastBackup
lastSuccessfullBackupTime	The time of the most recent successful backup job in epoch.	lastBackup
failureReason	The failure reason (also called job pending reason, JPR), if any, for the most recent backup job.	lastBackup
id	The ID of the server plan for the application.	plan
name	The name of the server plan for the application.	plan
id	The ID of the company that the application belongs to.	company
name	The name of the company that the application belongs to.	company
id	The ID of the instance for the application group.	Instance
name	The name of the instance.	Instance

Examples

Sample Response

This is the response when the request is successful.

{ "applicationGroupCount": 2, "applicationGroups": [ { "status": "8", "isDefaultApplicationGroup": true, "clusterType": "20", "applicationGroup": { "id": 16, "name": "default" }, "cluster": { "id": 6, "name": "Cluster123", "displayName": "Cluster123" }, "plan": { "id": 2, "name": "Backup Plan" }, "company": { "id": 0, "name": "" }, "Instance": { "id": 7, "name": "Kubernetes" }, "lastBackup": { "time": 0 } }, { "status": "0", "clusterType": "20", "applicationGroup": { "id": 18, "name": "AppGrp01" }, "cluster": { "id": 6, "name": "Cluster123", "displayName": "Cluster123" }, "plan": { "id": 1, "name": "Backup Plan" }, "company": { "id": 0, "name": "" }, "Instance": { "id": 7, "name": "Kubernetes" }, "lastBackup": { "time": 1643086819, "jobId": 4130, "lastSuccessfullBackupTime": 0, "failureReason": "Failed to connect to Kubernetes endpoint [<REDACTED>] from access node [lazarus].<br>Source: accessnode001, Process: vsdiscovery" } } ]
}