Get Alert Policy
GET /vdc/alertpolicy/{policyName}
Returns the Alert Policy with the given name
policyName | policyName string |
Required Roles
This call has no restrictions.
Response Body
Response Payload no_name 1 1 AlertPolicyParam
Examples
Request
GET https://192.168.0.0:4443/vdc/alertpolicy/myRPOPolicy HTTP/1.1
Concept-Type: application/xml
X-SDS-AUTH-TOKEN: <AUTH_TOKEN>
Response
HTTP/1.1 200 OK
Content-Type: application/xml
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<alert_policy>
<policyName>myRPOPolicy</policyName>
<metricType>Geo Replication Statistics</metricType>
<metricName>RPO</metricName>
<createdBy>USER</createdBy>
<isEnabled>true</isEnabled>
<isPerInstanceMetric>false</isPerInstanceMetric>
<period>7000000</period>
<periodUnits>MILLISECONDS</periodUnits>
<datapointsToConsider>1</datapointsToConsider>
<datapointsToAlert>1</datapointsToAlert>
<statistic>MAX</statistic>
<operator>GREATER_THAN</operator>
<condition>
<thresholdUnits>HOURS</thresholdUnits>
<thresholdValue>1</thresholdValue>
<severityType>WARNING</severityType>
</condition>
</alert_policy>
Request
GET https://192.168.0.0:4443/vdc/alertpolicy/myRPOPolicy HTTP/1.1
Content-Type: application/json
X-SDS-AUTH-TOKEN: <AUTH_TOKEN>
Response
HTTP/1.1 200 OK
Content-Type: application/json
{
"alert_policy": {
"policyName": "myRPOPolicy",
"metricType": "Geo Replication Statistics",
"metricName": "RPO",
"createdBy": "SYSTEM",
"isEnabled": "true",
"isPerInstanceMetric": "false",
"period": "6000000",
"periodUnits": "MILLISECONDS",
"datapointsToConsider": "1",
"datapointsToAlert": "1",
"statistic": "MAX",
"operator": "GREATER_THAN",
"condition": {
"thresholdUnits": "HOURS",
"thresholdValue": "1",
"severityType": "WARNING"
}
}
}
Request
curl -H $token -H "Content-Type: application/xml" -X GET https://$nodeIp:4443/vdc/alertpolicy/myRPOPolicy
Response
HTTP/1.1 200 OK
Content-Type: application/xml
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<alert_policy>
<policyName>myRPOPolicy</policyName>
<metricType>Geo Replication Statistics</metricType>
<metricName>RPO</metricName>
<createdBy>USER</createdBy>
<isEnabled>true</isEnabled>
<isPerInstanceMetric>false</isPerInstanceMetric>
<period>7000000</period>
<periodUnits>MILLISECONDS</periodUnits>
<datapointsToConsider>1</datapointsToConsider>
<datapointsToAlert>1</datapointsToAlert>
<statistic>MAX</statistic>
<operator>GREATER_THAN</operator>
<condition>
<thresholdUnits>HOURS</thresholdUnits>
<thresholdValue>1</thresholdValue>
<severityType>WARNING</severityType>
</condition>
</alert_policy>