monitor — Cloud Monitor
monitor · 2018-07-24
DescribeBindingPolicyObjectList
POST
Get the bound object list.
Wire call
Converge Cloud is RPC over HTTP. There is one path — / — and the action travels in the X-TC-Action header. The /monitor/DescribeBindingPolicyObjectList 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: DescribeBindingPolicyObjectList' \
-H 'X-TC-Version: 2018-07-24' \
-H 'X-TC-Timestamp: <unix-seconds>' \
-H 'X-TC-Region: luzon' \
-d '{"Module":"<Module>","GroupId":"<GroupId>"}'Request parameters
| Field | Type | Required | Description |
|---|---|---|---|
| Module | string | Yes | The value is fixed to monitor. |
| GroupId | integer | Yes | Policy group ID. If the ID is in the format of “policy-xxxx”, please enter it in the `PolicyId` field. Enter 0 in this field. |
| PolicyId | string | No | Alarm policy ID in the format of “policy-xxxx”. If a value has been entered in this field, you can enter 0 in the `GroupId` field. |
| Limit | integer | No | The number of alarm objects returned each time. Value range: 1-100. Default value: 20. |
| Offset | integer | No | Offset, which starts from 0 and is set to 0 by default. For example, the parameter `Offset=0&Limit=20` returns the zeroth to 19th alarm objects, and `Offset=20&Limit=20` returns the 20th to 39th alarm objects, and so on. |
| Dimensions | DescribeBindingPolicyObjectListDimension[] | No | Dimensions of filtering objects. |
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 |
|---|---|---|
| List | DescribeBindingPolicyObjectListInstance[] | List of bound object instances. |
| Total | integer | Total number of bound object instances. |
| NoShieldedSum | integer | Number of object instances that are not shielded. |
| InstanceGroup | DescribeBindingPolicyObjectListInstanceGroup | Bound instance group information. This parameter is not configured if no instance group is bound. |
| RequestId | string | The unique request ID, which is returned for each request. RequestId is required for locating a problem. |
Success
{
"Response": {
"List": …,
"Total": …,
"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 · DescribeBindingPolicyObjectList
Read-only. Creates nothing.