Get Cloud Config Client details

Path Parameters

clientId int32 required
Id of an cloud config client

Responses

application/json

Schema
Example (from schema)

Schema

clientId int32
instanceId int32
applicationId int32
clientName string
displayName string
vendor string
Possible values: [NONE, VMW, MICROSOFT, XEN_SERVER, AMAZON, AZURE, REDHAT, AZURE_V2, SCVMM, NUTANIX, ORACLE_VM, DOCKER, OPENSTACK, ORACLE_CLOUD, FUSIONCOMPUTE, VCLOUD, GOOGLE_CLOUD, AZURE_STACK, ALIBABA_CLOUD, ORACLE_CLOUD_INFRASTRUCTURE, KUBERNETES, REDHAT_OPENSHIFT, MONGODB_ATLAS, PROXMOX, KUBERNETES_AKS, AZURE_STACK_HCI, KUBERNETES_EKS, MORPHEUS, KUBERNETES_GKE, KUBERNETES_OKE, NUTANIX_PRISM_CENTRAL, APACHE_CLOUDSTACK, VMWARE_CLOUD_FOUNDATION, NEXAVM, INCUS]
activityControl object
enableBackup boolean
true if Backup is enabled
enableRestore boolean
true if Restore is enabled
backupActivityControlOptions object
activityType string
Possible values: [BACKUP, RESTORE, ONLINECI, ARCHIVEPRUNE, AUXCOP, DRBACKUP, MEDIARECYCLE, SYNTHETICFULL, ALLACTIVITY, SCHEDULE, OFFLINECI, DDBACTIVITY, DATAVERIFICATION, SENDLOGFILEACTIVITY]
denotes the activity type being considered
enableAfterADelay boolean
True if the activity will be enabled after a delay time interval
enableActivityType boolean
True if the activity type is enabled
delayTime object
timeZone object
id int32
name string
time int32
delay time in unix timestamp
value string
actual delay time value in string format according to the timezone
restoreActivityControlOptions object
activityType string
Possible values: [BACKUP, RESTORE, ONLINECI, ARCHIVEPRUNE, AUXCOP, DRBACKUP, MEDIARECYCLE, SYNTHETICFULL, ALLACTIVITY, SCHEDULE, OFFLINECI, DDBACTIVITY, DATAVERIFICATION, SENDLOGFILEACTIVITY]
denotes the activity type being considered
enableAfterADelay boolean
True if the activity will be enabled after a delay time interval
enableActivityType boolean
True if the activity type is enabled
delayTime object
timeZone object
id int32
name string
time int32
delay time in unix timestamp
value string
actual delay time value in string format according to the timezone
accessNodeList object[]
id int32
name string
displayName string
Display name of the access node
type int32
Type of access node , Ex: 3 - access Node , 28 - Access Node Groups
isScaleProfile boolean
Default value: false
True if the access node is a scale profile client
associatedSubclients object[]
id int32
name string
cloudConfigContent object
Cloud Config Content
azureCloudConfigContent object
Azure Cloud Config Content
resourceGroup string[]
tags object[]
name string
value string
region string
Azure region
ociCloudConfigContent object
OCI Cloud Config Content
compartments string[]
tags object[]
tagNamespace string
tagKey string
tagValue string
region string
OCI region
gcpCloudConfigContent object
GCP Cloud Config Content
labels object[]
name string
value string
projectIds string[]
region string
GCP region
amazonCloudConfigContent object
Amazon Cloud Config Content
tags object[]
name string
value string
region string
Amazon region
contentRuleGroups object[]
ruleGroups to specify the content that you want to backup
matchRule MatchRule
Possible values: [ALL, ANY]
Enum which specifies the whether to match all rules or any of the rules
rules object[]
type CloudConfigContentSelectionType
Possible values: [RESOURCE_GROUP, TAG_NAME, TAG_VALUE, REGION]
The type of content selection criteria for cloud config subclient content rule
condition CloudConfigRuleOperator
Possible values: [EQUALS, DOES_NOT_EQUAL]
The operator/condition for cloud config subclient content rule
value string
value corresponding to the type on which the condition will be applied
filterRuleGroups object[]
ruleGroups to specify the content that you want to exclude from backup
matchRule MatchRule
Possible values: [ALL, ANY]
Enum which specifies the whether to match all rules or any of the rules
rules object[]
type CloudConfigContentSelectionType
Possible values: [RESOURCE_GROUP, TAG_NAME, TAG_VALUE, REGION]
The type of content selection criteria for cloud config subclient content rule
condition CloudConfigRuleOperator
Possible values: [EQUALS, DOES_NOT_EQUAL]
The operator/condition for cloud config subclient content rule
value string
value corresponding to the type on which the condition will be applied
planEntity object
id int32
name string
subType string
Possible values: [ANY, DLO, SERVER, LAPTOP, DATABASE, SNAP, FS_SERVER, VSA_SERVER, VSA_REPLICATION, EXCHANGE_USER, EXCHANGE_JOURNAL, DATA_CLASSIFICATION, E_DISCOVERY, OFFICE_365, ARCHIVER, FSIBMIVTL, DYNAMICS_365, CDM, ObjectStore]
lastSuccessfulJobInfo object
Cloud Config Job Info
jobId int64
Latest successful backup job of the cloud config subclient
time int64
Shows the time when the backup job was carried out. The time is provided in unix time format.
totalProtectedResources int64
Total protected resources by the latest successful backup job
totalResourceTypes int32
Count of distinct resource types protected by the latest successful backup job
discoverySubclient object
Cloud Config Subclient details
id int32
name string
cloudConfigContent object
Cloud Config Content
azureCloudConfigContent object
Azure Cloud Config Content
resourceGroup string[]
tags object[]
name string
value string
region string
Azure region
ociCloudConfigContent object
OCI Cloud Config Content
compartments string[]
tags object[]
tagNamespace string
tagKey string
tagValue string
region string
OCI region
gcpCloudConfigContent object
GCP Cloud Config Content
labels object[]
name string
value string
projectIds string[]
region string
GCP region
amazonCloudConfigContent object
Amazon Cloud Config Content
tags object[]
name string
value string
region string
Amazon region
contentRuleGroups object[]
ruleGroups to specify the content that you want to backup
matchRule MatchRule
Possible values: [ALL, ANY]
Enum which specifies the whether to match all rules or any of the rules
rules object[]
type CloudConfigContentSelectionType
Possible values: [RESOURCE_GROUP, TAG_NAME, TAG_VALUE, REGION]
The type of content selection criteria for cloud config subclient content rule
condition CloudConfigRuleOperator
Possible values: [EQUALS, DOES_NOT_EQUAL]
The operator/condition for cloud config subclient content rule
value string
value corresponding to the type on which the condition will be applied
filterRuleGroups object[]
ruleGroups to specify the content that you want to exclude from backup
matchRule MatchRule
Possible values: [ALL, ANY]
Enum which specifies the whether to match all rules or any of the rules
rules object[]
type CloudConfigContentSelectionType
Possible values: [RESOURCE_GROUP, TAG_NAME, TAG_VALUE, REGION]
The type of content selection criteria for cloud config subclient content rule
condition CloudConfigRuleOperator
Possible values: [EQUALS, DOES_NOT_EQUAL]
The operator/condition for cloud config subclient content rule
value string
value corresponding to the type on which the condition will be applied
planEntity object
id int32
name string
subType string
Possible values: [ANY, DLO, SERVER, LAPTOP, DATABASE, SNAP, FS_SERVER, VSA_SERVER, VSA_REPLICATION, EXCHANGE_USER, EXCHANGE_JOURNAL, DATA_CLASSIFICATION, E_DISCOVERY, OFFICE_365, ARCHIVER, FSIBMIVTL, DYNAMICS_365, CDM, ObjectStore]
lastSuccessfulJobInfo object
Cloud Config Job Info
jobId int64
Latest successful backup job of the cloud config subclient
time int64
Shows the time when the backup job was carried out. The time is provided in unix time format.
totalProtectedResources int64
Total protected resources by the latest successful backup job
totalResourceTypes int32
Count of distinct resource types protected by the latest successful backup job
backupInfo object
Cloud Config backup information
lastJobInfo 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.
lastSuccessfulJobInfo object
Cloud Config Job Info
jobId int64
Latest successful backup job of the cloud config subclient
time int64
Shows the time when the backup job was carried out. The time is provided in unix time format.
totalProtectedResources int64
Total protected resources by the latest successful backup job
totalResourceTypes int32
Count of distinct resource types protected by the latest successful backup job
company object
id int32
Id of company
name string
Name of company
multiCommcellId int32
Multi Commcell Id of company
credentialInfo object
id int32
name string
amazonClientInfo object
Amazon client information
regionEndPoints string
Regions
discoveryflags int32
Discovery Flags
discoveryamilist string
Discovery AMI List
useIamRole boolean
IAM Role
enableAdminAccount boolean
Use service account resources
adminInstanceId int64
Account
useRoleARN boolean
Use Role
serviceName string
Service Name
useHostedInfrastructure boolean
Use hosted infrastructure on Metallic
azureClientInfo object
Azure Resource Manager client information
subscriptionId string
isManagedIdentity boolean
True if client is configured using Azure Managed Service Identity.
isAuthorizedUsingMTA boolean
Authorized using MultiTenant App
useHostedInfrastructure boolean
Use hosted infrastructure
googleCloudClientInfo object
Google Cloud client information
projectId string
Google Cloud projectIds associated with the client
region string
Google Cloud region associated with the client
useInstanceAttachedServiceAccount boolean
True if client is configured using instance attached service account
oracleCloudClientInfo object
Oracle Cloud Infrastructure client information
tenancyOCId string
Tenancy OCId
userOCId string
User OCId
regionName string
Region Name
useInstancePrincipal boolean

