monitor · 2018-07-24

DescribePolicyGroupList

POST

Get the list of basic policy alarm groups.

Wire call

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

Request parameters

Field	Type	Required	Description
Module	string	Yes	The value is fixed to monitor.
Limit	integer	Yes	Number of parameters that can be returned on each page. Value range: 1 - 100.
Offset	integer	Yes	Parameter offset on each page. The value starts from 0.
Like	string	No	Search by policy name.
InstanceGroupId	integer	No	Instance group ID.
UpdateTimeOrder	string	No	Sort by update time. Valid values: asc and desc.
ProjectIds	string[]	No	Project ID list.
ViewNames	string[]	No	List of alarm policy types.
FilterUnuseReceiver	integer	No	Whether to filter policy groups without recipients. The value 1 indicates that policy groups without recipients will be filtered. The value 0 indicates that policy groups without recipients will not be filtered.
Receivers	string[]	No	Filter by recipient group.
ReceiverUserList	string[]	No	Filter by recipient.
Dimensions	string	No	Dimension set field (json string), for example, [[{"name":"unInstanceId","value":"ins-6e4b2aaa"}]].
ConditionTempGroupId	string	No	Template-based policy group IDs, which are separated by commas.
ReceiverType	string	No	Filter by recipient or recipient group. The value 'user' indicates by recipient. The value 'group' indicates by recipient group.
IsOpen	boolean	No	Filter conditions. Whether the alarm policy has been enabled or disabled

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
GroupList	DescribePolicyGroupListGroup[]	Policy group list.
Total	integer	Total number of policy groups.
Warning	string	Remarks
RequestId	string	The unique request ID, which is returned for each request. RequestId is required for locating a problem.

Success

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

SecretIdSecretKey

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

{
  "Module": "<Module>",
  "Offset": 0,
  "Limit": 20
}

Read-only. Creates nothing.

Recorded example response

{
  "GroupList": [],
  "Total": 0,
  "Warning": "This method is deprecated! Use `DescribeAlarmPolicies` instead!"
}