文档

DescribeSQLLogFiles - 查询SQL洞察(SQL审计)导出文件列表

更新时间:

该接口用于查询SQL洞察(SQL审计)导出文件列表。不支持查询通过控制台手动导出的SQL洞察日志文件,只支持查询通过DescribeSQLLogRecords接口生成(请求参数Form取值为File)的SQL洞察文件列表。

接口说明

适用引擎

  • RDS MySQL
  • RDS PostgreSQL
  • RDS SQL Server
    说明 仅支持 SQL Server 2008 R2

注意事项

  • 本 API 不支持查询 MySQL 实例 SQL 洞察试用版的 SQL 洞察列表。
  • 本 API 不支持查询通过控制台手动导出的 SQL 洞察日志文件,只支持查询通过 DescribeSQLLogRecords API 生成(请求参数 Form 取值为 File)的 SQL 洞察文件列表。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
rds:DescribeSQLLogFilesREAD
  • DBInstance
    acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}
  • rds:ResourceTag

请求参数

名称类型必填描述示例值
DBInstanceIdstring

实例 ID。可调用 DescribeDBInstances 获取。

rm-uf6wjk5****
FileNamestring

审计文件名称。

custins****.csv
PageSizeinteger

每页记录数,取值:30~200。默认值:30

30
PageNumberinteger

页码,取值:1-100000。 默认值:1

1

返回参数

名称类型描述示例值
object

返回参数详情。

RequestIdstring

请求 ID。

1AD222E9-E606-4A42-BF6D-8A4442913CEF
PageNumberinteger

页码。

1
PageRecordCountinteger

本页记录数。

10
TotalRecordCountinteger

总记录数。

10
Itemsobject []

审计文件列表。

FileIDstring

文件名称。

custins****.csv
LogStartTimestring

SQL 起始时间。格式:yyyy-MM-ddTHH:mm:ssZ(UTC 时间)。

2015-05-23T07:00:00Z
LogSizestring

日志文件大小,单位:Byte。

3000
LogDownloadURLstring

下载地址。若当前不可下载,则为空。

http://rdslog-hz-v3.oss-cn-hangzhou.aliyuncs.com/****
LogEndTimestring

SQL 结束时间。格式:yyyy-MM-ddTHH:mm:ssZ(UTC 时间)。

2015-05-24T07:00:00Z
LogStatusstring

文件当前状态,取值:

  • Success:生成成功
  • Failed:生成失败
  • Generating:生成中
Success

示例

正常返回示例

JSON格式

{
  "RequestId": " 1AD222E9-E606-4A42-BF6D-8A4442913CEF",
  "PageNumber": 1,
  "PageRecordCount": 10,
  "TotalRecordCount": 10,
  "Items": {
    "LogFile": [
      {
        "FileID": "custins****.csv",
        "LogStartTime": "2015-05-23T07:00:00Z",
        "LogSize": "3000",
        "LogDownloadURL": "http://rdslog-hz-v3.oss-cn-hangzhou.aliyuncs.com/****",
        "LogEndTime": "2015-05-24T07:00:00Z",
        "LogStatus": "Success"
      }
    ]
  }
}

错误码

HTTP status code错误码错误信息描述
400Order.ComboInstanceNotAllowOperateA package instance is not allowed to operate independently.套餐实例不允许单独操作。
400Price.PricingPlanResultNotFoundPricing plan price result not found.定价计划价格结果没有找到。
400Order.NoRealNameAuthenticationYou have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.您还未通过实名认证,不符合购买条件,请登录用户中心进行实名认证。

访问错误中心查看更多错误码。

  • 本页导读 (1)
文档反馈