华为云用户手册

请求参数 表2 请求Body参数 参数 是否必选 参数类型 描述 datastore_type 是 String 参数解释： 数据库类型。 约束限制： 数据库类型，目前支持MySQL、MariaDB、TaurusDB三种引擎。 取值范围： MySQL MariaDB TaurusDB 默认取值： 不涉及。 original_sql 是 String 参数解释： 原始SQL语句。 约束限制： 输入为合法的SQL语句。 取值范围： 最小长度：1 最大长度：1024 默认取值： 不涉及。 use_template 是 Boolean 参数解释： 是否校验SQL语句。 约束限制： 不涉及。 取值范围： true false 默认取值： 不涉及。 keep_operators 是 Boolean 参数解释： 是否保留操作符。 约束限制： 不涉及。 取值范围： true false 默认取值： 不涉及。

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 statements Array of FullSql objects 参数解释： 全量SQL集合。当集合为空时，说明SQL已全部导出。 取值范围： 不涉及。 next_marker String 参数解释： 获取下一页所需的标识符。marker仅在3分钟内有效。 取值范围： 不涉及。 表4 FullSql 参数 参数类型 描述 sql String 参数解释： SQL语句。 取值范围： 不涉及。 operate_type String 参数解释： 操作类型。 取值范围： 不涉及。 status String 参数解释： 状态。 取值范围： 不涉及。 error_no String 参数解释： 错误码。 取值范围： 不涉及。 database String 参数解释： 数据库名。 取值范围： 不涉及。 client String 参数解释： 客户端。 取值范围： 不涉及。 thread_id String 参数解释： 线程ID。 取值范围： 不涉及。 user String 参数解释： 用户。 取值范围： 不涉及。 execute_at Long 参数解释： 执行开始时间（Unix timestamp），单位：毫秒。 取值范围： [0, 2^31-1]，实际取决于查询。 query_time Double 参数解释： 执行耗时（毫秒）。 取值范围： 不涉及。 lock_time Double 参数解释： 锁等待耗时（毫秒）。 取值范围： 不涉及。 rows_examined Long 参数解释： 扫描行数。 取值范围： [0, 2^31-1]，实际取决于查询。 rows_sent Long 参数解释： 返回行数。 取值范围： [0, 2^31-1]，实际取决于查询。 rows_affected Long 参数解释： 更新行数。 取值范围： [0, 2^31-1]，实际取决于查询。

请求示例 导出全量SQL数据。 GET https://das.cn-north-1.myhuaweicloud.com/v3/054e292c9880d4992f02c0196d3ea468/instances/da304cd5bbb944de828759bc7be3d3fein01/sql-statements?start_at=1611975464337&end_at=1611979064337&limit=10&marker=DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAQH8YWSEFfM3FyOXZRNzJQOTVLNHNBOTQ2UQ==&datastore_type=MySQL

响应示例 状态码： 200 导出全量SQL返回体。 { "statements" : [ { "sql" : "SELECT 1", "operate_type" : "select", "status" : "success", "error_no" : "", "database" : "", "thread_id" : "11481954", "client" : "100.79.3.154", "user" : "root", "execute_at" : 1612403000100, "query_time" : 0, "lock_time" : 0, "rows_examined" : 0, "rows_sent" : 1, "rows_affected" : 0 } ], "next_marker" : "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAASG3cWcHVpdktBU1lTbjJMM2tmYXYxZ09nUQ==" }

URI GET /v3/{project_id}/instances/{instance_id}/sql-statements 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 参数解释： 租户在某一Region下的项目ID。 获取方法请参见获取项目ID。 约束限制： 不涉及。 取值范围： 只能由英文字母、数字组成，且长度为32个字符。 默认取值： 不涉及。 instance_id 是 String 参数解释： 实例ID。标识实例的唯一标识。 约束限制： 不涉及。 取值范围： 只能由英文字母、数字组成，且长度为32个字符。 默认取值： 不涉及。 表2 Query参数 参数 是否必选 参数类型 描述 start_at 是 Long 参数解释： 开始时间。 约束限制： Unix timestamp，单位：毫秒。 取值范围： [0, 2^31-1]，实际取决于查询。 默认取值： 不涉及。 end_at 是 Long 参数解释： 结束时间。 约束限制： Unix timestamp，单位：毫秒。 取值范围： [0, 2^31-1]，实际取决于查询。 默认取值： 不涉及。 limit 是 Integer 参数解释： 每页记录数。 约束限制： 不涉及。 取值范围： [0, 2000]，实际取决于查询。 默认取值： 不涉及。 marker 否 String 参数解释： 指定一个标识符。获取第一页时不用赋值，获取下一页时取上页查询结果的返回值。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 datastore_type 是 String 参数解释： 数据库类型。 约束限制： 不涉及 取值范围： MySQL TaurusDB 默认取值： 不涉及。

