DescribeAlarmPolicy

Wire call

Converge Cloud is RPC over HTTP. There is one path — / — and the action travels in the X-TC-Action header. The /monitor/DescribeAlarmPolicy path used in the OpenAPI document is a documentation convenience so each action is addressable; it is not a route on the server.

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: DescribeAlarmPolicy' \
  -H 'X-TC-Version: 2018-07-24' \
  -H 'X-TC-Timestamp: <unix-seconds>' \
  -H 'X-TC-Region: luzon' \
  -d '{"Module":"<Module>","PolicyId":"<PolicyId>"}'

Request parameters

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.

{
  "Response": {
    "Policy": …,
    "RequestId": "…"
  }
}

{
  "Response": {
    "Error": { "Code": "…", "Message": "…" },
    "RequestId": "…"
  }
}

Try it

What failure looks like

Example error responses for this action. Match on Code.

{
  "Response": {
    "Error": {
      "Code": "ResourceNotFound",
      "Message": " policy not found"
    },
    "RequestId": "d594b985-9cec-05d0-1fed-4e8e44ec02c8"
  }
}