Get Symptom Definitions
NOTE: When making an XML request, make sure the statKey field does not contain any key name with spaces.
Request
URI
GET
https://{api_host}/suite-api/api/symptomdefinitions
COPY
Query Parameters
string
adapterKind
Optional
The adapter kind identifier of the symptom definitions to search for
string
resourceKind
Optional
The resource kind identifier of the symptom definitions to search for
string of
array
id
Optional
The identifier(s) of the symptom definitions to search for. Exact match.
string
name
Optional
The substring of the symptom definition's name to search for. Case-insensitive.
integer
page
Optional
Constraints:
default: 0
Page number from which data needs to be displayed (0-based)
integer
pageSize
Optional
Constraints:
default: 1000
Expected number of entries per page
Responses
200
The list of Symptom Definitions
Returns
symptom-definitions
of type(s)
application/json
"{\n \"symptomDefinitions\" : [ {\n \"id\" : \"SymptomDefinition-1\",\n \"name\" : \"CPU Too High - only one state now allowed per symptom publicinition\",\n \"adapterKindKey\" : \"VMWARE\",\n \"resourceKindKey\" : \"VirtualMachine\",\n \"state\" : {\n \"severity\" : \"CRITICAL\",\n \"condition\" : {\n \"type\" : \"CONDITION_HT\",\n \"key\" : \"cpu|demandmhz\",\n \"operator\" : \"GT_EQ\",\n \"value\" : \"95\",\n \"valueType\" : \"NUMERIC\",\n \"instanced\" : false,\n \"thresholdType\" : \"STATIC\"\n }\n }\n }, {\n \"id\" : \"SymptomDefinition-1\",\n \"name\" : \"CPU Too High - only one state now allowed per symptom publicinition\",\n \"adapterKindKey\" : \"VMWARE\",\n \"resourceKindKey\" : \"VirtualMachine\",\n \"state\" : {\n \"severity\" : \"CRITICAL\",\n \"condition\" : {\n \"type\" : \"CONDITION_HT\",\n \"key\" : \"cpu|demandmhz\",\n \"operator\" : \"GT_EQ\",\n \"value\" : \"70\",\n \"valueType\" : \"NUMERIC\",\n \"instanced\" : false,\n \"thresholdType\" : \"STATIC\"\n }\n }\n }, {\n \"id\" : \"SymptomDefinition-1\",\n \"name\" : \"CPU Too High - only one state now allowed per symptom publicinition\",\n \"adapterKindKey\" : \"VMWARE\",\n \"resourceKindKey\" : \"VirtualMachine\",\n \"state\" : {\n \"severity\" : \"WARNING\",\n \"condition\" : {\n \"type\" : \"CONDITION_HT\",\n \"key\" : \"cpu|demandmhz\",\n \"operator\" : \"GT_EQ\",\n \"value\" : \"50\",\n \"valueType\" : \"NUMERIC\",\n \"instanced\" : false,\n \"thresholdType\" : \"STATIC\"\n }\n }\n }, {\n \"id\" : \"SymptomDefinition-1\",\n \"name\" : \"CPU Too High - only one state now allowed per symptom publicinition\",\n \"adapterKindKey\" : \"VMWARE\",\n \"resourceKindKey\" : \"VirtualMachine\",\n \"state\" : {\n \"severity\" : \"INFORMATION\",\n \"condition\" : {\n \"type\" : \"CONDITION_PROPERTY_NUMERIC\",\n \"value\" : 8.0,\n \"operator\" : \"LT_EQ\",\n \"key\" : \"system|installed_memGB\",\n \"instanced\" : false,\n \"thresholdType\" : \"STATIC\"\n }\n }\n }, {\n \"id\" : \"SymptomDefinition-1\",\n \"name\" : \"CPU Too High - only one state now allowed per symptom publicinition\",\n \"adapterKindKey\" : \"VMWARE\",\n \"resourceKindKey\" : \"VirtualMachine\",\n \"state\" : {\n \"severity\" : \"NONE\",\n \"condition\" : {\n \"type\" : \"CONDITION_MESSAGE_EVENT\",\n \"eventType\" : \"RESOURCE_DOWN\",\n \"message\" : \"message event conditions are of eventType NOTIFICATION, RESOURCE_DOWN, SYSTEM_DEGRADATION, and compare message to event message via EQ or CONTAINS operator\",\n \"operator\" : \"CONTAINS\"\n }\n }\n }, {\n \"id\" : \"SymptomDefinition-1\",\n \"name\" : \"CPU Too High - only one state now allowed per symptom publicinition\",\n \"adapterKindKey\" : \"VMWARE\",\n \"resourceKindKey\" : \"VirtualMachine\",\n \"state\" : {\n \"severity\" : \"UNKNOWN\",\n \"condition\" : {\n \"type\" : \"CONDITION_METRIC_EVENT\",\n \"hardThresholdEventType\" : \"ABOVE\",\n \"statKey\" : \"cpu|demandmhz\"\n }\n }\n }, {\n \"id\" : \"SymptomDefinition-1\",\n \"name\" : \"CPU Too High - only one state now allowed per symptom publicinition\",\n \"adapterKindKey\" : \"VMWARE\",\n \"resourceKindKey\" : \"VirtualMachine\",\n \"state\" : {\n \"severity\" : \"INFORMATION\",\n \"condition\" : {\n \"type\" : \"CONDITION_FAULT\",\n \"faultKey\" : \"FaultKey - FaultKey matches to a FaultEvent's FaultState\",\n \"faultEvents\" : [ \"FaultEvent1\", \"FaultEvent2\" ]\n }\n }\n }, {\n \"id\" : \"SymptomDefinition-2\",\n \"name\" : \"Memory High Usage Percentage - only one state now allowed per symptom publicinition\",\n \"adapterKindKey\" : \"VMWARE\",\n \"resourceKindKey\" : \"HostSystem\",\n \"state\" : {\n \"severity\" : \"CRITICAL\",\n \"condition\" : {\n \"type\" : \"CONDITION_HT\",\n \"key\" : \"mem|host_usagePct\",\n \"operator\" : \"GT_EQ\",\n \"value\" : \"95\",\n \"valueType\" : \"NUMERIC\",\n \"instanced\" : false,\n \"thresholdType\" : \"STATIC\"\n }\n }\n }, {\n \"id\" : \"SymptomDefinition-2\",\n \"name\" : \"Memory High Usage Percentage - only one state now allowed per symptom publicinition\",\n \"adapterKindKey\" : \"VMWARE\",\n \"resourceKindKey\" : \"HostSystem\",\n \"state\" : {\n \"severity\" : \"IMMEDIATE\",\n \"condition\" : {\n \"type\" : \"CONDITION_HT\",\n \"key\" : \"mem|host_usagePct\",\n \"operator\" : \"GT_EQ\",\n \"value\" : \"70\",\n \"valueType\" : \"NUMERIC\",\n \"instanced\" : false,\n \"thresholdType\" : \"STATIC\"\n }\n }\n }, {\n \"id\" : \"SymptomDefinition-2\",\n \"name\" : \"Memory High Usage Percentage - only one state now allowed per symptom publicinition\",\n \"adapterKindKey\" : \"VMWARE\",\n \"resourceKindKey\" : \"HostSystem\",\n \"state\" : {\n \"severity\" : \"WARNING\",\n \"condition\" : {\n \"type\" : \"CONDITION_HT\",\n \"key\" : \"mem|host_usagePct\",\n \"operator\" : \"GT_EQ\",\n \"value\" : \"50\",\n \"valueType\" : \"NUMERIC\",\n \"instanced\" : false,\n \"thresholdType\" : \"STATIC\"\n }\n }\n }, {\n \"id\" : \"SymptomDefinition-2\",\n \"name\" : \"Memory High Usage Percentage - only one state now allowed per symptom publicinition\",\n \"adapterKindKey\" : \"VMWARE\",\n \"resourceKindKey\" : \"HostSystem\",\n \"state\" : {\n \"severity\" : \"INFORMATION\",\n \"condition\" : {\n \"type\" : \"CONDITION_PROPERTY_STRING\",\n \"stringValue\" : \"PoweredOff\",\n \"operator\" : \"EQ\",\n \"key\" : \"system|power_state\",\n \"instanced\" : false,\n \"thresholdType\" : \"STATIC\"\n }\n }\n }, {\n \"id\" : \"SymptomDefinition-2\",\n \"name\" : \"Memory High Usage Percentage - only one state now allowed per symptom publicinition\",\n \"adapterKindKey\" : \"VMWARE\",\n \"resourceKindKey\" : \"HostSystem\",\n \"state\" : {\n \"severity\" : \"WARNING\",\n \"condition\" : {\n \"type\" : \"CONDITION_MESSAGE_EVENT\",\n \"eventType\" : \"RESOURCE_DOWN\",\n \"message\" : \"message event conditions are of eventType NOTIFICATION, RESOURCE_DOWN, SYSTEM_DEGRADATION, and compare message to event message via EQ or CONTAINS operator\",\n \"operator\" : \"CONTAINS\"\n }\n }\n }, {\n \"id\" : \"SymptomDefinition-2\",\n \"name\" : \"Memory High Usage Percentage - only one state now allowed per symptom publicinition\",\n \"adapterKindKey\" : \"VMWARE\",\n \"resourceKindKey\" : \"HostSystem\",\n \"state\" : {\n \"severity\" : \"WARNING\",\n \"condition\" : {\n \"type\" : \"CONDITION_METRIC_EVENT\",\n \"hardThresholdEventType\" : \"ABOVE\",\n \"statKey\" : \"cpu|demandmhz\"\n }\n }\n } ]\n}"
object
pageInfo
Optional
Represents page information for a paged result
array of
object
links
Optional
Collection of links
array of
object
symptomDefinitions
Optional
The collection of symptom definitions
Code Samples
COPY
curl -H 'Authorization: <value>' https://{api_host}/suite-api/api/symptomdefinitions