请求示例 导出TopSQL模板列表。 GET https://das.cn-north-1.myhuaweicloud.com/v3/054c630ff780d4cc2f40c00d7f6fb21d/instances/6243b3fcf2f948578d46ed4c52fb54eein01/top-sql-templates?start_at=1611975464337&end_at=1611979064337&node_id=fec05693c76c4f389561051db430324cno01&sort=avgCost&asc=true&datastore_type=MySQL&offset=0&limit=10

响应示例 状态码： 200 Success. { "top_sql_templates" : [ { "db_name" : "db_01", "execute_num" : 30, "avg_rows_examined" : 0, "total_cost_ratio" : "100.00%", "avg_lock_time" : 0, "sql_template" : "SELECT sleep(?)", "avg_rows_affected" : 0, "avg_rows_sent" : 1, "avg_cost" : 5000.266666666666, "execute_num_ratio" : "23.81%", "total_examined_ratio" : "-", "sql_type" : "select", "total_cost" : 150008, "total_rows_examined" : 0, "sql_sample_string" : "select sleep(5)" } ], "total_count" : 1 }

URI GET /v3/{project_id}/instances/{instance_id}/top-sql-templates 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 参数解释： 租户在某一Region下的项目ID。 获取方法请参见获取项目ID。 约束限制： 不涉及。 取值范围： 只能由英文字母、数字组成，且长度为32个字符。 默认取值： 不涉及。 instance_id 是 String 参数解释： 实例ID。标识实例的唯一标识。 约束限制： 不涉及。 取值范围： 只能由英文字母、数字组成，且长度为32个字符。 默认取值： 不涉及。 表2 Query参数 参数 是否必选 参数类型 描述 start_at 是 Long 参数解释： 开始时间。 约束限制： Unix timestamp，单位：毫秒。 取值范围： [0, 2^31-1]，实际取决于查询。 默认取值： 不涉及。 end_at 是 Long 参数解释： 结束时间。 约束限制： Unix timestamp，单位：毫秒。 取值范围： [0, 2^31-1]，实际取决于查询。 默认取值： 不涉及。 datastore_type 是 String 参数解释： 数据库类型。 约束限制： 不涉及 取值范围： MySQL TaurusDB 默认取值： 不涉及。 node_id 否 String 参数解释： 节点ID。 约束限制： 不涉及。 取值范围： 只能由英文字母、数字组成，且长度为32个字符。 默认取值： 不涉及。 sort 否 String 参数解释： 排序字段。 约束限制： 不涉及。 取值范围： executeNum：执行次数 totalCost：总耗时 avgCost：平均耗时 totalScan：总扫描行数 avgScan：平均扫描行数 默认取值： 不涉及。 asc 否 Boolean 参数解释： 排序顺序。 约束限制： 不涉及。 取值范围： true：正序 false：逆序 默认取值： false offset 否 Integer 参数解释： 索引位置，偏移量。从第一条数据偏移offset条数据后开始查询。例如：该参数指定为1，limit指定为10，则只展示第2~11条数据。 约束限制： 不涉及。 取值范围： [0, 2^31-1] 默认取值： 默认为0（偏移0条数据，表示从第一条数据开始查询）。 limit 否 Integer 参数解释： 查询记录数。例如该参数设定为10，则查询结果最多只显示10条记录。 约束限制： 不涉及。 取值范围： [1, 100] 默认取值： 默认为20。

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 top_sql_templates Array of TopSqlTemplate objects 参数解释： SQL模板列表。 取值范围： 不涉及。 total_count Integer 参数解释： SQL模板总数。 取值范围： [0, 2^31-1]，实际取决于查询。 表4 TopSqlTemplate 参数 参数类型 描述 sql_template String 参数解释： SQL模板ID。 取值范围： 不涉及。 sql_sample_string String 参数解释： SQL样本。 取值范围： 不涉及。 sql_type String 参数解释： SQL操作类型。 取值范围： 不涉及。 db_name String 参数解释： 数据库名称。 取值范围： 不涉及。 execute_num Long 参数解释： 总执行次数。 取值范围： 不涉及。 total_cost Double 参数解释： 总耗时(ms)。 取值范围： 不涉及。 avg_cost Double 参数解释： 平均耗时(ms)。 取值范围： 不涉及。 avg_rows_sent Double 参数解释： 平均返回行数。 取值范围： 不涉及。 avg_rows_affected Double 参数解释： 平均影响行数。 取值范围： 不涉及。 avg_lock_time Double 参数解释： 平均锁等待耗时(ms)。 取值范围： 不涉及。 total_rows_examined Double 参数解释： 总扫描行数。 取值范围： 不涉及。 avg_rows_examined Double 参数解释： 平均扫描行数。 取值范围： 不涉及。 total_cost_ratio String 参数解释： 总耗时占比。 取值范围： 不涉及。 total_examined_ratio String 参数解释： 扫描行数占比。 取值范围： 不涉及。 execute_num_ratio String 参数解释： 执行次数占比。 取值范围： 不涉及。

