获取产品事件列表
最近更新时间: 2026-09-17 00:06:28
1. 接口描述
接口请求域名： monitor.api3.fincloud.tencent.cn。
分页获取产品事件的列表
默认接口请求频率限制：20次/秒。
接口更新时间：2020-01-02 10:12:28。
接口既验签名又鉴权。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。
| 参数名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Action | 是 | 否 | String | 公共参数，本接口取值：DescribeProductEventList |
| Version | 是 | 否 | String | 公共参数，本接口取值：2018-07-24 |
| Region | 是 | 否 | String | 公共参数，地域信息可通过DescribeRegions接口查看产品支持的地域列表 |
| Module | 是 | 否 | String | 接口模块名，固定值"monitor" 示例值： monitor |
| ProductName | 否 | 否 | Array of String | 产品类型过滤，比如"cvm"表示云服务器 示例值： cvm |
| EventName | 否 | 否 | Array of String | 事件名称过滤，比如"guest_reboot"表示机器重启 示例值： guest_reboot |
| InstanceId | 否 | 否 | Array of String | 影响对象，比如ins-19708ino 示例值： ins-19708ino |
| Dimensions | 否 | 否 | Array of DescribeProductEventListDimensions | 维度过滤，比如外网IP:10.0.0.1 示例值：查看 |
| RegionList | 否 | 否 | Array of String | 地域过滤，比如gz 示例值： gz |
| Type | 否 | 否 | Array of String | 事件类型过滤，取值范围["status_change","abnormal"]，分别表示状态变更、异常事件 示例值： abnormal |
| Status | 否 | 否 | Array of String | 事件状态过滤，取值范围["recover","alarm","-"]，分别表示已恢复、未恢复、无状态 示例值： recover |
| Project | 否 | 否 | Array of String | 项目ID过滤 示例值： 0 |
| IsAlarmConfig | 否 | 否 | Int64 | 告警状态配置过滤，1表示已配置，0表示未配置 示例值： 1 |
| TimeOrder | 否 | 否 | String | 按更新时间排序，ASC表示升序，DESC表示降序，默认DESC 示例值： DESC |
| StartTime | 否 | 否 | Int64 | 起始时间，默认一天前的时间戳 示例值： 1572624000 |
| EndTime | 否 | 否 | Int64 | 结束时间，默认当前时间戳 示例值： 1573228799 |
| Offset | 否 | 否 | Int64 | 页偏移量，默认0 示例值： 0 |
| Limit | 否 | 否 | Int64 | 每页返回的数量，默认20 示例值： 20 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| Events | Array of DescribeProductEventListEvents | 事件列表 示例值：查看 |
| OverView | DescribeProductEventListOverView | 事件统计 示例值：查看 |
| Total | Int64 | 事件总数 示例值： 6 |
| RequestId | String | 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 |
4. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见公共错误码。
| 错误码 | 描述 |
|---|---|
| InvalidParameterValue | 无效的参数值。 |
| InternalError | 内部错误。 |
| InvalidParameter.InvalidParameterParam | 参数错误。 |
| InvalidParameter.InvalidParameter | 参数错误。 |
| InvalidParameter | 参数错误。 |
| MissingParameter | 缺少参数错误。 |
| LimitExceeded | 超过配额限制。 |
5. 示例
示例1 获取产品事件列表
获取产品事件列表
输入示例
https://monitor.api3.fincloud.tencent.cn/?Action=DescribeProductEventList
&Module=monitor&TimeOrder=DESC&StartTime=1572624000&EndTime=1573228799&Offset=0&Limit=20
&<公共请求参数>
输出示例
{
"Response": {
"Events": [
{
"AdditionMsg": [],
"Dimensions": [
{
"Key": "deviceLanIp",
"Name": "内网IP",
"Value": "172.0.0.1"
},
{
"Key": "deviceWanIp",
"Name": "外网IP",
"Value": null
},
{
"Key": "uniqVpcId",
"Name": "私有网络ID",
"Value": null
}
],
"EventCName": "机器重启",
"EventEName": "GuestReboot",
"EventId": 43,
"EventName": "guest_reboot",
"InstanceId": "ins-19708ino",
"InstanceName": "qta_test",
"ProductCName": "云服务器",
"ProductEName": "Cloud Virtual Machine",
"ProductName": "cvm",
"ProjectId": 0,
"Region": "gz",
"StartTime": 1573110201,
"Status": "-",
"SupportAlarm": 1,
"Type": "abnormal",
"UpdateTime": 1573081401
},
{
"AdditionMsg": [],
"Dimensions": [
{
"Key": "deviceLanIp",
"Name": "内网IP",
"Value": "172.0.0.1"
},
{
"Key": "deviceWanIp",
"Name": "外网IP",
"Value": null
},
{
"Key": "uniqVpcId",
"Name": "私有网络ID",
"Value": null
}
],
"EventCName": "机器重启",
"EventEName": "GuestReboot",
"EventId": 43,
"EventName": "guest_reboot",
"InstanceId": "ins-19708ino",
"InstanceName": "qta_test",
"ProductCName": "云服务器",
"ProductEName": "Cloud Virtual Machine",
"ProductName": "cvm",
"ProjectId": 0,
"Region": "gz",
"StartTime": 1573023802,
"Status": "-",
"SupportAlarm": 1,
"Type": "abnormal",
"UpdateTime": 1572995002
},
{
"AdditionMsg": [],
"Dimensions": [
{
"Key": "deviceLanIp",
"Name": "内网IP",
"Value": "172.0.0.1"
},
{
"Key": "deviceWanIp",
"Name": "外网IP",
"Value": null
},
{
"Key": "uniqVpcId",
"Name": "私有网络ID",
"Value": null
}
],
"EventCName": "机器重启",
"EventEName": "GuestReboot",
"EventId": 43,
"EventName": "guest_reboot",
"InstanceId": "ins-19708ino",
"InstanceName": "qta_test",
"ProductCName": "云服务器",
"ProductEName": "Cloud Virtual Machine",
"ProductName": "cvm",
"ProjectId": 0,
"Region": "gz",
"StartTime": 1572937414,
"Status": "-",
"SupportAlarm": 1,
"Type": "abnormal",
"UpdateTime": 1572908614
},
{
"AdditionMsg": [],
"Dimensions": [
{
"Key": "deviceLanIp",
"Name": "内网IP",
"Value": "172.0.0.1"
},
{
"Key": "deviceWanIp",
"Name": "外网IP",
"Value": null
},
{
"Key": "uniqVpcId",
"Name": "私有网络ID",
"Value": null
}
],
"EventCName": "机器重启",
"EventEName": "GuestReboot",
"EventId": 43,
"EventName": "guest_reboot",
"InstanceId": "ins-19708ino",
"InstanceName": "qta_test",
"ProductCName": "云服务器",
"ProductEName": "Cloud Virtual Machine",
"ProductName": "cvm",
"ProjectId": 0,
"Region": "gz",
"StartTime": 1572851042,
"Status": "-",
"SupportAlarm": 1,
"Type": "abnormal",
"UpdateTime": 1572822242
},
{
"AdditionMsg": [],
"Dimensions": [
{
"Key": "deviceLanIp",
"Name": "内网IP",
"Value": "172.0.0.1"
},
{
"Key": "deviceWanIp",
"Name": "外网IP",
"Value": null
},
{
"Key": "uniqVpcId",
"Name": "私有网络ID",
"Value": null
}
],
"EventCName": "机器重启",
"EventEName": "GuestReboot",
"EventId": 43,
"EventName": "guest_reboot",
"InstanceId": "ins-19708ino",
"InstanceName": "qta_test",
"ProductCName": "云服务器",
"ProductEName": "Cloud Virtual Machine",
"ProductName": "cvm",
"ProjectId": 0,
"Region": "gz",
"StartTime": 1572764569,
"Status": "-",
"SupportAlarm": 1,
"Type": "abnormal",
"UpdateTime": 1572735769
},
{
"AdditionMsg": [],
"Dimensions": [
{
"Key": "deviceLanIp",
"Name": "内网IP",
"Value": "172.0.0.1"
},
{
"Key": "deviceWanIp",
"Name": "外网IP",
"Value": null
},
{
"Key": "uniqVpcId",
"Name": "私有网络ID",
"Value": null
}
],
"EventCName": "机器重启",
"EventEName": "GuestReboot",
"EventId": 43,
"EventName": "guest_reboot",
"InstanceId": "ins-19708ino",
"InstanceName": "qta_test",
"ProductCName": "云服务器",
"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
}
}