monitor · 2018-07-24

BindingPolicyObject

POST

Bind an alarm policy to a specific object.

Wire call

Converge Cloud is RPC over HTTP. There is one path — / — and the action travels in the X-TC-Action header. The /monitor/BindingPolicyObject 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: BindingPolicyObject' \
  -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	Required. The value is fixed to monitor.
GroupId	integer	No	Policy group ID, such as `4739573`. This parameter will be disused soon. Another parameter `PolicyId` is recommended.
PolicyId	string	No	Alarm policy ID, such as `policy-gh892hg0`. At least one of the two parameters, `PolicyId` and `GroupId`, must be specified; otherwise, an error will be reported. `PolicyId` is preferred over `GroupId` when both of them are specified.
InstanceGroupId	integer	No	Instance group ID.
Dimensions	BindingPolicyObjectDimension[]	No	Dimensions of an object to be bound.
EbSubject	string	No	The alert configured for an event
EbEventFlag	integer	No	Whether the event alert has been configured

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.

SecretIdSecretKey

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

{}

This action changes resources in my own account and may create a charge. I understand.

What failure looks like

Example error responses for this action. Match on Code.

Recorded error 1

{
  "Response": {
    "Error": {
      "Code": "InternalError",
      "Message": " failed to parse response: unexpected origin id count"
    },
    "RequestId": "eb85e372-2e19-d2ef-35b8-48c23dcdde90"
  }
}

Recorded error 2

{
  "Response": {
    "Error": {
      "Code": "InternalError",
      "Message": " failed to parse response: unexpected origin id count"
    },
    "RequestId": "84509c59-301e-043e-4fa3-ee0377f7d348"
  }
}