1. 接口描述
接口请求域名： mariadb.tencentcloudapi.com 。
本接口（DescribeSqlLogs）用于获取实例SQL日志。
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：DescribeSqlLogs。 |
| Version | 是 | String | 公共参数，本接口取值：2017-03-12。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表。 |
| InstanceId | 是 | String | 实例 ID，形如：tdsql-ow728lmc，可以通过 DescribeDBInstances 查询实例详情获得。 |
| Offset | 否 | Integer | SQL日志偏移。 |
| Limit | 否 | Integer | 拉取数量（0-10000，为0时拉取总数信息）。 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| TotalCount | Integer | 当前消息队列中的sql日志条目数。 |
| StartOffset | Integer | 消息队列中的sql日志起始偏移。 |
| EndOffset | Integer | 消息队列中的sql日志结束偏移。 |
| Offset | Integer | 返回的第一条sql日志的偏移。 |
| Count | Integer | 返回的sql日志数量。 |
| SqlItems | Array of SqlLogItem | Sql日志列表。 |
| RequestId | String | 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 拉取SQL日志起始偏移及日志数量
输入示例
https://mariadb.tencentcloudapi.com/?Action=DescribeSqlLogs
&InstanceId=tdsql-6a0lwzzj
&Limit=0
&<公共请求参数>输出示例
{
"Response": {
"RequestId": "f2ede2fd-34b9-4e44-95d5-3198c137b73b",
"TotalCount": 2205945,
"StartOffset": 53560502,
"EndOffset": 55766447,
"Offset": 53560502,
"Count": 0,
"SqlItems": []
}
}示例2 拉取SQL日志
输入示例
https://mariadb.tencentcloudapi.com/?Action=DescribeSqlLogs
&InstanceId=tdsql-6a0lwzzj
&Offset=53560502
&Limit=1
&<公共请求参数>输出示例
{
"Response": {
"RequestId": "211bbabb-ffde-467f-b949-e4c61c64c6a6",
"TotalCount": 2206280,
"StartOffset": 53560502,
"EndOffset": 55766782,
"Offset": 53560502,
"Count": 1,
"SqlItems": [
{
"Offset": 53560502,
"User": "jkx_rsd",
"Client": "10.10.10.32:34812",
"DbName": "test",
"Sql": "select * from t",
"SelectRowNum": 1,
"AffectRowNum": 0,
"Timestamp": 1537542271,
"TimeCostMs": 0,
"ResultCode": 0
}
]
}
}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
- Tencent Cloud SDK 3.0 for Java
- Tencent Cloud SDK 3.0 for PHP
- Tencent Cloud SDK 3.0 for Go
- Tencent Cloud SDK 3.0 for NodeJS
- Tencent Cloud SDK 3.0 for .NET
- Tencent Cloud SDK 3.0 for C++
- Tencent Cloud SDK 3.0 for Ruby
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| FailedOperation.MsgQueueOperationFailed | 消息队列操作失败。 |
| InternalError.CamAuthFailed | CAM鉴权请求失败。 |
| InternalError.DbOperationFailed | 查询数据库失败。 |
| InvalidParameter.GenericParameterError | 参数合法性校验错误。 |
| ResourceUnavailable.InstanceStatusAbnormal | 数据库实例状态不正确，当前无法操作。 |
| UnauthorizedOperation.PermissionDenied | 没有权限操作该接口或资源。 |
