Get Cloud Assembly Properties
Select
Retrieves the properties of the Cloud Assembly configuration.
- 200
- 400
- 500
Success
- application/json
- Schema
- Example (from schema)
Schema
- filterQueryCount int32
total count
cloudAssemblyProperties object
id int32This is assembly id
name stringThis is assembly name
agent object
Details of assembly agent
id int32name stringbackupset object
Details of assembly backupset
id int32name stringinstance object
Details of assembly instance
id int32name stringcompany object
id int32Id of company
name stringName of company
multiCommcellId int32Multi Commcell Id of company
lastBackup object
jobId int32Returns the job id of the last backup job performed.
status stringPossible 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 int64Shows the time when the last back up job was carried out. The time is provided in unix time format.
failureReason stringGives the reason for the last backup job failing, if the last backup job fails.
creationTime int32This gives the creation time of the cloud assembly.
status int32This is assembly status
cloudConnection object
Details of clould connection
id int32name stringruleGroups object[]
matchRule MatchRulePossible values: [
ALL
,ANY
]Enum which specifies the whether to match all rules or any of the rules
guestCredentialAssocId int32Credential association ID given to link entity with credential id.
guestCredentials object
userName stringpassword stringexistingCredential object
credentialId int32credentialName stringrules object[]
name stringname of the VM to be added as content
type stringPossible values: [
NONE
,SERVER
,RES_POOL
,VAPP
,DATACENTER
,FOLDER
,CLUSTER
,DATASTORE
,DATASTORE_CLUSTER
,VM
,VM_NAME
,VM_GUEST_OS
,VM_GUEST_HOST_NAME
,CLUSTER_SHARED_VOLUMES
,LOCAL_DISK
,CLUSTER_DISK
,UNPROTECTED_VMS
,ROOT
,FILE_SERVER
,SMB_SHARE
,TYPES_FOLDER
,VM_FOLDER
,SERVER_FOLDER
,TEMPLATE_FOLDER
,STORAGE_REPOSITORY_FOLDER
,VAPPFOLDER
,DATACENTER_FOLDER
,CLUSTER_FOLDER
,VM_POWER_STATE
,VM_NOTES
,VM_CUSTOM_ATTRIBUTE
,NETWORK
,USER
,VM_TEMPLATE
,TAG
,TAG_CATEGORY
,SUBCLIENT
,CLIENT_GROUP
,PROTECTION_DOMAIN
,CONSISTENCY_GROUP
,INSTANCE_SIZE
,ORGANIZATION
,IMAGES
,STORAGE_POLICY
,DATABASE
,TABLE
,PROJECT
,SELECTOR
,MANAGED_BY
,REPLICATION_MODE
,METADATATAG
,CATALOG
,VAPPTEMPLATE
,VOLUME
,VM_BADGE
]value stringvalue for the few type of VM Content like powerstate
condition RuleOperationTypePossible values: [
CONTAINS
,DOES_NOT_CONTAIN
,DOES_NOT_EQUAL
,ENDS_WITH
,EQUALS
,STARTS_WITH
]Operation type for VM rules/filters
GUID stringGUID of the entity to be added as content
displayName stringThe display name of the entity to be added
description stringDescription of the rule
description stringDescription of the rule group
filterRuleGroups object[]
matchRule MatchRulePossible values: [
ALL
,ANY
]Enum which specifies the whether to match all rules or any of the rules
guestCredentialAssocId int32Credential association ID given to link entity with credential id.
guestCredentials object
userName stringpassword stringexistingCredential object
credentialId int32credentialName stringrules object[]
name stringname of the VM to be added as content
type stringPossible values: [
NONE
,SERVER
,RES_POOL
,VAPP
,DATACENTER
,FOLDER
,CLUSTER
,DATASTORE
,DATASTORE_CLUSTER
,VM
,VM_NAME
,VM_GUEST_OS
,VM_GUEST_HOST_NAME
,CLUSTER_SHARED_VOLUMES
,LOCAL_DISK
,CLUSTER_DISK
,UNPROTECTED_VMS
,ROOT
,FILE_SERVER
,SMB_SHARE
,TYPES_FOLDER
,VM_FOLDER
,SERVER_FOLDER
,TEMPLATE_FOLDER
,STORAGE_REPOSITORY_FOLDER
,VAPPFOLDER
,DATACENTER_FOLDER
,CLUSTER_FOLDER
,VM_POWER_STATE
,VM_NOTES
,VM_CUSTOM_ATTRIBUTE
,NETWORK
,USER
,VM_TEMPLATE
,TAG
,TAG_CATEGORY
,SUBCLIENT
,CLIENT_GROUP
,PROTECTION_DOMAIN
,CONSISTENCY_GROUP
,INSTANCE_SIZE
,ORGANIZATION
,IMAGES
,STORAGE_POLICY
,DATABASE
,TABLE
,PROJECT
,SELECTOR
,MANAGED_BY
,REPLICATION_MODE
,METADATATAG
,CATALOG
,VAPPTEMPLATE
,VOLUME
,VM_BADGE
]value stringvalue for the few type of VM Content like powerstate
condition RuleOperationTypePossible values: [
CONTAINS
,DOES_NOT_CONTAIN
,DOES_NOT_EQUAL
,ENDS_WITH
,EQUALS
,STARTS_WITH
]Operation type for VM rules/filters
GUID stringGUID of the entity to be added as content
displayName stringThe display name of the entity to be added
description stringDescription of the rule
description stringDescription of the rule group
workloads object[]
id int32name stringsolutions object[]
id int32name stringfilterWorkloads object[]
id int32name stringplan object
id int32name stringcloudAccounts object[]
List of cloud accounts
name stringcloud account name
id stringcloud account id
uuid stringThe globally unique identifier for the account
email stringemail for cloud account
activityControl object
enableBackup booleantrue if Backup is enabled
enableRestore booleantrue if Restore is enabled
backupActivityControlOptions object
activityType stringPossible values: [
BACKUP
,RESTORE
,ONLINECI
,ARCHIVEPRUNE
]denotes the activity type being considered
enableAfterADelay booleanTrue if the activity will be enabled after a delay time interval
enableActivityType booleanTrue if the activity type is enabled
delayTime object
timeZone object
id int32name stringtime int32delay time in unix timestamp
value stringactual delay time value in string format according to the timezone
restoreActivityControlOptions object
activityType stringPossible values: [
BACKUP
,RESTORE
,ONLINECI
,ARCHIVEPRUNE
]denotes the activity type being considered
enableAfterADelay booleanTrue if the activity will be enabled after a delay time interval
enableActivityType booleanTrue if the activity type is enabled
delayTime object
timeZone object
id int32name stringtime int32delay time in unix timestamp
value stringactual delay time value in string format according to the timezone
accessNodeList object
accessNodeMessage stringresourcePoolName stringaccessNode object[]
id int32name stringdisplayName stringDisplay name of the access node
type int32Type of access node , Ex: 3 - access Node , 28 - Access Node Groups
{
"filterQueryCount": 0,
"cloudAssemblyProperties": {
"id": 0,
"name": "string",
"agent": {
"id": 0,
"name": "string"
},
"backupset": {
"id": 0,
"name": "string"
},
"instance": {
"id": 0,
"name": "string"
},
"company": {
"id": 0,
"name": "string",
"multiCommcellId": 0
},
"lastBackup": {
"jobId": 0,
"status": "NEVER_BACKED_UP",
"time": 0,
"failureReason": "string"
},
"creationTime": 0,
"status": 0,
"cloudConnection": {
"id": 0,
"name": "string"
},
"ruleGroups": [
{
"matchRule": "ALL",
"guestCredentialAssocId": 0,
"guestCredentials": {
"userName": "string",
"password": "string"
},
"existingCredential": {
"credentialId": 0,
"credentialName": "string"
},
"rules": [
{
"name": "string",
"type": "NONE",
"value": "string",
"condition": "CONTAINS",
"GUID": "string",
"displayName": "string",
"description": "string"
}
],
"description": "string"
}
],
"filterRuleGroups": [
{
"matchRule": "ALL",
"guestCredentialAssocId": 0,
"guestCredentials": {
"userName": "string",
"password": "string"
},
"existingCredential": {
"credentialId": 0,
"credentialName": "string"
},
"rules": [
{
"name": "string",
"type": "NONE",
"value": "string",
"condition": "CONTAINS",
"GUID": "string",
"displayName": "string",
"description": "string"
}
],
"description": "string"
}
],
"workloads": [
{
"id": 0,
"name": "string"
}
],
"solutions": [
{
"id": 0,
"name": "string"
}
],
"filterWorkloads": [
{
"id": 0,
"name": "string"
}
],
"plan": {
"id": 0,
"name": "string"
},
"cloudAccounts": [
{
"name": "string",
"id": "string",
"uuid": "string",
"email": "string"
}
],
"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": {
"accessNodeMessage": "string",
"resourcePoolName": "string",
"accessNode": [
{
"id": 0,
"name": "string",
"displayName": "string",
"type": 0
}
]
}
}
}
Bad Request
- application/json
- Schema
- Example (from schema)
Schema
- errorMessage string
Tells about the error occured
- errorCode ErrorCode
Possible values: [
NO_ERROR
,INVALID_INPUT
,VALUE_NOT_FOUND
,UNKNOWN_EXCEPTION
,CONNECTION_PROBLEM
,UNKNOWN_SQL_ERROR
,INVALID_USER
,INVALID_OPERATION_TYPE
,INTERNAL_SERVER_PROBLEM
,INSUFFICIENT_USER_PERMISSION_ON_ENTITY
,INVALID_ENTITY_ID
,REFRESH_TOKEN_EXPIRED
]Error code value
{
"errorMessage": "string",
"errorCode": "NO_ERROR"
}
Internal Server Error
- application/json
- Schema
- Example (from schema)
Schema
- errorMessage string
Tells about the error occured
- errorCode ErrorCode
Possible values: [
NO_ERROR
,INVALID_INPUT
,VALUE_NOT_FOUND
,UNKNOWN_EXCEPTION
,CONNECTION_PROBLEM
,UNKNOWN_SQL_ERROR
,INVALID_USER
,INVALID_OPERATION_TYPE
,INTERNAL_SERVER_PROBLEM
,INSUFFICIENT_USER_PERMISSION_ON_ENTITY
,INVALID_ENTITY_ID
,REFRESH_TOKEN_EXPIRED
]Error code value
{
"errorMessage": "string",
"errorCode": "NO_ERROR"
}