monitor · 2018-07-24

DescribeAccidentEventList

POST

Get the platform event 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/DescribeAccidentEventList 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: DescribeAccidentEventList' \
  -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.
UpdateTimeOrder	string	No	Sorting rule by UpdateTime. Valid values: asc and desc.
OccurTimeOrder	string	No	Sorting rule by OccurTime. Valid values: asc or desc. Sorting by UpdateTimeOrder takes priority.
AccidentType	string[]	No	Filter by event type. The value 1 indicates service issues. The value 2 indicates other subscriptions.
AccidentEvent	string[]	No	Filter by event. The value 1 indicates CVM storage issues. The value 2 indicates CVM network connection issues. The value 3 indicates that the CVM has an exception. The value 202 indicates that an ISP network jitter occurs.
AccidentStatus	string[]	No	Filter by event status. The value 0 indicates that the event has been recovered. The value 1 indicates that the event has not been recovered.
AccidentRegion	string[]	No	Filter by region where the event occurs. The value gz indicates Guangzhou. The value sh indicates Shanghai.
AffectResource	string	No	Filter by affected resource, such as ins-19a06bka.

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	DescribeAccidentEventListAlarms[]	Platform event list.
Total	integer	Total number of platform events.
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 · DescribeAccidentEventList

{
  "Module": "<Module>"
}

Read-only. Creates nothing.

Recorded example response

{
  "Alarms": [],
  "Total": 0
}