该接口用于查看实例的慢日志明细。
接口说明
适用引擎
- RDS MySQL
- RDS PostgreSQL
- RDS SQL Server
- RDS MariaDB
注意事项
- 本接口的返回参数每分钟更新一次。
- 2023年12月13日起,由于慢SQL的模板化算法优化,调用本接口时,SQLHash字段的值将发生变更。详情请参见【通知】慢SQL的模板化算法优化。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI
Explorer可以自动生成SDK代码示例。
调试调试
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
rds:DescribeSlowLogRecords | READ |
|
|
无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
DBInstanceId | string | 是 |
实例ID。可调用DescribeDBInstances获取。 |
rm-uf6wjk5**** |
SQLHASH | string | 否 |
慢日志统计里的SQL语句唯一标识符,可用于获取该SQL语句的慢日志明细。 |
U2FsdGVk**** |
StartTime | string | 是 |
查询开始时间,最大不能早于当前时间30天。格式:yyyy-MM-ddTHH:mmZ(UTC时间)。 |
2020-06-17T16:00Z |
EndTime | string | 是 |
查询结束时间,需要晚于查询开始时间。格式:yyyy-MM-ddTHH:mmZ(UTC时间)。 |
2020-06-18T16:00Z |
DBName | string | 否 |
数据库名称。 |
testdb |
PageSize | integer | 否 |
每页记录数,取值:30~100。 说明 | 30 |
PageNumber | integer | 否 | 页码,取值:大于0且不超过Integer的最大值。 说明 | 1 |
NodeId | string | 否 | 节点ID。 注意 该参数仅适用于集群版实例,可以选择查询指定节点日志。若不传该参数,默认返回主节点日志。 |
rn-p1fm78s90x5**** |
返回参数
名称 | 类型 | 描述 | 示例值 |
---|---|---|---|
object |
返回参数详情。 |
||
PageRecordCount | integer |
本页SQL语句个数。 |
1 |
RequestId | string |
请求ID。 |
4DBB1BB0-E5D8-4D41-B1C9-142364DB**** |
TotalRecordCount | integer |
总记录数。 |
1 |
DBInstanceId | string |
实例ID。 |
rm-uf6wjk5**** |
Engine | string |
数据库类型。 |
MySQL |
PageNumber | integer |
页码。 |
1 |
Items | object [] |
慢日志明细列表。 |
|
HostAddress | string |
连接数据库的客户端名称及地址。 |
****[****] @ [1XX.XX.XX.XX] |
RowsAffectedCount | long |
影响行数。 说明 | 34 |
QueryTimes | long | 执行时长。单位:秒(s)。 |
2 |
SQLText | string |
SQL命令详情。 |
select sleep(2) |
CpuTime | long |
CPU处理时长。单位:毫秒(ms)。 说明 | 0.002 |
QueryTimeMS | long | 执行时长。单位:毫秒(ms)。 |
2001 |
ApplicationName | string |
连接的应用名称。 说明 | example |
LockTimes | long | 锁定时长。单位:秒(s)。 |
0 |
ExecutionStartTime | string |
执行开始时间。格式:yyyy-MM-ddTHH:mm:ssZ(UTC时间)。 |
2020-06-18T01:40:44Z |
LogicalIORead | long |
逻辑读次数。 说明 | 383 |
WriteIOCount | long | I/O写入次数。 说明 | 22 |
PhysicalIORead | long | 物理读次数。 说明 | 200 |
ReturnRowCounts | long | 返回行数。 |
1 |
ParseRowCounts | long |
解析行数。 |
1 |
DBName | string |
数据库名称。 |
testDB |
ClientHostName | string |
客户端主机名。 说明 | example |
UserName | string | 用户名。 说明 | user |
LastRowsAffectedCount | long | 最后一条语句的影响行数。 说明 | 2 |
SQLHash | string | 慢日志明细里的SQL语句唯一标识符。 |
U2FsdGVk**** |
示例
正常返回示例
JSON
格式
{
"PageRecordCount": 1,
"RequestId": "4DBB1BB0-E5D8-4D41-B1C9-142364DB****",
"TotalRecordCount": 1,
"DBInstanceId": "rm-uf6wjk5****",
"Engine": "MySQL",
"PageNumber": 1,
"Items": {
"SQLSlowRecord": [
{
"HostAddress": "****[****] @ [1XX.XX.XX.XX]",
"RowsAffectedCount": 34,
"QueryTimes": 2,
"SQLText": "select sleep(2)",
"CpuTime": 0.002,
"QueryTimeMS": 2001,
"ApplicationName": "example",
"LockTimes": 0,
"ExecutionStartTime": "2020-06-18T01:40:44Z",
"LogicalIORead": 383,
"WriteIOCount": 22,
"PhysicalIORead": 200,
"ReturnRowCounts": 1,
"ParseRowCounts": 1,
"DBName": "testDB",
"ClientHostName": "example",
"UserName": "user",
"LastRowsAffectedCount": 2,
"SQLHash": "U2FsdGVk****"
}
]
}
}
错误码
HTTP status code | 错误码 | 错误信息 | 描述 |
---|---|---|---|
400 | InvalidSearchTimeRange | search time range cannot be longer than a month. | 查询结束时间(参数名称:EndTime)与查询开始时间(参数名称:StartTime)的间隔应小于31天,请输入正确的相关参数。 |
400 | IO.Exception | IO exception, retry later. | io异常。 |
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 | ||||||||
---|---|---|---|---|---|---|---|---|---|---|
2023-06-06 | OpenAPI 错误码发生变更 | 看变更集 | ||||||||
|
||||||||||
2023-06-02 | OpenAPI 错误码发生变更,OpenAPI 入参发生变更 | 看变更集 | ||||||||
|
内容没看懂? 不太想学习?想快速解决? 有偿解决: 联系专家
阿里云企业补贴进行中: 马上申请
腾讯云限时活动1折起,即将结束: 马上收藏
同尘科技为腾讯云授权服务中心。
购买腾讯云产品享受折上折,更有现金返利:同意关联,立享优惠
转转请注明出处:https://www.yunxiaoer.com/154033.html