获取SQL日志

最近更新时间:2018-09-28 15:00:31

1. 接口描述

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

本接口(DescribeSqlLogs)用于获取实例SQL日志。

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

注意:本接口支持金融区地域。由于金融区和非金融区是隔离不互通的,因此当公共参数 Region 为金融区地域(例如 ap-shanghai-fsi )时,需要同时指定带金融区地域的域名,最好和 Region 的地域保持一致,例如:mariadb.ap-shanghai-fsi.tencentcloudapi.com 。

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeSqlLogs
Version String 公共参数,本接口取值:2017-03-12
Region String 公共参数,详见产品支持的地域列表
InstanceId String 实例 ID,形如:tdsql-ow728lmc,可以通过 DescribeDBInstances 查询实例详情获得。
Offset Integer SQL日志偏移。
Limit Integer 拉取数量(0-1000,为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": {
    "Count": 0,
    "EndOffset": 55766447,
    "Offset": 53560502,
    "RequestId": "f2ede2fd-34b9-4e44-95d5-3198c137b73b",
    "SqlItems": [],
    "StartOffset": 53560502,
    "TotalCount": 2205945
  }
}

示例2 拉取SQL日志

输入示例

https://mariadb.tencentcloudapi.com/?Action=DescribeSqlLogs
&InstanceId=tdsql-6a0lwzzj
&Offset=53560502
&Limit=1
&<公共请求参数>

输出示例

{
  "Response": {
    "Count": 1,
    "EndOffset": 55766782,
    "Offset": 53560502,
    "RequestId": "211bbabb-ffde-467f-b949-e4c61c64c6a6",
    "SqlItems": [
      {
        "AffectRowNum": 0,
        "Client": "10.10.10.32:34812",
        "DbName": "test",
        "Offset": 53560502,
        "ResultCode": 0,
        "SelectRowNum": 1,
        "Sql": "select * from t",
        "TimeCostMs": 0,
        "Timestamp": 1537542271,
        "User": "jkx_rsd"
      }
    ],
    "StartOffset": 53560502,
    "TotalCount": 2206280
  }
}

5. 开发者资源

API Explorer

该工具提供了在线调用、签名验证、 SDK 代码生成和快速检索接口等能力,能显著降低使用云 API 的难度,推荐使用。

SDK

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

命令行工具

6. 错误码

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

错误码 描述
FailedOperation.MsgQueueOperationFailed 消息队列操作失败。
InternalError.CamAuthFailed CAM鉴权请求失败。
InternalError.DbOperationFailed 查询数据库失败。
InvalidParameter.GenericParameterError 参数合法性校验错误。
ResourceUnavailable.InstanceStatusAbnormal 数据库实例状态不正确,当前无法操作。
UnauthorizedOperation.PermissionDenied 没有权限操作该接口或资源。