URI POST /v3/{project_id}/instances/{instance_id}/sql-limit/switch 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 参数解释： 租户在某一Region下的项目ID。 获取方法请参见获取项目ID。 约束限制： 不涉及。 取值范围： 只能由英文字母、数字组成，且长度为32个字符。 默认取值： 不涉及。 instance_id 是 String 参数解释： 实例ID。标识实例的唯一标识。 约束限制： 不涉及。 取值范围： 只能由英文字母、数字组成，且长度为32个字符。 默认取值： 不涉及。

请求示例 开启SQL限流。 POST https://das.cn-north-1.myhuaweicloud.com/v3/054c630ff780d4cc2f40c00d7f6fb21d/instances/6243b3fcf2f948578d46ed4c52fb54eein01/sql-limit/switch { "datastore_type" : "MySQL", "switch_status" : "ON" }

请求示例 开启全量SQL开关。 POST https://das.cn-north-1.myhuaweicloud.com/v3/054e292c9880d4992f02c0196d3ea468/instances/da304cd5bbb944de828759bc7be3d3fein01/sql/switch { "type" : "DAS SQL Explorer", "status" : 1, "datastore_type" : "MySQL", "retention_days" : 8 }

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

请求参数 表2 请求Body参数 参数 是否必选 参数类型 描述 type 是 String 参数解释： 开关类型。 约束限制： 不涉及。 取值范围： DAS SQL Explorer：DAS收集全量SQL开关。 DAS Slow Query Log：DAS收集慢SQL开关。 默认取值： 不涉及。 status 是 Integer 参数解释： 开关状态。 约束限制： 不涉及。 取值范围： 0：关闭。 1：开启。 默认取值： 不涉及。 datastore_type 是 String 参数解释： 数据库类型。 约束限制： 全量SQL支持的数据库类型包括MySQL和TaurusDB，慢SQL支持的类型：MySQL、TaurusDB、PostgreSQL。 取值范围： MySQL TaurusDB PostgreSQL 默认取值： 不涉及。 retention_days 否 Long 参数解释： SQL数据保存时长（天）。 约束限制： 不涉及。 取值范围： [1,30] 默认取值： 7（天）

URI POST /v3/{project_id}/instances/{instance_id}/sql/switch 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 参数解释： 租户在某一Region下的项目ID。 获取方法请参见获取项目ID。 约束限制： 不涉及。 取值范围： 只能由英文字母、数字组成，且长度为32个字符。 默认取值： 不涉及。 instance_id 是 String 参数解释： 实例ID。标识实例的唯一标识。 约束限制： 不涉及。 取值范围： 只能由英文字母、数字组成，且长度为32个字符。 默认取值： 不涉及。

请求参数 表2 请求Body参数 参数 是否必选 参数类型 描述 db_user_id 否 String 参数解释： 数据库用户ID。用户使用数据库账号与数据库建立的连接ID（数据库用户ID由注册数据库用户接口创建）。 约束限制： 不涉及。 取值范围： 只能由英文字母、数字、中划线组成，且长度为36个字符的UUID。 默认取值： 不涉及。 database 否 String 参数解释： 数据库名称。 约束限制： 仅支持MySQ L实例 的数据库。 取值范围： 不涉及。 默认取值： 不涉及。 sql 否 String 参数解释： SQL语句。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 execution_plans Array of ExecutionPlan objects 参数解释： SQL执行计划列表。 取值范围： 不涉及。 error_message String 参数解释： SQL执行失败时，显示执行错误信息。 取值范围： 不涉及。 表4 ExecutionPlan 参数 参数类型 描述 id String 参数解释： 执行计划id。 取值范围： [0, 2^31-1]，实际取决于查询。 select_type String 参数解释： select子句的类型。 取值范围： 不涉及。 table String 参数解释： 数据库表。 取值范围： 不涉及。 partitions String 参数解释： 查询将匹配记录的分区。 取值范围： 不涉及。 type String 参数解释： 访问类型。 取值范围： 不涉及。 possible_keys String 参数解释： 可能使用的键（索引）。 取值范围： 不涉及。 key String 参数解释： 实际使用的键（索引）。 取值范围： 不涉及。 key_len String 参数解释： 决定使用的键的长度。 取值范围： 不涉及。 ref String 参数解释： 使用哪个列或常数与键一起来选择行。 取值范围： 不涉及。 rows String 参数解释： MySQL认为它执行查询时必须检查的行数。 取值范围： 不涉及。 filtered String 参数解释： 按表条件过滤的表行的估计百分比。 取值范围： 不涉及。 extra String 参数解释： 其他信息。 取值范围： 不涉及。

