monitor · 2018-07-24

DescribeAlarmEvents

POST

Query the list of alarm events.

Wire call

Converge Cloud is RPC over HTTP. There is one path — / — and the action travels in the X-TC-Action header. The /monitor/DescribeAlarmEvents 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: DescribeAlarmEvents' \
  -H 'X-TC-Version: 2018-07-24' \
  -H 'X-TC-Timestamp: <unix-seconds>' \
  -H 'X-TC-Region: luzon' \
  -d '{"Module":"<Module>","MonitorType":"<MonitorType>","Namespace":"<Namespace>"}'

Request parameters

Field	Type	Required	Description
Module	string	Yes	Module name, which is fixed at "monitor"
Namespace	string	Yes	Alarm policy type such as cvm_device, which is obtained through the `DescribeAllNamespaces` API
MonitorType	string	Yes	Monitoring type, such as `MT_QCE`, which is set to default.

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
Events	AlarmEvent[]	Alarm event list
RequestId	string	The unique request ID, which is returned for each request. RequestId is required for locating a problem.

Success

{
  "Response": {
    "Events": …,
    "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.

SecretIdSecretKey

Request bodyvalid JSONPOST monitor.api3.convergecloud.com · DescribeAlarmEvents

{
  "Module": "<Module>",
  "MonitorType": "<MonitorType>",
  "Namespace": "<Namespace>"
}

Read-only. Creates nothing.