monitor · 2018-07-24

DescribeAlarmPolicies

POST

Query the list of alarm policies.

Wire call

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

Request parameters

Field	Type	Required	Description
Module	string	Yes	Value fixed at "monitor"
PageNumber	integer	No	Page number starting from 1. Default value: 1
PageSize	integer	No	Number of entries per page. Value range: 1–100. Default value: 20
PolicyName	string	No	Fuzzy search by policy name
MonitorTypes	string[]	No	Filter by monitor type. Valid values: MT_QCE (Converge Cloud service monitoring). If this parameter is left empty, all will be queried by default
Namespaces	string[]	No	Filter by namespace. For the values of different policy types, please see:
Dimensions	string	No	The alarm object list, which is a JSON string. The outer array corresponds to multiple instances, and the inner array is the dimension of an object. For example, “CVM - Basic Monitor” can be written as:
ReceiverUids	string[]	No	Search by recipient. You can get the user list with the API ListUsers in “Cloud Access Management” or query the sub-user information with the API GetUser. The `Uid` field in the returned result should be entered here.
ReceiverGroups	string[]	No	Search by recipient group. You can get the user group list with the API ListGroups in “Cloud Access Management” or query the user group list where a sub-user is in with the API ListGroupsForUser. The `GroupId` field in the returned result should be entered here.
PolicyType	string[]	No	Filter by default policy. Valid values: DEFAULT (display default policy), NOT_DEFAULT (display non-default policies). If this parameter is left empty, all policies will be displayed
Field	string	No	Sort by field. For example, to sort by the last modification time, use Field: "UpdateTime".
Order	string	No	Sort order. Valid values: ASC (ascending), DESC (descending)
ProjectIds	string[]	No	ID array of the policy project, which can be viewed on the following page:
NoticeIds	string[]	No	List of the notification template IDs, which can be obtained by querying the notification template list.
RuleTypes	string[]	No	Filter by trigger condition. Valid values: STATIC (display policies with static threshold), DYNAMIC (display policies with dynamic threshold). If this parameter is left empty, all policies will be displayed
Enable	string[]	No	Filter by alarm status. Valid values: [1]: enabled; [0]: disabled; [0, 1]: all
NotBindingNoticeRule	integer	No	If `1` is passed in, alarm policies with no notification rules configured are queried. If it is left empty or other values are passed in, all alarm policies are queried.
InstanceGroupId	integer	No	Instance group ID.
NeedCorrespondence	integer	No	Whether the relationship between a policy and the input parameter filter dimension is required. `1`: Yes. `0`: No. Default value: `0`.
TriggerTasks	AlarmPolicyTriggerTask[]	No	Filter alarm policy by triggered task (such as auto scaling task). Up to 10 tasks can be specified.
OneClickPolicyType	string[]	No	Filter by quick alarm policy. If this parameter is left empty, all policies are displayed. `ONECLICK`: Display quick alarm policies; `NOT_ONECLICK`: Display non-quick alarm policies.
NotBindAll	integer	No	Whether the returned result needs to filter policies associated with all objects. Valid values: `1` (Yes), `0` (No).
NotInstanceGroup	integer	No	Whether the returned result needs to filter policies associated with instance groups. Valid values: `1` (Yes), `0` (No).
Tags	Tag[]	No	Filter policies by tag
PromInsId	string	No	ID of the Converge Cloud Managed Service for Prometheus instance, which is used for customizing a metric policy.
ReceiverOnCallFormIDs	string[]	No	Search by schedule

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
TotalCount	integer	Total number of policies
Policies	AlarmPolicy[]	Policy array
RequestId	string	The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.

Success

{
  "Response": {
    "TotalCount": …,
    "Policies": …,
    "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 · DescribeAlarmPolicies

{
  "Module": "<Module>"
}

Read-only. Creates nothing.

Recorded example response — captured 2026-09-16

{
  "Response": {
    "Policies": [],
    "RequestId": "74d320fb-b188-f225-1aa1-248ef78aec0b",
    "TotalCount": 0
  }
}