Domain name for API request: monitor.tencentcloudapi.com.
This API is used to get the list of product events by page.
A maximum of 20 requests can be initiated per second for this API.
Note: This API supports Finance regions. If the common parameter Region is a Finance region, a domain name with the Finance region needs to be specified, for example: monitor.ap-shanghai-fsi.tencentcloudapi.com
The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| Action | Yes | String | Common parameter. The value used for this API: DescribeProductEventList. |
| Version | Yes | String | Common parameter. The value used for this API: 2018-07-24. |
| Region | Yes | String | Common parameter. For more information, please see the list of regions supported by the product. |
| Module | Yes | String | API component name. It is fixed to monitor. |
| ProductName.N | No | Array of String | Filter by product type. For example, 'cvm' indicates Cloud Virtual Machine. |
| EventName.N | No | Array of String | Filter by product name. For example, "guest_reboot" indicates server restart. |
| InstanceId.N | No | Array of String | Affected object, such as ins-19708ino. |
| Dimensions.N | No | Array of DescribeProductEventListDimensions | Filter by dimension, such as by public IP: 10.0.0.1. |
| RegionList.N | No | Array of String | Filter by region, such as by gz. |
| Type.N | No | Array of String | Filter by event type. Valid values: ["status_change","abnormal"], which indicate events whose statuses have changed and events with exceptions respectively. |
| Status.N | No | Array of String | 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.N | No | Array of String | Filter by project ID. |
| IsAlarmConfig | No | Integer | 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 | No | String | Sorting by update time. The value ASC indicates the ascending order. The value DESC indicates the descending order. The default value is DESC. |
| StartTime | No | Integer | Start time, which is the timestamp one day prior by default. |
| EndTime | No | Integer | End time, which is the current timestamp by default. |
| Offset | No | Integer | Page offset. The default value is 0. |
| Limit | No | Integer | The number of parameters that can be returned on each page. The default value is 20. |
| Parameter Name | Type | Description |
|---|---|---|
| Events | Array of DescribeProductEventListEvents | Event list Note: This field may return null, indicating that no valid value was found. |
| OverView | DescribeProductEventListOverView | Event statistics. |
| Total | Integer | Total number of events. Note: This field may return null, indicating that no valid value was found. |
| RequestId | String | The unique request ID, which is returned for each request. RequestId is required for locating a problem. |
This example shows you how to get the list of product events.
https://monitor.tencentcloudapi.com/?Action=DescribeProductEventList
&Module=monitor
&TimeOrder=DESC
&StartTime=1572624000
&EndTime=1573228799
&Offset=0
&Limit=20
&<Common request parameters>{
"Response": {
"Events": [
{
"AdditionMsg": [],
"Dimensions": [
{
"Key": "deviceLanIp",
"Name": "Private IP",
"Value": "172.0.0.1"
},
{
"Key": "deviceWanIp",
"Name": "Public IP",
"Value": null
},
{
"Key": "uniqVpcId",
"Name": "VPC ID",
"Value": null
}
],
"EventCName": "Restart",
"EventEName": "GuestReboot",
"EventId": 43,
"EventName": "guest_reboot",
"InstanceId": "ins-19708ino",
"InstanceName": "qta_test",
"ProductCName": "CVM",
"ProductEName": "Cloud Virtual Machine",
"ProductName": "cvm",
"ProjectId": 0,
"Region": "gz",
"StartTime": 1573110201,
"Status": "-",
"SupportAlarm": 1,
"Type": "abnormal",
"UpdateTime": 1573081401
},
{
"AdditionMsg": [],
"Dimensions": [
{
"Key": "deviceLanIp",
"Name": "Private IP",
"Value": "172.0.0.1"
},
{
"Key": "deviceWanIp",
"Name": "Public IP",
"Value": null
},
{
"Key": "uniqVpcId",
"Name": "VPC ID",
"Value": null
}
],
"EventCName": "Restart",
"EventEName": "GuestReboot",
"EventId": 43,
"EventName": "guest_reboot",
"InstanceId": "ins-19708ino",
"InstanceName": "qta_test",
"ProductCName": "CVM",
"ProductEName": "Cloud Virtual Machine",
"ProductName": "cvm",
"ProjectId": 0,
"Region": "gz",
"StartTime": 1573023802,
"Status": "-",
"SupportAlarm": 1,
"Type": "abnormal",
"UpdateTime": 1572995002
},
{
"AdditionMsg": [],
"Dimensions": [
{
"Key": "deviceLanIp",
"Name": "Private IP",
"Value": "172.0.0.1"
},
{
"Key": "deviceWanIp",
"Name": "Public IP",
"Value": null
},
{
"Key": "uniqVpcId",
"Name": "VPC ID",
"Value": null
}
],
"EventCName": "Restart",
"EventEName": "GuestReboot",
"EventId": 43,
"EventName": "guest_reboot",
"InstanceId": "ins-19708ino",
"InstanceName": "qta_test",
"ProductCName": "CVM",
"ProductEName": "Cloud Virtual Machine",
"ProductName": "cvm",
"ProjectId": 0,
"Region": "gz",
"StartTime": 1572937414,
"Status": "-",
"SupportAlarm": 1,
"Type": "abnormal",
"UpdateTime": 1572908614
},
{
"AdditionMsg": [],
"Dimensions": [
{
"Key": "deviceLanIp",
"Name": "Private IP",
"Value": "172.0.0.1"
},
{
"Key": "deviceWanIp",
"Name": "Public IP",
"Value": null
},
{
"Key": "uniqVpcId",
"Name": "VPC ID",
"Value": null
}
],
"EventCName": "Restart",
"EventEName": "GuestReboot",
"EventId": 43,
"EventName": "guest_reboot",
"InstanceId": "ins-19708ino",
"InstanceName": "qta_test",
"ProductCName": "CVM",
"ProductEName": "Cloud Virtual Machine",
"ProductName": "cvm",
"ProjectId": 0,
"Region": "gz",
"StartTime": 1572851042,
"Status": "-",
"SupportAlarm": 1,
"Type": "abnormal",
"UpdateTime": 1572822242
},
{
"AdditionMsg": [],
"Dimensions": [
{
"Key": "deviceLanIp",
"Name": "Private IP",
"Value": "172.0.0.1"
},
{
"Key": "deviceWanIp",
"Name": "Public IP",
"Value": null
},
{
"Key": "uniqVpcId",
"Name": "VPC ID",
"Value": null
}
],
"EventCName": "Restart",
"EventEName": "GuestReboot",
"EventId": 43,
"EventName": "guest_reboot",
"InstanceId": "ins-19708ino",
"InstanceName": "qta_test",
"ProductCName": "CVM",
"ProductEName": "Cloud Virtual Machine",
"ProductName": "cvm",
"ProjectId": 0,
"Region": "gz",
"StartTime": 1572764569,
"Status": "-",
"SupportAlarm": 1,
"Type": "abnormal",
"UpdateTime": 1572735769
},
{
"AdditionMsg": [],
"Dimensions": [
{
"Key": "deviceLanIp",
"Name": "Private IP",
"Value": "172.0.0.1"
},
{
"Key": "deviceWanIp",
"Name": "Public IP",
"Value": null
},
{
"Key": "uniqVpcId",
"Name": "VPC ID",
"Value": null
}
],
"EventCName": "Restart",
"EventEName": "GuestReboot",
"EventId": 43,
"EventName": "guest_reboot",
"InstanceId": "ins-19708ino",
"InstanceName": "qta_test",
"ProductCName": "CVM",
"ProductEName": "Cloud Virtual Machine",
"ProductName": "cvm",
"ProjectId": 0,
"Region": "gz",
"StartTime": 1572678255,
"Status": "-",
"SupportAlarm": 1,
"Type": "abnormal",
"UpdateTime": 1572649455
}
],
"OverView": {
"StatusChangeAmount": 0,
"UnConfigAlarmAmount": 6,
"UnNormalEventAmount": 6,
"UnRecoverAmount": 0
},
"RequestId": "313bac2f-04eb-477e-af2b-b4d58cbe5d08",
"Total": 6
}
}TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.
| Error Code | Description |
|---|---|
| InternalError | Internal error. |
| InvalidParameter | Invalid parameter. |
| InvalidParameter.InvalidParameter | Invalid parameter. |
| InvalidParameter.InvalidParameterParam | Invalid parameter. |
| InvalidParameterValue | The parameter value is incorrect. |
| LimitExceeded | Quota limit is reached. |
| MissingParameter | Missing parameter. |
| UnsupportedOperation | Unsupported operation. |
Was this page helpful?