GetFullRequestStatResultByInstanceId_数据库自治服务_API文档

插件下载了解更多
VS Code 插件
安装插件之前,确保已安装 VS Code安装插件之前,确保已安装 VS Code
Alibaba Cloud Developer Toolkit is a collection of extensions that can help access Alibaba Cloud services in Visual Studio Code.
JetBrains 插件
安装插件之前,确保已安装 JetBrains IDE安装插件之前,确保已安装 JetBrains IDE
The Alibaba Cloud Developer Toolkit for JetBrains makes it easier to access Alibaba Cloud services.

接口说明

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

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

  • 目前支持的数据库实例请参见 DAS 企业版使用说明
  • 在使用 SDK 调用 DAS 服务时,需要将地域指定为 cn-shanghai。
  • 2024 年 09 月 01 日起,由于 SQL 的模板化算法优化,调用本接口时,SqlId 字段的值将发生变更。详情请参见【通知】SQL 模板化算法优化

流控信息

请求速率为60/1(s)。

授权信息

当前云产品暂无权限信息透出。

请求参数

字段名称字段详情
UserIdstring

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

示例值:196278346919****
InstanceIdstring

实例 ID。

示例值:rm-2ze8g2am97624****参考取值来源:
    AddHDMInstance
    GetInstanceInspections
    CreateKillInstanceSessionTask
NodeIdstring

节点 ID。展开详情

示例值:pi-bp12v7243x012****
SqlIdstring

SQL ID。展开详情

示例值:d71f82be1eef72bd105128204d2e****
OriginHoststring

执行 SQL 的客户端 IP 地址。展开详情

示例值:172.26.XX.XXX
Keywordstring

查询关键词。

示例值:dbtest01
Startinteger<int64>

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

注意 该字段类型为 Long,在序列化/反序列化的过程中可能导致精度丢失,请注意数值不得大于 9007199254740991。
示例值:1645581813000
Endinteger<int64>

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

注意 该字段类型为 Long,在序列化/反序列化的过程中可能导致精度丢失,请注意数值不得大于 9007199254740991。
示例值:1645668213000
OrderBystring

排序字段,默认为 count展开详情

示例值:count
Ascboolean

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

示例值:关闭
PageNointeger<int32>

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

示例值:1
PageSizeinteger<int32>

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

示例值:20
SqlTypestring

SQL 语句的类型,取值包括:SELECTINSERTUPDATEDELETELOGINLOGOUTMERGEALTERCREATEINDEXDROPINDEXCREATEDROPSETDESCREPLACECALLBEGINDESCRIBEROLLBACKFLUSHUSESHOWSTARTCOMMITRENAME展开详情

示例值:SELECT
DbNamestring

数据库名。

示例值:dbtest01
Rolestring

PolarDB-X 2.0 数据库实例节点信息。展开详情

示例值:polarx_cn

返回参数

字段名称字段详情
Messagestring

请求返回消息。展开详情

示例值:Successful
RequestIdstring

请求 ID。

示例值:7172BECE-588A-5961-8126-C216E16B****
Dataobject

返回数据。

Codeinteger<int64>

返回的状态码。

注意 请注意,该值为 Long 类型,在某些语言中可能存在精度丢失的风险,请小心使用。
示例值:200
Successboolean

请求是否执行成功:展开详情

示例值:true

返回示例

错误码

全局错误码
HTTP 状态码错误码错误信息操作
400
InvalidParams
The request parameters are invalid.诊断
403
NoPermission
You are not authorized to do this action.诊断

变更历史

变更时间变更内容概要操作
2022-02-22
新增OpenAPI,按照SQL ID异步统计全量请求数据

相关示例

SQL洞察与审计相关API调用示例
2022-03-25