monitor · 2018-07-24

UnBindingPolicyObject

POST

Delete an object that is bound to a 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/UnBindingPolicyObject 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: UnBindingPolicyObject' \
  -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	The value is fixed to monitor.
GroupId	integer	Yes	Policy group ID. If `PolicyId` is used, this parameter will be ignored, and any value, e.g., `0`, can be passed in.
UniqueId	string[]	Yes	List of unique IDs of the object instances to be deleted. `UniqueId` can be obtained from the output parameter `List` of the DescribeBindingPolicyObjectList API
InstanceGroupId	integer	No	Instance group ID. The `UniqueId` parameter is invalid if object instances are deleted by instance group.
PolicyId	string	No	Alarm policy ID. If this parameter is used, `GroupId` will be ignored.
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 · UnBindingPolicyObject

{}

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": "InvalidParameter",
      "Message": " invalid param"
    },
    "RequestId": "705ff4a5-138b-6deb-c284-c1d93a9640e0"
  }
}