有奖征文:轻量对象存储LighthouseCOS用户实践> HOT

1. 接口描述

接口请求域名: monitor.tencentcloudapi.com 。

分页获取产品事件的列表

默认接口请求频率限制:20次/秒。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeProductEventList。
Version String 公共参数,本接口取值:2018-07-24。
Region String 公共参数,详见产品支持的 地域列表
Module String 接口模块名,固定值"monitor"
示例值:monitor
ProductName.N Array of String 产品类型过滤,例如"cvm"表示云服务器
示例值:cvm
EventName.N Array of String 事件名称过滤,例如"guest_reboot"表示机器重启
示例值:guest_reboot
InstanceId.N Array of String 影响对象,例如"ins-19708ino"
示例值:ins-19708ino
Dimensions.N Array of DescribeProductEventListDimensions 维度过滤,例如外网IP:10.0.0.1
RegionList.N Array of String 产品事件地域过滤参数,例如gz,各地域缩写可参见地域列表
示例值:gz
Type.N Array of String 事件类型过滤,取值范围["status_change","abnormal"],分别表示状态变更、异常事件
示例值:abnormal
Status.N Array of String 事件状态过滤,取值范围["recover","alarm","-"],分别表示已恢复、未恢复、无状态
示例值:recover
Project.N Array of String 项目ID过滤
示例值:0
IsAlarmConfig Integer 告警状态配置过滤,1表示已配置,0表示未配置
示例值:1
TimeOrder String 按更新时间排序,ASC表示升序,DESC表示降序,默认DESC
示例值:DESC
StartTime Integer 起始时间,默认一天前的时间戳
示例值:1572624000
EndTime Integer 结束时间,默认当前时间戳
示例值:1573228799
Offset Integer 页偏移量,默认0
示例值:0
Limit Integer 每页返回的数量,默认20
示例值:20

3. 输出参数

参数名称 类型 描述
Events Array of DescribeProductEventListEvents 事件列表
注意:此字段可能返回 null,表示取不到有效值。
OverView DescribeProductEventListOverView 事件统计
Total Integer 事件总数
注意:此字段可能返回 null,表示取不到有效值。
示例值:6
RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 获取产品事件列表

获取产品事件列表

输入示例

POST / HTTP/1.1
Host: monitor.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeProductEventList
<公共请求参数>

{
    "Module": "monitor",
    "TimeOrder": "DESC",
    "Limit": "20",
    "StartTime": "1572624000",
    "Offset": "0",
    "EndTime": "1573228799"
}

输出示例

{
    "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
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码

错误码 描述
FailedOperation 操作失败。
InternalError 内部错误。
InvalidParameter 参数错误。
InvalidParameter.InvalidParameter 参数错误。
InvalidParameter.InvalidParameterParam 参数错误。
InvalidParameterValue 参数取值错误。
LimitExceeded 超过配额限制。
MissingParameter 缺少参数错误。
UnsupportedOperation 操作不支持。