请求示例 查询SQL执行计划（POST请求） POST https://das.cn-north-1.myhuaweicloud.com/v3/054e292c9880d4992f02c0196d3ea468/instances/da304cd5bbb944de828759bc7be3d3fein01/sql/explain { "db_user_id" : "2c250598-1e3c-4d31-bc19-be1d866247e6", "database" : "abc", "sql" : "select 1" }

响应示例 状态码： 200 { "execution_plans" : [ { "id" : "1", "select_type" : "SIMPLE", "table" : "", "partitions" : "", "type" : "", "possible_keys" : "", "key" : "", "key_len" : "", "ref" : "", "rows" : "", "filtered" : "", "extra" : "No tables used" } ] }

URI POST /v3/{project_id}/instances/{instance_id}/sql/explain 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 参数解释： 租户在某一Region下的项目ID。 获取方法请参见获取项目ID。 约束限制： 不涉及。 取值范围： 只能由英文字母、数字组成，且长度为32个字符。 默认取值： 不涉及。 instance_id 是 String 参数解释： 实例ID。标识实例的唯一标识。 约束限制： 仅支持MySQL实例。 取值范围： 只能由英文字母、数字组成，且长度为32个字符。 默认取值： 不涉及。

URI DELETE /v3/{project_id}/instances/{instance_id}/process 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 参数解释： 租户在某一Region下的项目ID。 获取方法请参见获取项目ID。 约束限制： 不涉及。 取值范围： 只能由英文字母、数字组成，且长度为32个字符。 默认取值： 不涉及。 instance_id 是 String 参数解释： 实例ID。标识实例的唯一标识。 约束限制： 不涉及。 取值范围： 只能由英文字母、数字组成，且长度为32个字符。 默认取值： 不涉及。

请求示例 查杀会话，按照用户、数据库、会话列表查杀会话。 DELETE https://das.cn-north-1.myhuaweicloud.com/v3/054e292c9880d4992f02c0196d3ea468/instances/da304cd5bbb944de828759bc7be3d3fein01/process { "db_user_id" : "2c250598-1e3c-4d31-bc19-be1d866247e6", "database" : "example", "user" : "aaa", "process_ids" : [ "11212", "3423222" ] }

请求参数 表2 请求Body参数 参数 是否必选 参数类型 描述 db_user_id 是 String 参数解释： 数据库用户ID。用户使用数据库账号与数据库建立的连接ID（数据库用户ID由注册数据库用户接口创建）。 约束限制： 不涉及。 取值范围： 只能由英文字母、数字、中划线组成，且长度为36个字符的UUID。 默认取值： 不涉及。 process_ids 否 Array of strings 参数解释： 会话ID列表。 约束限制： process_ids、user、database至少指定一个参数。 取值范围： [0, 2^31-1]，实际取决于查询。 默认取值： 不涉及。 user 否 String 参数解释： 数据库用户。 约束限制： process_ids、user、database至少指定一个参数。 取值范围： 不涉及。 默认取值： 不涉及。 database 否 String 参数解释： 数据库名称。 约束限制： process_ids、user、database至少指定一个参数。 取值范围： 不涉及。 默认取值： 不涉及。

URI GET /v3/{project_id}/instances/{instance_id}/sql-limit/job 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 参数解释： 租户在某一Region下的项目ID。 获取方法请参见获取项目ID。 约束限制： 不涉及。 取值范围： 只能由英文字母、数字组成，且长度为32个字符。 默认取值： 不涉及。 instance_id 是 String 参数解释： 实例ID。标识实例的唯一标识。 约束限制： 不涉及。 取值范围： 只能由英文字母、数字组成，且长度为32个字符。 默认取值： 不涉及。 表2 Query参数 参数 是否必选 参数类型 描述 job_id 是 String 参数解释： SQL限流任务ID。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。

