Catatan Rilis dan Pengumuman

Catatan Rilis

Pengenalan Produk

Ikhtisar Produk

Keunggulan

Kasus Penggunaan

Wilayah dan AZ

Lingkungan Jaringan

Pernyataan Lisensi

Panduan Pembelian

Ikhtisar Penagihan

Metode Pembelian

Pembayaran Jatuh Tempo

Pengembalian Dana

Deskripsi Biaya Penyesuaian Instans

Penagihan Ruang Cadangan

Memulai

Membuat Instans TencentDB for SQL Server

Menghubungkan ke Instans TencentDB for SQL Server

Mengelola Instans TencentDB for SQL Server

Panduan Operasi

Batas Penggunaan

Memelihara Instans

Menyesuaikan Konfigurasi Instans

Instans Baca Saja

Jaringan dan Keamanan

Manajemen Akun

Manajemen Database

Konfigurasi Parameter

Migrasi Data

Service Agreement

Service Level Agreement

Glosarium

Hubungi Kami

DescribeXEvents

Mode fokus

Ukuran font

Terakhir diperbarui: 2025-10-28 22:49:14

1. API Description

Domain name for API request: sqlserver.intl.tencentcloudapi.com.

This API is used to query the list of extended events.

A maximum of 20 requests can be initiated per second for this API.

We recommend you to use API Explorer

Try it

API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters

The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.

Parameter Name	Required	Type	Description
Action	Yes	String	Common Params. The value used for this API: DescribeXEvents.
Version	Yes	String	Common Params. The value used for this API: 2018-03-28.
Region	Yes	String	Common Params. For more information, please see the list of regions supported by the product.
InstanceId	Yes	String	Instance ID
EventType	Yes	String	Event type. Valid values: `slow` (Slow SQL event), `blocked` (blocking event), deadlock` (deadlock event).
StartTime	Yes	String	Generation start time of an extended file in the format of yyyy-MM-dd HH:mm:ss.
EndTime	Yes	String	Generation end time of an extended file in the format of yyyy-MM-dd HH:mm:ss.
Offset	No	Integer	Page number. Default value: `0`
Limit	No	Integer	Number of entries to be returned per page. Value range: 1-100. Default value: `20`

3. Output Parameters

Parameter Name	Type	Description
Events	Array of Events	List of extended events
TotalCount	Integer	Total number of extended events
RequestId	String	The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.

4. Example

Example1 DescribeXEvents

This example shows you how to query the record of an extended event for an instance, including slow SQL, blocking, and deadlock.

Input Example

POST / HTTP/1.1
Host: sqlserver.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeXEvents
<Common request parameters>

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

Output Example

{
    "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. Developer Resources

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

Command Line Interface

Tencent Cloud CLI 3.0

6. Error Code

The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.

Error Code	Description
FailedOperation.CosError	Failed to access COS.
FailedOperation.DBError	Database error.
FailedOperation.GcsError	The operation failed or the network timed out.
InvalidParameter.InputIllegal	Input error.
InvalidParameter.ParamsAssertFailed	An error occurred while converting parameter assertion.
ResourceNotFound.InstanceNotFound	The instance does not exist.
ResourceNotFound.ParamsNotFound	Parameter not found.
UnauthorizedOperation.PermissionDenied	CAM authentication error.

Bantuan dan Dukungan

Apakah halaman ini membantu?

Anda juga dapat Menghubungi Penjualan atau Mengirimkan Tiket untuk meminta bantuan.

masukan

tencent cloud

TencentDB for SQL Server