{
  "clientId": 0,
  "instanceId": 0,
  "applicationId": 0,
  "clientName": "string",
  "displayName": "string",
  "vendor": "NONE",
  "activityControl": {
    "enableBackup": true,
    "enableRestore": true,
    "backupActivityControlOptions": {
      "activityType": "BACKUP",
      "enableAfterADelay": true,
      "enableActivityType": true,
      "delayTime": {
        "timeZone": {
          "id": 0,
          "name": "string"
        },
        "time": 0,
        "value": "string"
      }
    },
    "restoreActivityControlOptions": {
      "activityType": "BACKUP",
      "enableAfterADelay": true,
      "enableActivityType": true,
      "delayTime": {
        "timeZone": {
          "id": 0,
          "name": "string"
        },
        "time": 0,
        "value": "string"
      }
    }
  },
  "accessNodeList": [
    {
      "id": 0,
      "name": "string",
      "displayName": "string",
      "type": 0,
      "isScaleProfile": false
    }
  ],
  "associatedSubclients": [
    {
      "id": 0,
      "name": "string",
      "cloudConfigContent": {
        "azureCloudConfigContent": {
          "resourceGroup": [
            "string"
          ],
          "tags": [
            {
              "name": "string",
              "value": "string"
            }
          ],
          "region": "string"
        },
        "ociCloudConfigContent": {
          "compartments": [
            "string"
          ],
          "tags": [
            {
              "tagNamespace": "string",
              "tagKey": "string",
              "tagValue": "string"
            }
          ],
          "region": "string"
        },
        "gcpCloudConfigContent": {
          "labels": [
            {
              "name": "string",
              "value": "string"
            }
          ],
          "projectIds": [
            "string"
          ],
          "region": "string"
        },
        "amazonCloudConfigContent": {
          "tags": [
            {
              "name": "string",
              "value": "string"
            }
          ],
          "region": "string"
        },
        "contentRuleGroups": [
          {
            "matchRule": "ALL",
            "rules": [
              {
                "type": "RESOURCE_GROUP",
                "condition": "EQUALS",
                "value": "string"
              }
            ]
          }
        ],
        "filterRuleGroups": [
          {
            "matchRule": "ALL",
            "rules": [
              {
                "type": "RESOURCE_GROUP",
                "condition": "EQUALS",
                "value": "string"
              }
            ]
          }
        ]
      },
      "planEntity": {
        "id": 0,
        "name": "string",
        "subType": "ANY"
      },
      "lastSuccessfulJobInfo": {
        "jobId": 0,
        "time": 0,
        "totalProtectedResources": 0,
        "totalResourceTypes": 0
      }
    }
  ],
  "discoverySubclient": {
    "id": 0,
    "name": "string",
    "cloudConfigContent": {
      "azureCloudConfigContent": {
        "resourceGroup": [
          "string"
        ],
        "tags": [
          {
            "name": "string",
            "value": "string"
          }
        ],
        "region": "string"
      },
      "ociCloudConfigContent": {
        "compartments": [
          "string"
        ],
        "tags": [
          {
            "tagNamespace": "string",
            "tagKey": "string",
            "tagValue": "string"
          }
        ],
        "region": "string"
      },
      "gcpCloudConfigContent": {
        "labels": [
          {
            "name": "string",
            "value": "string"
          }
        ],
        "projectIds": [
          "string"
        ],
        "region": "string"
      },
      "amazonCloudConfigContent": {
        "tags": [
          {
            "name": "string",
            "value": "string"
          }
        ],
        "region": "string"
      },
      "contentRuleGroups": [
        {
          "matchRule": "ALL",
          "rules": [
            {
              "type": "RESOURCE_GROUP",
              "condition": "EQUALS",
              "value": "string"
            }
          ]
        }
      ],
      "filterRuleGroups": [
        {
          "matchRule": "ALL",
          "rules": [
            {
              "type": "RESOURCE_GROUP",
              "condition": "EQUALS",
              "value": "string"
            }
          ]
        }
      ]
    },
    "planEntity": {
      "id": 0,
      "name": "string",
      "subType": "ANY"
    },
    "lastSuccessfulJobInfo": {
      "jobId": 0,
      "time": 0,
      "totalProtectedResources": 0,
      "totalResourceTypes": 0
    }
  },
  "backupInfo": {
    "lastJobInfo": {
      "jobId": 0,
      "status": "NEVER_BACKED_UP",
      "time": 0,
      "failureReason": "string"
    },
    "lastSuccessfulJobInfo": {
      "jobId": 0,
      "time": 0,
      "totalProtectedResources": 0,
      "totalResourceTypes": 0
    }
  },
  "company": {
    "id": 0,
    "name": "string",
    "multiCommcellId": 0
  },
  "credentialInfo": {
    "id": 0,
    "name": "string"
  },
  "amazonClientInfo": {
    "regionEndPoints": "string",
    "discoveryflags": 0,
    "discoveryamilist": "string",
    "useIamRole": true,
    "enableAdminAccount": true,
    "adminInstanceId": 0,
    "useRoleARN": true,
    "serviceName": "string",
    "useHostedInfrastructure": true
  },
  "azureClientInfo": {
    "subscriptionId": "string",
    "isManagedIdentity": true,
    "isAuthorizedUsingMTA": true,
    "useHostedInfrastructure": true
  },
  "googleCloudClientInfo": {
    "projectId": "string",
    "region": "string",
    "useInstanceAttachedServiceAccount": true
  },
  "oracleCloudClientInfo": {
    "tenancyOCId": "string",
    "userOCId": "string",
    "regionName": "string",
    "useInstancePrincipal": true
  }
}

Bad Request

application/json

Schema
Example (from schema)

Schema

errorMessage string
errorCode int32

{
  "errorMessage": "string",
  "errorCode": 0
}

Internal Server Error

application/json

Schema
Example (from schema)

Schema

errorMessage string
errorCode int32

{
  "errorMessage": "string",
  "errorCode": 0
}

Get Cloud Config Client details​

Get Cloud Config Client details