查看事件列表

最近更新时间：2024-03-12 01:50:11

我的收藏

本页目录：

1. 接口描述

接口请求域名： tchd.tencentcloudapi.com 。

本接口用于查询腾讯云健康看板的可用性事件信息，可以通过产品列表、地域列表和事件发生日期进行过滤查询。

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

推荐使用 API Explorer

点击调试

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

2. 输入参数

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

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：DescribeEvents。
Version	是	String	公共参数，本接口取值：2023-03-06。
Region	否	String	公共参数，此参数为可选参数。
EventDate	是	Date	事件的发生日期示例值：2023-06-22
ProductIds.N	否	Array of String	1. 不指定产品列表时将查询所有产品。 2. 产品ID示例：cvm、lb、cdb、cdn、crs 示例值：["cvm","clb"]
RegionIds.N	否	Array of String	1. 不指定地域列表时将查询所有地域。 2. 查询非区域性产品事件时，地域ID指定为：non-regional 3. 其他地域ID取值请参考：https://cloud.tencent.com/document/api/213/15692 示例值：["ap-guangzhou","ap-shanghai"]

3. 输出参数

参数名称	类型	描述
Data	ProductEventList	事件详情列表示例值：{ "EventList": [ { "ProductId": "cvm", "ProductName": "云服务器", "RegionId": "ap-chongqing", "RegionName": "重庆", "StartTime": "2023-06-09 14:16:00", "EndTime": "2023-06-09 14:28:00", "CurrentStatus": "正常" } ] }
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询可用性事件列表

查询2023年6月9日发生在广州和上海地域的所有云产品可用性事件

输入示例

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

{
    "ProductIds": [
        "cvm"
    ],
    "RegionIds": [
        "ap-guangzhou",
        "ap-shanghai"
    ],
    "EventDate": "2023-06-09"
}

输出示例

{
    "Response": {
        "Data": {
            "EventList": [
                {
                    "ProductId": "cvm",
                    "ProductName": "云服务器",
                    "RegionId": "ap-chongqing",
                    "RegionName": "重庆",
                    "StartTime": "2023-06-09 14:16:00",
                    "EndTime": "2023-06-09 14:28:00",
                    "CurrentStatus": "正常"
                }
            ]
        },
        "RequestId": "76a0ee91-c081-4a9c-9ba6-ad7e15f06ce4"
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

Tencent Cloud SDK 3.0 for Python: GitHub Gitee
Tencent Cloud SDK 3.0 for Java: GitHub Gitee
Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
Tencent Cloud SDK 3.0 for Go: GitHub Gitee
Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
Tencent Cloud SDK 3.0 for C++: GitHub Gitee
Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee

命令行工具

Tencent Cloud CLI 3.0

6. 错误码

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

错误码	描述
InternalError	内部错误。
InvalidParameter	参数错误。
InvalidParameterValue	参数取值错误。