monitor · 2018-07-24

DescribeProductEventList

POST

Get the list of product events by page.

Wire call

Converge Cloud is RPC over HTTP. There is one path — / — and the action travels in the X-TC-Action header. The /monitor/DescribeProductEventList 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: DescribeProductEventList' \
  -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. It is fixed to monitor.
ProductName	string[]	No	Filter by product type. For example, "cvm" indicates Cloud Virtual Machine.
EventName	string[]	No	Filter by event name. For example, "guest_reboot" indicates instance restart.
InstanceId	string[]	No	Affected object, such as "ins-19708ino".
Dimensions	DescribeProductEventListDimensions[]	No	Filter by dimension, such as by public IP: 10.0.0.1.
RegionList	string[]	No	Region filter parameter for service events.
Type	string[]	No	Filter by event type. Valid values: ["status_change","abnormal"], which indicate events whose statuses have changed and events with exceptions respectively.
Status	string[]	No	Filter by event status. Valid values: ["recover","alarm","-"], which indicate that an event has been recovered, has not been recovered, and has no status respectively.
Project	string[]	No	Filter by project ID.
IsAlarmConfig	integer	No	Filter by alarm status configuration. The value 1 indicates that the alarm status has been configured. The value 0 indicates that the alarm status has not been configured.
TimeOrder	string	No	Sorting by update time. The value ASC indicates the ascending order. The value DESC indicates the descending order. The default value is DESC.
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.
Offset	integer	No	Page offset. The default value is 0.
Limit	integer	No	The number of parameters that can be returned on each page. The default value is 20.

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
Events	DescribeProductEventListEvents[]	Event list
OverView	DescribeProductEventListOverView	Event statistics.
Total	integer	Total number of events.
RequestId	string	The unique request ID, which is returned for each request. RequestId is required for locating a problem.

Success

{
  "Response": {
    "Events": …,
    "OverView": …,
    "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 · DescribeProductEventList

{
  "Module": "<Module>"
}

Read-only. Creates nothing.

Recorded example response

{
  "Events": [],
  "OverView": {
    "StatusChangeAmount": 0,
    "UnConfigAlarmAmount": 0,
    "UnNormalEventAmount": 0,
    "UnRecoverAmount": 0
  },
  "Total": 0
}