Management zones API - GET a management zone
Gets parameters of the specified management zone.
The request produces an application/json
payload.
GET |
|
Parameters
Parameter | Type | Description | In | Required |
---|---|---|---|---|
id | string |
The ID of the required management zone. |
path | required |
includeProcessGroupReferences | boolean |
Flag to include process group references to the response. Process group references aren't compatible across environments. When this flag is set to false, conditions with process group references will be removed. If that leads to a rule having no conditions, the entire rule will be removed. |
query | optional |
Response format
The ManagementZone object
The configuration of the management zone. It defines where the management zone should be applied.
Element | Type | Description |
---|---|---|
metadata | ConfigurationMetadata | Metadata useful for debugging. |
id | string | The ID of the management zone. |
name | string | The name of the management zone. |
rules | ManagementZoneRule[] | The list of rules to where the management zone applies. Each rule is evaluated independently of all other rules. |
The ManagementZoneRule object
A rule defines when to apply a management zone. Each rule is evaluated independently of all other rules.
Element | Type | Description |
---|---|---|
type | string | The type of DESK entities the management zone can be applied to. |
enabled | boolean | The evaluation rule is enabled( |
propagationTypes | string[] | How to apply the management zone to underlying entities:
|
conditions | EntityRuleEngineCondition[] | Matching rules of the management zone. The management zone applies only if all conditions are fulfilled. |
The EntityRuleEngineCondition object
A condition defines how to execute matching logic for an entity.
Element | Type | Description |
---|---|---|
key | ConditionKey | The key to identify the data we're matching. |
comparisonInfo | ComparisonBasic | Defines how the matching is actually performed: what and how are we comparing. |
The ComparisonBasic object
Defines how the matching is actually performed: what and how are we comparing.
The actual field set and the list of possible values of the operator field depend on the type of the comparison.
Find the list of actual models in the description of the type field and check the description of the model you need.
Element | Type | Description |
---|---|---|
operator | Enum | Operator of the comparision. You can reverse it by setting negate to |
value | object | The value to compare to. |
negate | boolean | Reverses the comparison operator. For example it turns the begins with into does not begin with. |
type | string | Defines the actual set of fields depending on the value: STRING -> StringComparison INTEGER -> IntegerComparison SERVICE_TYPE -> ServiceTypeComparison PAAS_TYPE -> PaasTypeComparison CLOUD_TYPE -> CloudTypeComparison AZURE_SKU -> AzureSkuComparision AZURE_COMPUTE_MODE -> AzureComputeModeComparison ENTITY_ID -> EntityIdComparison SIMPLE_TECH -> SimpleTechComparison SIMPLE_HOST_TECH -> SimpleHostTechComparison SERVICE_TOPOLOGY -> ServiceTopologyComparison DATABASE_TOPOLOGY -> DatabaseTopologyComparison OS_TYPE -> OsTypeComparison HYPERVISOR_TYPE -> HypervisorTypeComparision IP_ADDRESS -> IpAddressComparison OS_ARCHITECTURE -> OsArchitectureComparison BITNESS -> BitnessComparision APPLICATION_TYPE -> ApplicationTypeComparison MOBILE_PLATFORM -> MobilePlatformComparison CUSTOM_APPLICATION_TYPE -> CustomApplicationTypeComparison DCRUM_DECODER_TYPE -> DcrumDecoderComparison SYNTHETIC_ENGINE_TYPE -> SyntheticEngineTypeComparison TAG -> TagComparison |
The Enum object
Element | Type | Description |
---|
The ConditionKey object
The key to identify the data we're matching.
Depending on the type of the key, the actual JSON may contain additional fields. Find the list in the description of the type field.
Element | Type | Description |
---|---|---|
attribute | string | The attribute to be used for comparision. |
type | string | Defines the actual set of fields depending on the value: PROCESS_CUSTOM_METADATA_KEY -> CustomProcessMetadataConditionKey HOST_CUSTOM_METADATA_KEY -> CustomHostMetadataConditionKey PROCESS_PREDEFINED_METADATA_KEY -> ProcessMetadataConditionKey STRING -> StringConditionKey |
The ConfigurationMetadata object
Metadata useful for debugging
Element | Type | Description |
---|---|---|
configurationVersions | integer[] | A Sorted list of the version numbers of the configuration. |
clusterVersion | string | DESK server version. |
{
"name": "sampleManagementZone",
"rules": [
{
"type": "SERVICE",
"enabled": true,
"propagationTypes": [
"SERVICE_TO_HOST_LIKE"
],
"conditions": [
{
"key": {
"attribute": "SERVICE_DATABASE_NAME"
},
"comparisonInfo": {
"type": "STRING",
"operator": "BEGINS_WITH",
"value": "sample",
"negate": false,
"caseSensitive": false
}
},
{
"key": {
"attribute": "SERVICE_WEB_SERVER_NAME"
},
"comparisonInfo": {
"type": "STRING",
"operator": "EXISTS",
"negate": false
}
},
{
"key": {
"attribute": "PROCESS_GROUP_CUSTOM_METADATA",
"type": "PROCESS_CUSTOM_METADATA_KEY",
"dynamicKey": {
"source": "KUBERNETES",
"key": "kubernetes.io/limit-ranger"
}
},
"comparisonInfo": {
"type": "STRING",
"operator": "BEGINS_WITH",
"value": "sample",
"negate": false,
"caseSensitive": false
}
}
]
}
]
}