更新时间:2024-11-13 GMT+08:00

API概览

数据管理服务所提供的接口为扩展接口。通过使用数据管理服务接口,您可以使用数据管理服务的部分功能,具体如下表所示。

表1 接口说明

类型

描述

查询API版本

  • 查询API版本列表
  • 查询指定的API版本信息

查询SQL执行计划

查询SQL执行计划。目前仅支持MySQL实例。

查杀会话

查杀会话。支持按照用户、数据库、会话列表查杀会话,三个条件至少指定一个。目前仅支持MySQL实例。

查询元数据锁列表

查询元数据锁列表。目前仅支持MySQL实例。

查询InnoDB锁等待列表

查询InnoDB锁等待列表。目前仅支持MySQL实例。

查询数据库用户列表

查询注册的数据库用户列表。目前仅支持MySQL实例。

注册数据库用户

此接口是将数据库用户和密码注册进DAS系统,同时会返回一个数据库用户ID ,后续调用其他接口时(如查询实例会话列表接口)需要用到此数据库用户ID。密码为加密存储,且仅用于DAS API相关功能。此接口不会在数据库上创建数据库用户对象。目前仅支持MySQL实例。

查询实例会话列表

支持根据数据库、用户查询实例会话列表。目前仅支持MySQL实例。

查询数据库用户信息

查询注册的数据库用户信息。目前仅支持MySQL实例。

修改数据库用户

修改注册的数据库用户名和密码。目前仅支持MySQL实例。

删除数据库用户

删除注册的数据库用户。此接口只是将注册的数据库用户在DAS系统里删除,不会真正删除数据库用户对象。目前仅支持MySQL实例。

获取空间分析数据列表

获取空间分析数据列表。实例级别数据来源于文件系统,库级别和表级别数据来源于information_schema.tables表。空间&元数据分析最多分析10000张表,若缺少库表空间数据,可能是因为数据库实例表个数过多或者账号未保存密码。如果未保存密码,请使用用户管理接口或页面录入数据库账号。支持MySQL和TaurusDB引擎。

创建空间分析任务

创建空间分析任务,如触发重新分析,支持MySQL和TaurusDB引擎。

开启/关闭全量SQL和慢SQL开关

打开或者关闭DAS收集全量SQL开关,开启后,实例的性能损耗在5%以内。开启全量SQL后,本服务会对SQL的文本内容进行存储,以便进行分析。用户可自行设置全量SQL的保存时间范围,到期后会自动删除;如果未设置,数据默认保留7天。

打开或者关闭DAS收集慢SQL开关。开启慢SQL后,本服务会对慢SQL的文本内容进行存储,以便进行分析。用户可自行设置慢SQL的保存时间范围,到期后会自动删除;如果未设置,数据默认保留7天。

查询全量SQL和慢SQL的开关状态

查询DAS收集全量SQL和慢SQL的开关状态。

导出慢SQL数据

DAS收集慢SQL开关打开后,一次性导出指定时间范围内的慢SQL数据,支持分页滚动获取。

导出全量SQL数据

全量SQL开关打开后,一次性导出指定时间范围内的全量SQL数据,支持分页滚动获取。

查看SQL限流开关状态

查询SQL限流的开关状态。目前仅支持MySQL实例。

设置SQL限流开关状态

设置SQL限流开关状态。目前仅支持MySQL数据库。

查询SQL限流规则列表

查询SQL限流规则。目前仅支持MySQL数据库。

创建SQL限流规则

添加SQL限流规则。目前仅支持MySQL数据库。

使用限制如下:

  • 规则举例详细说明:例如关键字是"select~a", 含义为:select以及a为该并发控制所包含的两个关键字,~为关键字间隔符,即若执行SQL命令包含select与a两个关键字视为命中此条并发控制规则。
  • 当SQL语句匹配多条限流规则时,优先生效最新添加的规则,之前的规则不再生效。
  • 限流规则关键字有顺序要求,只会按顺序匹配。如:a~and~b 只会匹配 xxx a>1 and b>2,而不会匹配 xxx b>2 and a>1。
  • 关键字可能大小写敏感,请执行 "show variables like 'rds_sqlfilter_case_sensitive'或者到实例参数设置页面进行确认。
  • 部分版本只读实例不允许设置限流规则,如果要设置限流规则,请到主实例上进行添加。
  • 系统表不限制、不涉及数据查询的不限制、root账号在特定版本下不限制。

删除SQL限流规则

删除SQL限流规则。目前仅支持MySQL数据库。

查询SQL限流任务

查询指定ID的SQL限流任务信息。

导出TopSQL模板列表

TopSQL开关打开后,导出TopSQL模板列表。该功能仅支持付费实例。查询时间间隔最长一小时。

导出SQL执行耗时区间数据

TopSQL开关打开后,导出SQL执行耗时区间数据。该功能仅支持付费实例。查询时间间隔最长六小时。

导出慢SQL模板列表

慢SQL开关打开后,导出慢SQL模板列表。该功能仅支持付费实例。查询时间间隔最长一天。