1. 接口描述
接口请求域名: ags.tencentcloudapi.com 。
本接口用于查询当前账号在指定地域的事件列表,支持按事件来源、资源对象、事件类型、事件级别及时间范围等条件筛选,并支持分页和时间排序。默认查询最近 1 小时的事件,支持查询最近 7 天内的事件。
默认接口请求频率限制:20次/秒。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数,本接口取值:DescribeEventCenterEvents。 |
| Version | 是 | String | 公共参数,本接口取值:2025-09-20。 |
| Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
| Filters.N | 否 | Array of Filter | 事件筛选条件,用于按事件来源、对象、类型、级别及工具等信息查询事件。 入参限制:最多支持 12 个筛选条件,同名筛选条件不可重复;每个条件支持 1~20 个值,每个值非空且不超过 256 字节。 支持的筛选字段:Source、ObjectType、ObjectId、EventType、EventLevel、Reason、EventId、ToolId、ToolType、Message。 |
| StartTime | 否 | String | 查询开始时间,包含该时间点。 参数格式:RFC3339 格式,例如 2026-10-23T13:28:00Z。 入参限制:必须早于 EndTime,且不能早于当前时间前 7 天。 默认值:不传时默认为 EndTime 前 1 小时。 示例值:2026-11-03T08:35:06+08:00 |
| EndTime | 否 | String | 查询结束时间,不包含该时间点。 参数格式:RFC3339 格式,例如 2026-10-23T14:28:00Z。 入参限制:必须晚于 StartTime,不应晚于当前时间。 默认值:不传时默认为当前时间。 查询范围为 [StartTime, EndTime)。 示例值:2026-11-03T09:35:06+08:00 |
| Offset | 否 | Integer | 分页偏移量。 取值范围:[0, 10000] 默认值:0 Raw 模式按去重后的事件分页,Aggregate 模式按聚合结果分页。 示例值:0 |
| Limit | 否 | Integer | 单次返回的最大结果条数。 取值范围:[1, 100] 默认值:10 示例值:100 |
| Order | 否 | String | 事件结果的时间排序方向。 枚举值:
默认值:Desc Raw 模式按事件发生时间排序;Aggregate 模式按聚合结果最近发生时间排序。 示例值:Asc |
| Mode | 否 | String | 事件查询模式。 枚举值:
默认值:Raw Raw 返回去重后的事件明细;Aggregate 返回聚合结果。 示例值:Raw |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| Events | Array of EventItem | 本次查询返回的事件明细或聚合结果列表。无匹配结果时返回空数组。 |
| TotalCount | Integer | 符合查询条件的结果总数,不受 Offset 和 Limit 影响。Raw 模式为去重后的事件总数,Aggregate 模式为聚合结果总数。 示例值:4 |
| StartTime | String | 本次查询实际使用的开始时间,RFC3339 格式,包含该时间点。 示例值:2026-10-23T13:28:00Z |
| EndTime | String | 本次查询实际使用的结束时间,RFC3339 格式,不包含该时间点。 示例值:2026-10-23T13:32:39.90197686Z |
| Mode | String | 本次查询实际使用的模式。 枚举值:
示例值:Raw |
| RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 查询事件
输入示例
POST / HTTP/1.1
Host: ags.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeEventCenterEvents
<公共请求参数>
{
"Filters": [
{
"Name": "ToolId",
"Values": [
"sdt-7dl0dcpn"
]
}
],
"StartTime": "2026-10-23T13:28:00Z",
"Offset": 0,
"Limit": 100,
"Order": "Asc",
"Mode": "Raw"
}
输出示例
{
"Response": {
"EndTime": "2026-10-23T13:32:39.90197686Z",
"Events": [
{
"EventId": "17083c5e-4af9-4a63-b012-6ac843847bd2",
"EventLevel": "Normal",
"EventType": "SandboxStarting",
"Extensions": "{\"ToolId\":\"sdt-7dl0dcpn\",\"ToolType\":\"code-interpreter\",\"ToolName\":\"event-center-test-1023\"}",
"Message": "SandboxStarting",
"ObjectId": "sdt-7dl0dcpn",
"ObjectType": "SandboxTool",
"OccurredAt": "2026-10-23T13:29:02.427Z",
"Source": "Sandbox"
}
],
"Mode": "Raw",
"StartTime": "2026-10-23T13:28:00Z",
"TotalCount": 4,
"RequestId": "d1fac4dc-5a56-47db-84e2-68ea97f6b4aa"
}
}
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: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Java: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for PHP: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Go: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Node.js: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for .NET: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for C++: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Ruby: CNB, GitHub, Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| InternalError | 内部错误。 |
| InvalidParameter | 参数错误。 |
| InvalidParameterValue | 参数取值错误。 |
| InvalidParameterValue.Filters | 筛选条件的名称、取值、数量或总长度不符合要求。 |
| InvalidParameterValue.Limit | 单次返回条数 Limit 不合法。 |
| InvalidParameterValue.Offset | 分页偏移量 Offset 不合法,必须大于或等于 0,且不能超过允许的最大偏移量。 |
| InvalidParameterValue.TimeRange | 查询时间范围不合法或超出可查询期限。 |
| UnsupportedOperation | 操作不支持。 |