文档

GetFullRequestStatResultByInstanceId - 按照SQL ID异步统计全量请求数据

更新时间:

调用GetFullRequestStatResultByInstanceId接口,按照SQL ID异步统计数据库实例SQL洞察结果中的全量请求数据。

接口说明

说明 异步调用后不会立即返回完整结果,当返回数据中 isFinish 取值为 false 时,请等待 1s 后重新发起调用,直到 isFinish 取值为 true 时,返回完整结果。

SQL 洞察功能可对 SQL 进行健康情况诊断、性能问题排查,详情请参见 SQL 洞察

  • 目前支持的数据库实例请参见 DAS 企业版使用说明
  • 在使用 SDK 调用 DAS 服务时,需要将地域指定为 cn-shanghai。

调试

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

授权信息

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

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

请求参数

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

用户 ID,即创建数据库实例的阿里云主账号 ID。

说明 非必填,输入目标数据库实例 ID 后,在调用 API 接口时,系统会自动获取用户 ID。
196278346919****
InstanceIdstring

实例 ID。

rm-2ze8g2am97624****
NodeIdstring

节点 ID。

说明 对于 PolarDB MySQL 版实例,需要提供节点 ID。
pi-bp12v7243x012****
SqlIdstring

SQL ID。

说明 填写 SQL ID 时,统计目标 SQL ID 的全量请求数据;为空时,统计整个数据库实例的全量请求数据。
d71f82be1eef72bd105128204d2e****
OriginHoststring

执行 SQL 的客户端 IP 地址。

说明 非必填,输入目标客户端 IP 地址后,统计目标客户端 IP 地址的全量请求数据;为空时,统计整个数据库实例的全量请求数据。
172.26.XX.XXX
Keywordstring

查询关键词。

dbtest01
Startlong

查询开始时间,格式为 Unix 时间戳,单位为毫秒。

说明 查询开始时间需要在数据库实例 SQL 洞察存储时长范围内,最大不能早于当前时间 90 天。
1645581813000
Endlong

查询结束时间,格式为 Unix 时间戳,单位为毫秒。

说明 查询结束时间需晚于查询开始时间,且查询开始时间和查询结束时间的间隔不能超过 1 天。
1645668213000
OrderBystring

排序字段,默认为 count

  • count:执行次数。

  • avgRt:平均执行时间。

  • rtRate:耗时比例。

  • rowsExamined:总扫描行数。

  • avgRowsExamined:平均扫描行数。

  • avgRowsReturned:平均返回行数。

count
Ascboolean

升序排序开关,默认关闭。

关闭
PageNointeger

分页查询的页码,从 1 开始,默认为 1。

1
PageSizeinteger

分页查询每页数据量,默认为 20。

20
SqlTypestring

SQL 语句的类型,取值包括:SELECTINSERTUPDATEDELETELOGINLOGOUTMERGEALTERCREATEINDEXDROPINDEXCREATEDROPSETDESCREPLACECALLBEGINDESCRIBEROLLBACKFLUSHUSESHOWSTARTCOMMITRENAME

说明 当数据库实例为 RDS MySQL、PolarDB MySQL 版、PolarDB-X 2.0 时,可以通过 SQL 语句类型进行统计。
SELECT
DbNamestring

数据库名。

dbtest01
Rolestring

PolarDB-X 2.0 数据库实例节点信息。

  • polarx_cn:计算节点。

  • polarx_dn:数据节点。

polarx_cn

返回参数

名称类型描述示例值
object

返回信息的详细列表。

Messagestring

请求返回消息。

说明 请求成功时该参数返回 Successful,请求失败时会返回请求异常信息(如错误码等)。
Successful
RequestIdstring

请求 ID。

7172BECE-588A-5961-8126-C216E16B****
Dataobject

返回数据。

Resultobject

返回的全量请求数据。

Listobject []

全量请求数据列表。

SqlIdstring

SQL ID。

d71f82be1eef72bd105128204d2e****
AvgFetchRowslong

PolarDB-X 2.0 数据库实例计算节点平均拉取数据节点的行数。

0
AvgLockWaitTimedouble

平均锁等待时长,单位为秒。

0.00009589874265269765
AvgLogicalReaddouble

平均逻辑读。

654.4470327860251
AvgPhysicalAsyncReadlong

平均物理异步读取。

0
AvgPhysicalSyncReadlong

平均物理同步读取。

0
AvgExaminedRowsdouble

平均扫描行数。

说明 目前支持该字段的数据库:RDS MySQL、RDS PostgreSQL、PolarDB MySQL 版。
10000
AvgReturnedRowsdouble

平均返回行数。

10000
AvgUpdatedRowslong

平均修改行数。

说明 目前支持该字段的数据库:RDS MySQL、PolarDB-X 2.0。
10000
AvgRtdouble

平均执行耗时。

2.499
AvgSqlCountlong

平均 SQL 计数。

10000
Countlong

总执行次数。

100000
CountRatedouble

执行次数比例。

0.0586
Databasestring

数据库名。

dbtest01
ErrorCountlong

执行错误次数。

1
FetchRowslong

PolarDB-X 2.0 数据库实例计算节点拉取数据节点的行数。

0
Ipstring

实例的网络地址。

rm-uf6dyi58dm6****.mysql.rds.aliy****.com
LockWaitTimedouble

锁等待时长,单位为秒。

1089.4177720290281
LogicalReadlong

逻辑读。

7.434573266E9
PhysicalAsyncReadlong

物理异步读取。

0
PhysicalSyncReadlong

物理同步读取。

0
Portlong

端口号。

3306
Psqlstring

SQL 模板。

select * from dbtest01 where ****
Rowslong

PolarDB-X 2.0 数据库实例计算节点总更新或返回的行数。

0
ExaminedRowslong

总扫描行数。

说明 目前支持该字段的数据库:RDS MySQL、RDS PostgreSQL、PolarDB MySQL 版。
10000
RtGreaterThanOneSecondCountlong

执行时长大于 1 秒的 SQL 数量。

20
RtRatedouble

耗时比例。

2.499
SqlCountlong

SQL 的数量。

200
SumUpdatedRowslong

总变更行数。

100
Tablesarray

数据库表名。

string

数据库表名。

tabletest01,tabletest02
Versionlong

版本。

1
VpcIdstring

VPC ID。

vpc-2zentqj1sk4qmolci****
Totallong

总数据量。

1
Failboolean

请求是否失败。

  • true:是。

  • false:否。

false
IsFinishboolean

异步请求是否执行完成。

  • true:是。

  • false:否。

true
ResultIdstring

请求的 ID。

9CB97BC4-6479-55D0-B9D0-EA925AFE****
Statestring

异步请求的执行状态。

  • RUNNING:正在运行。

  • SUCCESS:成功。

  • FAIL:失败。

SUCCESS
Timestamplong

执行时间,格式为 Unix 时间戳,单位为毫秒。

1645668213000
Codelong

返回的状态码。

200
Successboolean

请求是否执行成功:

  • true:执行成功。
  • false:执行失败。
true

示例

正常返回示例

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错误码错误信息描述
400InvalidParamsThe request parameters are invalid.请求参数错误
403NoPermissionYou are not authorized to do this action.没有权限执行该操作

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

变更历史

变更时间变更内容概要操作
暂无变更历史
  • 本页导读 (1)