DescribeSQLLogRecords - 查询实例的SQL审计日志(停止维护)

更新时间:
复制 MD 格式

停止维护:可以正常调用,但不再维护。该接口用于查询RDS实例的SQL洞察(SQL审计)日志。

接口说明

该接口已停止维护:接口仍可以正常调用,但阿里云不再维护该接口。建议您使用 GetDasSQLLogHotData 接口。

注意事项

  • 本 API 无论调用成功或失败,单用户(主账号包括 RAM 账号)每分钟最多调用 1000 次。

  • 本 API 不支持查询 MySQL 实例 SQL 洞察试用版的 SQL 洞察日志。

  • 本 API 生成审计文件时(请求参数 Form 取值为 File),最多记录 100 万条日志,且不支持通过关键字筛选日志。

调试

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

调试

授权信息

当前API暂无授权信息透出。

请求参数

名称

类型

必填

描述

示例值

ClientToken

string

用于保证请求的幂等性,防止重复提交请求。由客户端生成该参数值,要保证在不同请求间唯一,最大值不超过 64 个 ASCII 字符,且该参数值中不能包含非 ASCII 字符。

ETnLKlblzczshOTUbOCz****

DBInstanceId

string

实例 ID。可调用 DescribeDBInstances 获取。

rm-uf6wjk5****

SQLId

integer

备用参数。

None

QueryKeywords

string

