调用GetPfsSqlSample接口,获取性能洞察(新版)功能的SQL样本数据。
接口说明
使用该接口需满足以下前提条件:
- 使用阿里云或 DAS 的 SDK 时,建议使用最新版本。
- 在使用 SDK 调用 DAS 服务时,需要将地域指定为 cn-shanghai。
- 目标数据库实例为 RDS MySQL 或 PolarDB MySQL 版。
- 目标数据库实例已开启性能洞察(新版),详情请参见性能洞察(新版)。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
hdm:GetPfsSqlSample | get | *全部资源 * |
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
InstanceId | string | 是 | 实例 ID。 说明
仅支持 RDS MySQL 和 PolarDB MySQL 版数据库实例。
| rm-2ze1jdv45i7l6**** |
NodeId | string | 否 | 节点 ID。 说明
对于 RDS MySQL 集群系列或 PolarDB MySQL 版数据库实例,需要提供节点 ID。
| r-x****-db-0 |
SqlId | string | 否 | SQL ID。 | 651b56fe9418d48edb8fdf0980ec**** |
StartTime | long | 是 | 查询开始时间,格式为 unix 时间戳,单位为毫秒。 | 1676511134614 |
EndTime | long | 是 | 查询结束时间,格式为 unix 时间戳,单位为毫秒。 说明
查询结束时间需晚于查询开始时间,最多可查看最近一个月内任意七天的数据。
| 1678074351197 |
返回参数
示例
正常返回示例
JSON
格式
{
"Message": "Successful",
"RequestId": "9CB97BC4-6479-55D0-B9D0-EA925AFE****",
"Code": 200,
"Success": true,
"Data": [
{
"UserId": "196278346919****",
"InstanceId": "rm-2ze1jdv45i7l6****",
"NodeId": "r-x****-db-0",
"LogicId": "xxxxx",
"Timestamp": 1660100753556,
"SqlId": "651b56fe9418d48edb8fdf0980ec****",
"Sql": "select * from xxxx where ****",
"ThreadId": 81751940,
"EventId": 63735293,
"EndEventId": 0,
"EventName": "statement/sql/select",
"Latency": 0.199,
"LockLatency": 0.09,
"Errors": 0,
"Warnings": 0,
"RowsAffected": 0,
"RowsSent": 0,
"RowsExamined": 2048576,
"CreateTmpDiskTables": 0,
"CreateTmpTables": 0,
"SelectFullJoin": 0,
"SelectFullRangeJoin": 0,
"SelectRange": 0,
"SelectRangeCheck": 0,
"SelectScan": 0,
"SortMergePasses": 0,
"SortRange": 0,
"SortRows": 0,
"SortScan": 1,
"NoIndexUsed": 1,
"NoGoodIndexUsed": 1,
"Db": "testDB"
}
]
}
错误码
HTTP status code | 错误码 | 错误信息 | 描述 |
---|---|---|---|
400 | InvalidParams | The request parameters are invalid. | 请求参数错误 |
403 | NoPermission | You are not authorized to do this action. | 没有权限执行该操作 |
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 |
---|---|---|
2024-02-27 | OpenAPI 描述信息更新、OpenAPI 错误码发生变更 | 查看变更详情 |