Get entities applicable for plan association
Select
API to fetch list of entities that are applicable for plan association via plan assignment rules.
- 200
- 500
OK
- application/json
- Schema
- Example (from schema)
Schema
entities object[]
Details of entity applicable for plan association.
subclient object
id int32name stringbackupset object
id int32name stringinstance object
id int32name stringclient object
id int32name stringapptype object
id int32name stringevaluatedPlan object
id int32name stringcurrentPlan object
id int32name stringruleDetails object
This object will hold each plan rule details.
rule object
id int32name stringplan object
id int32GUID stringname stringworkloads object[]
This will include list of apptypes that should be evaluated against workload for plan association
id int32name stringregions object[]
This will include list of regions that should be evaluated against workload region for plan association
id int32GUID stringname stringtags object[]
This will include list of tags that should be evaluated against workload tags (if any) for plan association
GUID stringGUID for the tag
id int32Id for the tag
name stringName for the plan rule tag which need to be matched against tag of the workload.
value stringPossible value that need to matched against value of tag associated to workload.
serverGroups object[]
This will include list of Server groups that should be evaluated against workload server group for plan association
id int32GUID stringname stringrank int32This will suggest rank/priority of the plan rule.
solutions object[]
This will include list of solutions that should be evaluated against workload for plan association.
id int32name stringcompany object
id int32name stringglobalConfigInfo object
Only applicable on Global CommCells
id stringname stringcommcells object[]
List of Service CommCells where the global configuration is applied
id int32name stringguid stringscope stringThe entity level at which the config is applied.
scopeFilterQuery stringCommCellEntityCache filter query string used for filtering the scope
applyOnAllCommCells booleanDecides whether the global configuration should be applied to all the Service commcells, including the newly created ones
isMarkedForDeletion booleanIndicates whether global configuration deletion has been started.
status string
{
"entities": [
{
"subclient": {
"id": 0,
"name": "string"
},
"backupset": {
"id": 0,
"name": "string"
},
"instance": {
"id": 0,
"name": "string"
},
"client": {
"id": 0,
"name": "string"
},
"apptype": {
"id": 0,
"name": "string"
},
"evaluatedPlan": {
"id": 0,
"name": "string"
},
"currentPlan": {
"id": 0,
"name": "string"
},
"ruleDetails": {
"rule": {
"id": 0,
"name": "string"
},
"plan": {
"id": 0,
"GUID": "string",
"name": "string"
},
"workloads": [
{
"id": 0,
"name": "string"
}
],
"regions": [
{
"id": 0,
"GUID": "string",
"name": "string"
}
],
"tags": [
{
"GUID": "string",
"id": 0,
"name": "string",
"value": "string"
}
],
"serverGroups": [
{
"id": 0,
"GUID": "string",
"name": "string"
}
],
"rank": 0,
"solutions": [
{
"id": 0,
"name": "string"
}
],
"company": {
"id": 0,
"name": "string"
},
"globalConfigInfo": {
"id": "string",
"name": "string",
"commcells": [
{
"id": 0,
"name": "string",
"guid": "string"
}
],
"scope": "string",
"scopeFilterQuery": "string",
"applyOnAllCommCells": true,
"isMarkedForDeletion": true,
"status": "string"
}
}
}
]
}
Internal Server Error
- application/json
- Schema
- Example (from schema)
Schema
- errorMessage string
- errorCode int32
{
"errorMessage": "string",
"errorCode": 0
}