云数据库 SQL Server 查询日志实例列表

1. 接口描述

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

日志实例列表查询

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

推荐使用 API Explorer

点击调试

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

2. 输入参数

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

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：DescribeLogInstanceList。
Version	是	String	公共参数，本接口取值：2018-03-28。
Region	是	String	公共参数，详见产品支持的地域列表。
LogType	是	String	日志类型：auditLog,slowLog,errorLog 示例值：auditLog
Limit	否	Integer	单页条数限制，取值[0, 100) 示例值：20
Offset	否	Integer	偏移量，大于0 示例值：1
Filters.N	否	Array of Filter	业务侧实例过滤参数
LogSwitch	否	String	日志开关,不传查询所有日志实例： on-开启，off-未开启。示例值：on

3. 输出参数

参数名称	类型	描述
TotalCount	Integer	实例数量示例值：1
Items	Array of LogInstance	日志平台实例信息
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询日志实例列表

输入示例

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

{
    "LogType": "auditLog",
    "Limit": 3,
    "Offset": 0
}

输出示例

{
    "Response": {
        "Items": [
            {
                "CreateAt": "",
                "Deliver": "",
                "DeliverSummary": null,
                "EnableQuery": "",
                "HighLogExpireDay": 0,
                "HighStorage": 0,
                "InstanceId": "mssql-m7v8e9k9",
                "InstanceInfo": {
                    "Architecture": "DOUBLE",
                    "AuditLogHosts": null,
                    "AuditLogStatus": "OFF",
                    "AuditLogStatusMessage": null,
                    "HAFlag": "ALWAYSON",
                    "InstanceId": "mssql-m7v8e9k9",
                    "InstanceName": "sqlsvr_auto_usage_20260314040300",
                    "InstanceType": "cvmHA",
                    "ProjectId": 0,
                    "ROFlag": "",
                    "Region": "ap-guangzhou",
                    "RegionId": 1,
                    "Status": 2,
                    "TagList": null,
                    "Type": "CLOUD_BSSD",
                    "Version": "2017",
                    "VersionName": "SQL Server 2017 Enterprise",
                    "Vip": "172.16.80.46",
                    "Vport": null,
                    "Zone": "ap-guangzhou-7",
                    "ZoneId": 100007
                },
                "LogExpireDay": 0,
                "LogStorage": 0,
                "LowLogExpireDay": 0,
                "LowStorage": 0,
                "Status": ""
            }
        ],
        "TotalCount": 38,
        "RequestId": "0fc9d9c5-0e51-422c-8f93-707670a9f41f"
    }
}

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

命令行工具

Tencent Cloud CLI 3.0

6. 错误码

该接口暂无业务逻辑相关的错误码，其他错误码详见公共错误码。

查询日志实例列表

本页目录：