monitor — Cloud Monitor
monitor · 2018-07-24
ModifyAlarmPolicyCondition
POST
Modify the trigger condition of an alarm policy.
Wire call
Converge Cloud is RPC over HTTP. There is one path — / — and the action travels in the X-TC-Action header. The /monitor/ModifyAlarmPolicyCondition path used in the OpenAPI document is a documentation convenience so each action is addressable; it is not a route on the server.
curl
curl -sS https://monitor.api3.convergecloud.com/ \
-H 'Authorization: TC3-HMAC-SHA256 Credential=<SecretId>/<YYYY-MM-DD>/monitor/tc3_request, SignedHeaders=content-type;host;x-tc-action, Signature=<sig>' \
-H 'Content-Type: application/json; charset=utf-8' \
-H 'Host: monitor.api3.convergecloud.com' \
-H 'X-TC-Action: ModifyAlarmPolicyCondition' \
-H 'X-TC-Version: 2018-07-24' \
-H 'X-TC-Timestamp: <unix-seconds>' \
-H 'X-TC-Region: luzon' \
-d '{}'Request parameters
| Field | Type | Required | Description |
|---|---|---|---|
| Module | string | Yes | Module name, which is fixed at "monitor" |
| PolicyId | string | Yes | Alarm policy ID |
| ConditionTemplateId | integer | No | ID of trigger condition template. This parameter can be left empty. |
| Condition | AlarmPolicyCondition | No | Metric trigger condition |
| EventCondition | AlarmPolicyEventCondition | No | Event trigger condition |
| Filter | AlarmPolicyFilter | No | Global filter. |
| GroupBy | string[] | No | Aggregation dimension list, which is used to specify which dimension keys data is grouped by. |
| LogAlarmReqInfo | LogAlarmReq | No | Log alarm creation request parameters |
| NoticeIds | string[] | No | Template ID, which is dedicated to Converge Cloud Managed Service for Prometheus. |
| Enable | integer | No | Status (`0`: Disabled; `1`: Enabled) |
| PolicyName | string | No | Name of the policy dedicated to TMP |
| EbSubject | string | No | The alert configured for an event |
Response
Fields are returned inside the Response envelope. Converge Cloud answers HTTP 200 for errors as well as successes, so read Response.Error rather than the status code — and test for the presence of that object, because Code is occasionally the empty string.
| Field | Type | Description |
|---|---|---|
| RequestId | string | The unique request ID, which is returned for each request. RequestId is required for locating a problem. |
Success
{
"Response": {
// action-specific fields,
"RequestId": "…"
}
}Error
{
"Response": {
"Error": { "Code": "…", "Message": "…" },
"RequestId": "…"
}
}Try it
CredentialThe key never leaves this tab — it signs the request here. The signed request goes to /api-relay/monitor.
Request bodyvalid JSONPOST monitor.api3.convergecloud.com · ModifyAlarmPolicyCondition
What failure looks like
Example error responses for this action. Match on Code.
Recorded error 1
{
"Response": {
"Error": {
"Code": "ResourceNotFound",
"Message": " policy not found"
},
"RequestId": "98c1ba98-f61b-12bf-992c-fa4df356de70"
}
}