用于查询的关键字。

  • 通过 API 生成审计文件时(请求参数 Form 取值为 File),不支持通过关键字筛选。

  • 多个关键字以空格分隔,不超过 10 个关键字;各个关键字之间的逻辑关系为 and

  • 如果 SQL 语句中的字段名使用了反引号(`),以该字段名作为查询的关键字时,也需要输入反引号。例如,字段名为`id`,则输入`id`,而不是 id。

说明

输入关键字后,系统会以 DatabaseUserQueryKeywords 同时进行关键字匹配,三个请求参数之间的逻辑关系为 and

table_name

StartTime

string

查询开始时间,可查询当前日期 7 天内的数据。格式:yyyy-MM-ddTHH:mm:ssZ(UTC 时间)。

说明

当开通了 DAS 企业版 V3,使用其提供的 SQL 洞察和审计功能时,可查询数据热存储时长内的数据。通过 DescribeSqlLogConfig 可以查询开通的企业版信息。

2011-06-01T15:00:00Z

Database

string

数据库名称。默认为所有数据库,也可以输入数据库名称查询,一次只能输入一个。

Database

User

string

用户名称。默认为所有用户,也可以输入用户名称查询,一次只能输入一个。

user

Form

string

触发审计文件的生成或者返回 SQL 记录列表,取值:

  • File:若传入这个值,则触发审计文件的生成,只返回公共参数,需再调用 DescribeSQLLogFiles 接口获取文件的最终下载地址。

  • Stream:默认值,返回 SQL 记录列表。

说明

取值为 File 时,只支持 MySQL(高性能本地盘)和 SQL Server 实例,且最多记录 100 万条日志。

Stream

EndTime

string

查询结束时间,大于查询开始时间,与查询开始时间间隔小于等于 7 天。格式:yyyy-MM-ddTHH:mm:ssZ(UTC 时间)。

说明

当开通了 DAS 企业版 V3,使用其提供的 SQL 洞察和审计功能时,可查询数据热存储时长内的数据。通过 DescribeSqlLogConfig 可以查询开通的企业版信息。

2011-06-06T15:00:00Z

PageSize

integer

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

30

PageNumber

integer

页码,取值:大于 0 且不超过 Integer 的最大值。

默认值:1

1

返回参数

名称

类型

描述

示例值

object

返回参数详情。

Items

object

SQLRecord

array<object>

SQL 审计日志列表。

object

SQL 审计日志详情。

AccountName

string

执行操作的账号名称。

accounttest

DBName

string

数据库名称。

testDB

ExecuteTime

string

执行时间。格式:yyyy-MM-ddTHH:mm:ssZ(UTC 时间)。

2011-06-11T15:00:23Z

HostAddress

string

连接数据库的客户端 IP 地址。

192.168.XX.XX

ReturnRowCounts

integer

返回记录数。

30

SQLText

string

SQL 语句。

update test.zxb set id=0 limit 1

ThreadID

string

线程 ID。

1025865428

TotalExecutionTimes

integer

执行耗时,单位:微秒。

600

PageNumber

integer

页码。

1

PageRecordCount

integer

本页 SQL 审计日志个数。

30

RequestId

string

请求 ID。

08A3B71B-FE08-4B03-974F-CC7EA6DB1828

TotalRecordCount

integer

总记录数。

100

示例

正常返回示例

JSON格式

{
  "Items": {
    "SQLRecord": [
      {
        "AccountName": "accounttest",
        "DBName": "testDB",
        "ExecuteTime": "2011-06-11T15:00:23Z",
        "HostAddress": "192.168.XX.XX",
        "ReturnRowCounts": 30,
        "SQLText": "update test.zxb set id=0 limit 1",
        "ThreadID": "1025865428",
        "TotalExecutionTimes": 600
      }
    ]
  },
  "PageNumber": 1,
  "PageRecordCount": 30,
  "RequestId": "08A3B71B-FE08-4B03-974F-CC7EA6DB1828",
  "TotalRecordCount": 100
}

异常返回示例

JSON格式

{
    "RequestId": "7463B73D-35CC-4D19-A010-6B8D65D242EF",
    "HostId": "rds.aliyuncs.com",
    "Code": "UnsupportedOperation",
    "Message": "The specified action is not supported."
}

错误码

HTTP status code

错误码

错误信息

描述

400 InvalidDBInstanceId.NotFound The DBInstanceId provided does not exist in records. 提供的DBInstanceId不存在。
400 InvalidQueryTimeRange The query time range is invalid. 查询时间范围无效
400 Order.ComboInstanceNotAllowOperate A package instance is not allowed to operate independently. 套餐实例不允许单独操作。
400 Price.PricingPlanResultNotFound Pricing plan price result not found. 定价计划价格结果没有找到。
400 Order.NoRealNameAuthentication You 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. 您还未通过实名认证,不符合购买条件,请登录费用与成本进行实名认证。
400 InsufficientAvailableQuota Your account quota limit is less than 0, please recharge before trying to purchase. 您的账户可用额度小于0,请先充值后再尝试购买。
400 CommodityServiceCalling.Exception Failed to call commodity service. 调用商品服务返回失败。
400 RegionDissolvedEOM Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support. 客户您好,阿里云计划对当前地域进行优化调整,该区域云服务将停止运营,为确保您的业务连续性及数据迁移工作的平稳过渡,您目前无法操作新购类型的订单,感谢理解与支持。
400 Commodity.InvalidComponent The module you purchased is not legal, please buy it again. 您购买的模块不合法,请重新购买。
400 RegionEndTimeDissolvedAustralia Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024. 客户您好,该地域已裁撤。
400 Price.CommoditySys Commodity system call exception. 商品系统调用异常。
400 Pay.InsufficientBalance Insufficient available balance. 可用金不足。
400 Order.PeriodInvalid There is a problem with the period you selected, please choose again. 您选购的周期有问题,请重新选购。
400 pay.noCreditCard Account not bound to credit card. 账户未绑定信用卡。
400 Order.InstHasUnpaidOrder There is an unpaid order for the service you have purchased. Please pay or void it before placing the order. 您选购的服务存在未支付订单,请支付或作废后再下单。
400 noAvailablePaymentMethod No payment method is specified for your account. We recommend that you add a payment method. 没有为您的账户指定付款方式。我们建议您添加一种付款方式。
400 BasicInfoUncompleted Your information is incomplete. Complete your information before the operation. 您的基本信息未完善,请在操作前先完善您的基本信息。
400 Risk.RiskControlRejection Your account is abnormal, please contact customer service for details. 您的账户出现异常,详情请联系客服。
400 Api.NotSupport Specified api is not supported. 当前接口不支持。
400 ContainForbiddenLabelError There is a label that prohibits placing orders. Please contact your distributor for assistance. 存在禁止下单的标签,请联系您的分销商处理
400 InvalidInstanceLevel.DiskType Specified instance level not support request disk type 当前实例规格不支持该存储类型。
400 InvalidParam Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica. 指定的 wal_level 参数无效。实例中仍然存在复制槽,因此无法将其设置为replica。
400 KmsApiError User secret key invalid. 用户密钥失效。
400 System.SaleValidateFailed Sales expression validation system error. 销售表达式校验系统错误。
400 Abs.InvalidAccount.NotFound account is not found. 账户不存在。
400 SqlExecuteFailedOrTimeout sql command execution failed or timed out:%s. sql命令执行失败或执行超时
400 ColdData.EngineVersionNotSupport The current instance engine version not support coldDataEnabled. 当前实例引擎版本不支持归档冷数据。
400 ColdData.MinorVersionNotSupport The current instance minor version not support coldDataEnabled. 当前内核版本不支持归档冷数据。
400 IncorrectTargetClasscode The current instance type does not support this operation. 当前规格不支持此操作。
400 InvalidConnectionString.Duplicate Specified connection string already exists in the RDS. 链接地址名重复,请重新设置连接字符串。
400 RequiredParam.NotFound Required input param is not found. 没有传入必要的参数。
400 Parameters.Invalid Parameter error, please check the parameters. 参数错误,请检查参数。
400 BackupPolicyNotSupport Cold Data won't open with CrossBackup or Flash Backup, please check Backup Policy. 数据归档不支持跨地域备份和秒级快照,请检查备份策略。
400 InvalideStatus.Format The instance status does not support this operation. 实例状态不支持此操作。
400 InvalidReleasedKeepPolicy.Format Specified Released Keep Policy is not valid. 实例释放后的归档备份保留策略无效。
400 InvalidDBInstanceEngineType.Format the DB instance engine type does not support this operation. DB实例引擎类型不支持此操作。
400 Pay.NoCreditCard No credit cards. 无信用卡。
400 VpcNetworkTypeNotSupport The vpc network type instance does not support this operation. vpc网络类型实例不支持此操作。
400 MirrorInsExists Specified DB instance mirror ins already existed. 当前数据库实例镜像已存在。
400 UnsupportedClassCode The specified DB instance class stops selling. 实例规格停止售卖。
400 InvalidBackupSet The specified database does not exist in the backup set. 备份集中没有指定的数据库。
400 OrdTCommodityQueryError Failed to query for product. 查询产品失败。
400 ProductInstanceReleased The instance has been released. Please check before placing the order. 实例已释放,请核实后下单。
400 RegionEndTimeDissolvedIndia The region is no longer supported. 指定的地域无效。
500 ExternalFailure The request processing has failed due to external service failure. 请求服务失败,请稍后重试。
500 RequestMetaDataFailed The service request failed. Please try again later or contact service personnel. 请求服务失败,请稍后再试或联系服务人员。
500 InvokeProxyFailure The request processing has failed due to service failure of rds api. 由于rds api服务失败,请求处理失败。
403 OrderStatus.UnPaid The specified db instance has unpaid order. 实例当前存在未支付订单,请支付后重试。
403 InvalidReduceDiskSize The storage capacity after the scale-down must be larger than the used amount. 缩容目标容量不能小于当前存储空间使用量
403 CloudSSDNotSupport Cloud ssd does not support this operation, please upgrade to essd. SSD盘不支持此操作,请升级至ESSD。
403 InvalidUserOperatorPermission The user permission does not support this operation. 用户权限不支持此操作。
403 InvalidVswitchId Specified conn vswitch id is not valid. 指定的VSwitchId格式不正确或为空
403 IncorrectMinorVersion Current engine minor version does not support operations. 当前引擎小版本不支持此操作。
403 OperationDenied.ZoneResource There is no available zone for inventory. 没有可用的库存区域。
403 NotInFlowController Sorry,no permission. 非集团上云用户不可用,无权限。
403 InvalidKmsKey Kms key is disabled. Kms key已禁用。
403 InvalidInstanceLevel.Malformed Current DB instance level does not support this operation. 当前数据库实例级别不支持此操作。
404 InvalidClusterKms The current instance does not authorized to access the Key Management Service. 当前实例未授权访问密钥管理服务。
404 Request.NotFound The requested resource is not available. 请求的资源不可用。
404 HostInfo.NotFound The specified host info is not found. 指定的主机信息不存在。
408 OperationDenied.Timeout The request processing has failed due to timeout. 请求由于超时处理失败

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

变更历史

更多信息,参考变更详情