monitor · 2018-07-24

DescribeBasicAlarmList

POST

Get the basic alarm 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/DescribeBasicAlarmList 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: DescribeBasicAlarmList' \
  -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	API component name. The value for the current API is monitor.
StartTime	integer	No	Start time, which is the timestamp one day prior by default.
EndTime	integer	No	End time, which is the current timestamp by default.
Limit	integer	No	Number of parameters that can be returned on each page. Value range: 1 - 100. Default value: 20.
Offset	integer	No	Parameter offset on each page. The value starts from 0 and the default value is 0.
OccurTimeOrder	string	No	Sorting by occurrence time. Valid values: asc and desc.
ProjectIds	string[]	No	Filter by project ID.
ViewNames	string[]	No	Filter by policy type.
AlarmStatus	string[]	No	Filter by alarm status.
ObjLike	string	No	Filter by alarm object.
InstanceGroupIds	string[]	No	Filter by instance group ID.
MetricNames	string[]	No	Filtering by metric names

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
Alarms	DescribeBasicAlarmListAlarms[]	Alarm list.
Total	integer	Total number.
Warning	string	Remarks
RequestId	string	The unique request ID, which is returned for each request. RequestId is required for locating a problem.

Success

{
  "Response": {
    "Alarms": …,
    "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 · DescribeBasicAlarmList

{
  "Module": "<Module>"
}

Read-only. Creates nothing.

Recorded example response

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