GetPfsSqlSample_数据库自治服务_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.

接口说明

使用该接口需满足以下前提条件:

  • 使用阿里云或 DAS 的 SDK 时,建议使用最新版本。
  • 在使用 SDK 调用 DAS 服务时,需要将地域指定为 cn-shanghai。
  • 目标数据库实例为 RDS MySQL 或 PolarDB MySQL 版。
  • 目标数据库实例已开启性能洞察(新版),详情请参见性能洞察(新版)

流控信息

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

授权信息

如下是此API对应的授权信息,用于RAM权限策略语句的Action元素中,为RAM用户或RAM角色授予调用此API的权限。请通过 RAM 访问控制设置,使用方法可参考访问控制帮助文档

具体说明如下:展开详情

操作访问级别资源类型条件关键字关联操作
hdm:GetPfsSqlSample
Get
全部资源
*

请求参数

字段名称字段详情
InstanceIdstring

实例 ID。展开详情

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

节点 ID。展开详情

示例值:r-x****-db-0
SqlIdstring

SQL ID。

示例值:651b56fe9418d48edb8fdf0980ec****
StartTimeinteger<int64>

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

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

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

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

返回参数

字段名称字段详情
Messagestring

请求返回消息。展开详情

示例值:Successful
RequestIdstring

请求 ID。

示例值:9CB97BC4-6479-55D0-B9D0-EA925AFE****
Codeinteger<int64>

返回状态码。

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

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

示例值:true
Dataarray<object>

返回的 SQL 样本数据。

返回示例

错误码

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

变更历史

变更时间变更内容概要操作
2024-02-27
变更请求参数InstanceId
变更请求参数StartTime
变更请求参数EndTime

相关示例