URI GET /v3/{project_id}/instances/{instance_id}/slow-sql-trend 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 参数解释： 租户在某一Region下的项目ID。 获取方法请参见获取项目ID。 约束限制： 不涉及。 取值范围： 只能由英文字母、数字组成，且长度为32个字符。 默认取值： 不涉及。 instance_id 是 String 参数解释： 实例ID。标识实例的唯一标识。 约束限制： 不涉及。 取值范围： 只能由英文字母、数字组成，且长度为32个字符。 默认取值： 不涉及。 表2 Query参数 参数 是否必选 参数类型 描述 start_at 是 Long 参数解释： 开始时间。 约束限制： Unix timestamp，单位：毫秒。 取值范围： [0, 2^31-1]，实际取决于查询。 默认取值： 不涉及。 end_at 是 Long 参数解释： 结束时间。 约束限制： Unix timestamp，单位：毫秒。 取值范围： [0, 2^31-1]，实际取决于查询。 默认取值： 不涉及。 datastore_type 是 String 参数解释： 数据库类型。 约束限制： 不涉及 取值范围： MySQL TaurusDB 默认取值： 不涉及。 node_id 否 String 参数解释： 节点ID。 约束限制： 不涉及。 取值范围： 只能由英文字母、数字组成，且长度为32个字符。 默认取值： 不涉及 offset 否 Integer 参数解释： 索引位置，偏移量。从第一条数据偏移offset条数据后开始查询。例如：该参数指定为1，limit指定为10，则只展示第2~11条数据。 约束限制： 不涉及。 取值范围： [0, 2^31-1] 默认取值： 默认为0（偏移0条数据，表示从第一条数据开始查询）。 limit 否 Integer 参数解释： 查询记录数。例如该参数设定为10，则查询结果最多只显示10条记录。 约束限制： 不涉及。 取值范围： [1, 100] 默认取值： 默认为20。

响应示例 状态码： 200 Success. { "slow_sql_trend_items": [ { "timestamp": 1719900000000, "slow_log_count": 10 }, { "timestamp": 1719903600000, "slow_log_count": 11 } ], "interval_millis": 3600000, "total_count": 2 }

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 slow_sql_trend_items Array of 表4 objects 参数解释： 慢SQL数量趋势。 取值范围： 不涉及 interval_millis Long 参数解释： 返回列表两个时间点之间的时间间隔。 取值范围： 总查询时长一小时之内间隔10s，一小时到六小时范围内间隔60s，六小时以上间隔300s。单位为毫秒。 total_count Integer 参数解释： 耗时区间数据总数。 取值范围： 不涉及。 表4 slow_sql_trend_items 参数 参数类型 描述 timestamp Long 参数解释： 毫秒时间戳。 取值范围： 表示统计数据的时间范围为timestamp到timestamp + interval_millis。 slow_log_count Long 慢SQL数量。 参数解释： 慢SQL数量。 取值范围： 不涉及。

请求示例 导出慢SQL数量趋势。 GET https://das.cn-north-1.myhuaweicloud.com/v3/054c630ff780d4cc2f40c00d7f6fb21d/instances/6243b3fcf2f948578d46ed4c52fb54eein01/slow-sql-trend?startAt=1719862675886&endAt=1719905875886&datastore_type=MySQL&offset=0&limit=10

URI GET /v3/{project_id}/instances/{instance_id}/sql-limit/switch 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 参数解释： 租户在某一Region下的项目ID。 获取方法请参见获取项目ID。 约束限制： 不涉及。 取值范围： 只能由英文字母、数字组成，且长度为32个字符。 默认取值： 不涉及。 instance_id 是 String 参数解释： 实例ID。标识实例的唯一标识。 约束限制： 不涉及。 取值范围： 只能由英文字母、数字组成，且长度为32个字符。 默认取值： 不涉及。 表2 Query参数 参数 是否必选 参数类型 描述 datastore_type 是 String 参数解释： 数据库类型。 约束限制： 不涉及 取值范围： MySQL 默认取值： 不涉及。

请求示例 导出慢SQL模板列表。 GET https://das.cn-north-1.myhuaweicloud.com/v3/054c630ff780d4cc2f40c00d7f6fb21d/instances/6243b3fcf2f948578d46ed4c52fb54eein01/slow-sql-templates?startAt=1611975464337&endAt=1611979064337&datastore_type=MySQL&db_name=db&offset=0&limit=10