调用GetFullRequestStatResultByInstanceId接口,按照SQL ID异步统计数据库实例SQL洞察结果中的全量请求数据。
接口说明
SQL 洞察功能可对 SQL 进行健康情况诊断、性能问题排查,详情请参见 SQL 洞察。
- 目前支持的数据库实例请参见 DAS 企业版使用说明。
- 在使用 SDK 调用 DAS 服务时,需要将地域指定为 cn-shanghai。
- 2024 年 09 月 01 日起,由于 SQL 的模板化算法优化,调用本接口时,SqlId 字段的值将发生变更。详情请参见【通知】SQL 模板化算法优化。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
hdm:GetFullRequestStatResultByInstanceId | get |
|
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
UserId | string | 否 | 用户 ID,即创建数据库实例的阿里云主账号 ID。 说明
非必填,输入目标数据库实例 ID 后,在调用 API 接口时,系统会自动获取用户 ID。
| 196278346919**** |
InstanceId | string | 是 | 实例 ID。 | rm-2ze8g2am97624**** |
NodeId | string | 否 | 节点 ID。 说明
对于 PolarDB MySQL 版实例,需要提供节点 ID。
| pi-bp12v7243x012**** |
SqlId | string | 否 | SQL ID。 说明
填写 SQL ID 时,统计目标 SQL ID 的全量请求数据;为空时,统计整个数据库实例的全量请求数据。
| d71f82be1eef72bd105128204d2e**** |
OriginHost | string | 否 | 执行 SQL 的客户端 IP 地址。 说明
非必填,输入目标客户端 IP 地址后,统计目标客户端 IP 地址的全量请求数据;为空时,统计整个数据库实例的全量请求数据。
| 172.26.XX.XXX |
Keyword | string | 否 | 查询关键词。 | dbtest01 |
Start | long | 是 | 查询开始时间,格式为 Unix 时间戳,单位为毫秒。 说明
查询开始时间需要在数据库实例 SQL 洞察存储时长范围内,最大不能早于当前时间 90 天。
| 1645581813000 |
End | long | 是 | 查询结束时间,格式为 Unix 时间戳,单位为毫秒。 说明
查询结束时间需晚于查询开始时间,且查询开始时间和查询结束时间的间隔不能超过 1 天。
| 1645668213000 |
OrderBy | string | 否 | 排序字段,默认为 count。
| count |
Asc | boolean | 否 | 升序排序开关,默认关闭。 | 关闭 |
PageNo | integer | 是 | 分页查询的页码,从 1 开始,默认为 1。 | 1 |
PageSize | integer | 是 | 分页查询每页数据量,默认为 20。 | 20 |
SqlType | string | 否 | SQL 语句的类型,取值包括:SELECT、INSERT、UPDATE、DELETE、LOGIN、LOGOUT、MERGE、ALTER、CREATEINDEX、DROPINDEX、CREATE、DROP、SET、DESC、REPLACE、CALL、BEGIN、DESCRIBE、ROLLBACK、FLUSH、USE、SHOW、START、COMMIT 和 RENAME。 说明
当数据库实例为 RDS MySQL、PolarDB MySQL 版、PolarDB-X 2.0 时,可以通过 SQL 语句类型进行统计。
| SELECT |
DbName | string | 否 | 数据库名。 | dbtest01 |
Role | string | 否 | PolarDB-X 2.0 数据库实例节点信息。
| polarx_cn |
返回参数
示例
正常返回示例
JSON
格式
{
"Message": "Successful",
"RequestId": "7172BECE-588A-5961-8126-C216E16B****",
"Data": {
"Result": {
"List": [
{
"SqlId": "d71f82be1eef72bd105128204d2e****",
"AvgFetchRows": 0,
"AvgLockWaitTime": 0.00009589874265269765,
"AvgLogicalRead": 654.4470327860251,
"AvgPhysicalAsyncRead": 0,
"AvgPhysicalSyncRead": 0,
"AvgExaminedRows": 10000,
"AvgReturnedRows": 10000,
"AvgUpdatedRows": 10000,
"AvgRt": 2.499,
"AvgSqlCount": 10000,
"Count": 100000,
"CountRate": 0.0586,
"Database": "dbtest01",
"ErrorCount": 1,
"FetchRows": 0,
"Ip": "rm-uf6dyi58dm6****.mysql.rds.aliy****.com",
"LockWaitTime": 1089.4177720290281,
"LogicalRead": 7434573266,
"PhysicalAsyncRead": 0,
"PhysicalSyncRead": 0,
"Port": 3306,
"Psql": "select * from dbtest01 where ****",
"Rows": 0,
"ExaminedRows": 10000,
"RtGreaterThanOneSecondCount": 20,
"RtRate": 2.499,
"SqlCount": 200,
"SumUpdatedRows": 100,
"Tables": [
"tabletest01,tabletest02"
],
"Version": 1,
"VpcId": "vpc-2zentqj1sk4qmolci****"
}
],
"Total": 1
},
"Fail": false,
"IsFinish": true,
"ResultId": "9CB97BC4-6479-55D0-B9D0-EA925AFE****",
"State": "SUCCESS",
"Timestamp": 1645668213000
},
"Code": 200,
"Success": true
}
错误码
HTTP status code | 错误码 | 错误信息 | 描述 |
---|---|---|---|
400 | InvalidParams | The request parameters are invalid. | 请求参数错误 |
403 | NoPermission | You are not authorized to do this action. | 没有权限执行该操作 |
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 |
---|