查询扩展事件列表

最近更新时间:2024-03-12 01:47:16

我的收藏

1. 接口描述

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

本接口(DescribeXEvents)用于查询扩展事件列表。

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeXEvents。
Version String 公共参数,本接口取值:2018-03-28。
Region String 公共参数,详见产品支持的 地域列表
InstanceId String 实例ID
示例值:mssql-wy78shs8
EventType String 事件类型,slow-慢SQL事件,blocked-阻塞事件,deadlock-死锁事件
示例值:slow
StartTime String 扩展文件生成开始时间(yyyy-MM-dd HH:mm:ss)
示例值:2023-01-01 12:00:00
EndTime String 扩展文件生成结束时间(yyyy-MM-dd HH:mm:ss)
示例值:2023-01-01 12:05:00
Offset Integer 分页返回,页编号,默认值为第0页
示例值:0
Limit Integer 分页返回,每页返回的数目,取值为1~100,默认值为20
示例值:10

3. 输出参数

参数名称 类型 描述
Events Array of Events 扩展事件列表
示例值:[]
TotalCount Integer 扩展事件总数量
示例值:0
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 DescribeXEvents

查询实例的扩展事件记录,包括慢SQL、阻塞、死锁

输入示例

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

{
    "Offset": 0,
    "Limit": 2,
    "StartTime": "2023-03-05 11:49:08",
    "EndTime": "2023-03-13 11:49:08",
    "EventType": "slow",
    "InstanceId": "mssql-qp7gu6ch"
}

输出示例

{
    "Response": {
        "RequestId": "023a2da2-c152-11ed-b1aa-525400853186",
        "TotalCount": 10,
        "Events": [
            {
                "EndTime": "2023-03-10 15:45:05",
                "EventType": "slow",
                "ExternalAddr": "https://***",
                "FileName": "autoed_instance_58001_20230220110419.xel",
                "Id": 1004,
                "InternalAddr": "https:***",
                "Size": 10240,
                "StartTime": "2023-03-10 15:44:15",
                "Status": 1
            }
        ]
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

命令行工具

6. 错误码

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

错误码 描述
FailedOperation.CosError 查询对象存储失败。
FailedOperation.DBError 数据库错误。
FailedOperation.GcsError 操作失败或者网络超时。
InvalidParameter.InputIllegal 输入错误。
InvalidParameter.ParamsAssertFailed 参数断言转换错误。
ResourceNotFound.InstanceNotFound 实例不存在。
ResourceNotFound.ParamsNotFound 参数未找到。
UnauthorizedOperation.PermissionDenied cam鉴权错误。