Skip to main content

Get details of a Kubernetes application group​

Select

SaaS
Customer Managed

API to get details of a Kubernetes application group with applicationGroupId

Path Parameters
  • applicationGroupId int32 required

    applicationGroupId is the ID of the Kubernetes application group

Responses

OK

Schema
  • id int32
  • name string
  • applicationCount object

    Describe the Backup info for a Kubernetes Application

  • pendingCount int32

    Count of Applications Pending backup

  • protectedCount int32

    Count of Applications Protected

  • notProtectedCount int32

    Count of Applications Not Protected

  • neverBackedUpCount int32

    Count of Applications Never Backed up

  • backupUpWithErrorCount int32

    Count of Applications Backed up with errors

  • totalCount int32

    Count of total number of Applications

  • nextBackupTime int32
  • isETCDApplicationGroup boolean

    Describes if the Application Group is an ETCD Application Group

  • isDefaultApplicationGroup boolean

    Describes if the Application Group is a default Application Group

  • plan object
  • id int32
  • name string
  • timezone object
  • id int32
  • name string
  • tags object[]
  • id int32
  • name string
  • value string
  • content object

    Item to describe the applications and label selectors

  • applications object[]

    List of applications to be added as content

  • GUID string

    GUID value of the Kubernetes Application to be associated as content

  • type string

    Possible values: [NAMESPACE, APPLICATION, PVC, LABELS]

    Type of the Kubernetes application

  • name string

    Name of the application

  • labelSelectors object[]

    List of label selectors to be added as content

  • selectorValue string

    Value of the label selector in key=value format

  • selectorLevel string

    Possible values: [Application, Volumes, Namespace]

    Selector level of the label selector

  • filters object

    Item to describe the applications and label selectors for filters

  • skipStatelessApps boolean

    Default value: false

    Specify whether to skip backup of stateless applications

  • applications object[]

    List of applications to be added as content

  • GUID string

    GUID value of the Kubernetes Application to be associated as content

  • type string

    Possible values: [NAMESPACE, APPLICATION, PVC, LABELS]

    Type of the Kubernetes application

  • name string

    Name of the application

  • labelSelectors object[]

    List of label selectors to be added as content

  • selectorValue string

    Value of the label selector in key=value format

  • selectorLevel string

    Possible values: [Application, Volumes, Namespace]

    Selector level of the label selector

  • lastBackup object
  • jobId int32

    Returns the job id of the last backup job performed.

  • status string

    Possible values: [NEVER_BACKED_UP, COMPLETED, FAILED, COMPLETED_WITH_ERRORS, KILLED, SUSPENDED, INTERRUPTED, ANY_STATUS, SKIPPED, FAILED_TO_START, SYNCHRONIZED, NOT_SYNCHRONIZED, NOT_ATTEMPTED, STARTED, COMPLETED_WITH_WARNINGS, SYSTEM_FAILED, COMMITTED]

    Status of the last backup job performed.

  • time int64

    Shows the time when the last back up job was carried out. The time is provided in unix time format.

  • failureReason string

    Gives the reason for the last backup job failing, if the last backup job fails.

  • activityControl object
  • enableBackup boolean

    Default value: true

  • accessNodes object[]
  • id int32
  • name string
  • options object
  • backupStreams int32

    Default value: 5

    Define number of parallel data readers

  • jobStartTime int32

    Define the backup job start time in epochs

  • onSnapFailureFallbackToLiveVolume boolean

    Default value: false

    Define setting to enable fallback to live volume backup in case of snap failure

  • scheduleWorkerToConfigNamespace boolean

    Default value: false

    Define setting to enable scheduling worker Pods to CV Namespace for CSI-Snapshot enabled backups

  • workerResources object
  • cpuLimits string

    Define limits.cpu to set on the worker Pod

  • cpuRequests string

    Define requests.cpu to set on the worker Pod

  • memoryLimits string

    Define limits.memory to set on the worker Pod

  • memoryRequests string

    Define requests.memory to set on the worker Pod

  • workerNamespace string

    Specify the Kubernetes worker namespace name

  • workerServiceAccount string

    Specify the Kubernetes service account

  • cluster object
  • id int32
  • name string
  • displayName string
  • instance object
  • id int32
  • name string
  • backupset object
  • id int32
  • name string
GET /v5/kubernetes/applicationgroup/:applicationgroupid

Authorization

type: apiKeyname: Authtokenin: header

Request

Click Edit to configure Base URL
https://CommandCenterHostName/commandcenter/api
Security Scheme
token
applicationGroupId — path required
curl -L -X GET 'https://CommandCenterHostName/commandcenter/api/V5/Kubernetes/ApplicationGroup/:applicationGroupId' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'