华为云用户手册

请求示例 查询InnoDB锁等待列表。 GET https://das.cn-north-1.myhuaweicloud.com/v3/054e292c9880d4992f02c0196d3ea468/instances/da304cd5bbb944de828759bc7be3d3fein01/innodb-locks?db_user_id=2c250598-1e3c-4d31-bc19-be1d866247e6

响应示例 状态码： 200 { "innodb_trx" : [ { "trx_id" : "1080883393", "trx_state" : "LOCK WAIT", "trx_started" : "2021-01-14 18:49:26", "trx_wait_started" : "2021-01-14 18:49:26", "trx_mysql_thread_id" : "115602", "trx_query" : "DELETE FROM adfasdf WHERE id =1", "trx_tables_locked" : "1", "trx_rows_locked" : "1", "trx_rows_modified" : "0", "trx_isolation_level" : "REPEATABLE READ", "innodb_wait_locks" : [ { "lock_id" : "1080883393:27750:3:2", "lock_trx_id" : "1080883393", "lock_mode" : "X", "lock_type" : "RECORD", "lock_table" : "`abc`.`adfasdf`", "lock_index" : "GEN_CLUST_INDEX", "lock_space" : "27750", "lock_page" : "3", "lock_rec" : "2", "lock_data" : "0x0000005528EC" } ], "innodb_hold_locks" : [ ] }, { "trx_id" : "1080882971", "trx_state" : "LOCK WAIT", "trx_started" : "2021-01-14 18:49:25", "trx_wait_started" : "2021-01-14 18:49:25", "trx_mysql_thread_id" : "115598", "trx_query" : "DELETE FROM adfasdf WHERE id =1", "trx_tables_locked" : "1", "trx_rows_locked" : "1", "trx_rows_modified" : "0", "trx_isolation_level" : "REPEATABLE READ", "innodb_wait_locks" : [ ], "innodb_hold_locks" : [ { "lock_id" : "1080882971:27750:3:2", "lock_trx_id" : "1080882971", "lock_mode" : "X", "lock_type" : "RECORD", "lock_table" : "`abc`.`adfasdf`", "lock_index" : "GEN_CLUST_INDEX", "lock_space" : "27750", "lock_page" : "3", "lock_rec" : "2", "lock_data" : "0x0000005528EC" } ] } ], "innodb_lock_waits" : [ { "requesting_trx_id" : "1080883393", "requested_lock_id" : "1080883393:27750:3:2", "blocking_trx_id" : "1080882971", "blocking_lock_id" : "1080882971:27750:3:2" } ], "count" : 2 }

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 innodb_trx Array of InnodbTrx objects 参数解释： 当前持有或等待锁的事务信息。 取值范围： 不涉及。 innodb_lock_waits Array of InnodbLockWaits objects 参数解释： 每个事务请求的锁以及阻塞该请求的锁的对应关系。 取值范围： 不涉及。 count Integer 参数解释： 当前持有或等待锁的事务数量。 取值范围： [0, 2^31-1]，实际取决于查询。 表4 InnodbTrx 参数 参数类型 描述 trx_id String 参数解释： 事务ID。 取值范围： 不涉及。 trx_state String 参数解释： 事务状态。 取值范围： 不涉及。 trx_started String 参数解释： 事务开始时间。 取值范围： 不涉及。 trx_wait_started String 参数解释： 事务ID。 取值范围： 不涉及。 trx_mysql_thread_id String 参数解释： 会话ID，同ListProcesses接口返回的id。 取值范围： 不涉及。 trx_query String 参数解释： 事务运行的SQL语句。 取值范围： 不涉及。 trx_tables_locked String 参数解释： 加行锁的表数量。 取值范围： 不涉及。 trx_rows_locked String 参数解释： 锁定的行数量（近似值）。 取值范围： 不涉及。 trx_rows_modified String 参数解释： 事务插入或者修改的行数。 取值范围： 不涉及。 trx_isolation_level String 参数解释： 隔离级别。 取值范围： 不涉及。 innodb_wait_locks Array of InnodbLock objects 参数解释： 等待锁信息。 取值范围： 不涉及。 innodb_hold_locks Array of InnodbLock objects 参数解释： 持有锁信息。 取值范围： 不涉及。 表5 InnodbLock 参数 参数类型 描述 lock_id String 参数解释： 锁ID。 取值范围： 不涉及。 lock_trx_id String 参数解释： 事务ID。 取值范围： 不涉及。 lock_mode String 参数解释： 锁模式。 取值范围： S[,GAP] X[,GAP] IS[,GAP] IX[,GAP] AUTO_INC UNKNOWN lock_type String 参数解释： 锁类型。 取值范围： RECORD：行锁。 TABLE：表锁。 lock_table String 参数解释： 加锁的表。 取值范围： 不涉及。 lock_index String 参数解释： 如果是lock_type='RECORD' 行级锁 ,为锁住的索引，如果是表锁为null。 取值范围： 不涉及。 lock_space String 参数解释： 如果是lock_type='RECORD' 行级锁 ,为锁住的索引，如果是表锁为null。 取值范围： 不涉及。 lock_page String 参数解释： 如果是lock_type='RECORD' 行级锁 ,为锁住的页号，如果是表锁为null。 取值范围： 不涉及。 lock_rec String 参数解释： 如果是lock_type='RECORD' 行级锁，为锁住的堆号，如果是表锁为null。 取值范围： 不涉及。 lock_data String 参数解释： 事务锁住的主键值，若是表锁，则该值为null。 取值范围： 不涉及。 表6 InnodbLockWaits 参数 参数类型 描述 requesting_trx_id String 参数解释： 申请锁资源的事务ID。 取值范围： 不涉及。 requested_lock_id String 参数解释： 申请的锁的ID。 取值范围： 不涉及。 blocking_trx_id String 参数解释： 阻塞的事务ID。 取值范围： 不涉及。 blocking_lock_id String 参数解释： 阻塞的锁的ID。 取值范围： 不涉及。

URI GET /v3/{project_id}/instances/{instance_id}/innodb-locks 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 参数解释： 租户在某一Region下的项目ID。 获取方法请参见获取项目ID。 约束限制： 不涉及。 取值范围： 只能由英文字母、数字组成，且长度为32个字符。 默认取值： 不涉及。 instance_id 是 String 参数解释： 实例ID。标识实例的唯一标识。 约束限制： 不涉及。 取值范围： 只能由英文字母、数字组成，且长度为32个字符。 默认取值： 不涉及。 表2 Query参数 参数 是否必选 参数类型 描述 db_user_id 是 String 参数解释： 数据库用户ID。用户使用数据库账号与数据库建立的连接ID（数据库用户ID由注册数据库用户接口创建）。 约束限制： 不涉及。 取值范围： 只能由英文字母、数字、中划线组成，且长度为36个字符的UUID。 默认取值： 不涉及。

响应参数 状态码： 200 表2 响应Body参数 参数 参数类型 描述 version ApiVersion object 参数解释： API版本详细信息列表。 取值范围： 不涉及。 表3 ApiVersion 参数 参数类型 描述 id String 参数解释： API版本号，如v3。 取值范围： 不涉及。 status String 参数解释： 版本状态。 取值范围： CURRENT：主推版本。 SUPPORTED：老版本，但是现在还继续支持。 DEPRECATED：废弃版本，存在后续删除的可能。 updated String 参数解释： 版本发布时间。 格式为“yyyy-mm-ddThh:mm:ssZ”。 其中，T指某个时间的开始；Z指UTC时间。 取值范围： 不涉及。 version String 参数解释： API的微版本，如果不支持微版本，则为空。 取值范围： 不涉及。

请求示例 获取实例健康诊断报告内容。 GET https://das.cn-north-7.myhuaweicloud.com/v3/052041494800d57c2f02c00275b4c247/instances/bcfa975193f1402fa11a6d4fd6baf5fbin01/get-instance-health-report?task_id=bb252ed0-3d06-489a-a662-6609e054e91c

响应示例 状态码： 200 Success. { "success" : true, "summary_info" : { "analysis_results" : [ { "risk_code" : "SLOW_ LOG _ISSUE", "risk_level" : "WARNING", "risk_content" : "慢SQL问题", "reasons" : [ { "reason_code" : "SLOW_LOG_EXIST", "reason_content" : "存在慢SQL", "suggestions" : [ { "suggestion_code" : "ANALYZE_SLOW_LOG", "suggestion_content" : "分析慢SQL查找问题根源" } ] } ] } ] }, "instance_info" : { "tenant_id" : "05204146e600d48f0f02c002850ec340", "project_id" : "052041494800d57c2f02c00275b4c247", "instance_id" : "bcfa975193f1402fa11a6d4fd6baf5fbin01", "instance_name" : "rds-sql-勿删1", "cpu" : 2, "mem" : 8, "disk_size" : 60, "disk_type" : "CLOUDSSD", "engine" : "mysql", "engine_version" : "5.7" }, "performance_stat" : { "analyze_success" : true, "peak_stats" : [ { "metric" : "qps", "value" : 64.88, "max_value" : 11178, "normalized" : 0.005804258364644837, "stage" : "LIGHT", "timestamp" : 1728756000 } ], "ratio_stats" : [ { "metric" : "qps", "max_value" : 11178, "critical_ratio" : 0, "medium_ratio" : 0, "light_ratio" : 1 } ] }, "disk_stat" : { "analyze_success" : true, "peak_stats" : [ { "metric" : "iops", "value" : 91.9, "max_value" : 4500, "normalized" : 0.020422222222222224, "stage" : "LIGHT", "timestamp" : 1728750600 } ], "ratio_stats" : [ { "metric" : "iops", "max_value" : 4500, "critical_ratio" : 0, "medium_ratio" : 0, "light_ratio" : 1 } ] }, "table_space_stat" : { "analyze_success" : true }, "slow_log_stat" : { "analyze_success" : true, "collect_slow_log" : true, "top_execute_slow_logs" : [ { "template_id" : "5B20B6BF446F926F", "template" : "INSERT INTO test123 VALUES (?);", "databases" : [ "test_db" ], "times" : 83, "avg_query_time" : 0.9021538595657752, "max_query_time" : 45.08398997783661, "avg_rows_examined" : 0, "sum_rows_examined" : 0, "avg_rows_sent" : 0 } ], "rows_examined_exceeding" : [ ] }, "full_sql_stat" : { "analyze_success" : true, "collect_full_sql" : true, "execute_top_templates" : [ { "template_id" : "B38F825636B24B7", "template" : "CREATE TABLE IF NOT EXISTS table_001 (id int)", "databases" : [ "test_db" ], "times" : 1, "avg_query_time" : 5, "avg_rows_examined" : 0, "sum_rows_examined" : 0 } ] }, "inspection_stat" : { "analyze_success" : true, "inspection_score" : [ { "score" : 100, "critical" : 0, "medium" : 0, "light" : 0, "cpu_usage" : 3.93, "mem_usage" : 22.91, "space_usage" : 8.66, "connection_rate" : 0.54, "iops_usage" : 0.28, "thread_running" : 4, "slow_sql_total" : 0, "lost_points_detail_list" : [ { "metric" : "memUsage", "lost_points" : 0, "risk_level" : "NORMAL" }, { "metric" : "cpuUsage", "lost_points" : 0, "risk_level" : "NORMAL" }, { "metric" : "spaceUsage", "lost_points" : 0, "risk_level" : "NORMAL" }, { "metric" : "iopsUsage", "lost_points" : 0, "risk_level" : "NORMAL" }, { "metric" : "connectionRate", "lost_points" : 0, "risk_level" : "NORMAL" }, { "metric" : "threadRunning", "lost_points" : 0, "risk_level" : "NORMAL" }, { "metric" : "slowSqlTotal", "lost_points" : 0, "risk_level" : "NORMAL" } ] } ] } }

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 success Boolean 参数解释： 日报诊断是否成功。 取值范围： 不涉及。 start_at Long 参数解释： 日报诊断区间的起始时间（Unix timestamp），单位：毫秒。 取值范围： 不涉及。 end_at Long 参数解释： 日报诊断区间的结束时间（Unix timestamp），单位：毫秒。 取值范围： 不涉及。 task_id String 参数解释： 报告ID。 取值范围： 不涉及。 summary_info 表4 object 参数解释： 日报内容摘要信息 取值范围： 不涉及。 instance_info 表8 object 参数解释： 实例信息列表。 取值范围： 不涉及。 performance_stat 表9 object 参数解释： 性能统计分析列表。 取值范围： 不涉及。 disk_stat 表10 object 参数解释： 磁盘统计分析列表。 取值范围： 不涉及。 table_space_stat 表13 object 参数解释： 表空间统计分析列表。 取值范围： 不涉及。 slow_log_stat 表16 object 参数解释： 慢SQL统计分析列表。 取值范围： 不涉及。 full_sql_stat 表17 object 参数解释： 全量SQL统计分析列表。 取值范围： 不涉及。 inspection_stat 表19 object 参数解释： 巡检评分统计分析列表。 取值范围： 不涉及。 error_message String 参数解释： 错误信息。 取值范围： 不涉及。 表4 HealthReportSummaryInfo 参数 参数类型 描述 analysis_results Array of 表5 objects 参数解释： 分析结果列表。 取值范围： 不涉及。 表5 HealthReportAnalysisResult 参数 参数类型 描述 risk_code String 参数解释： 风险点编码。 取值范围： 不涉及。 risk_level String 参数解释： 风险点级别。 取值范围： 不涉及。 risk_content String 参数解释： 风险点内容。 取值范围： 不涉及。 reasons Array of 表6 objects 参数解释： 可能原因列表。 取值范围： 不涉及。 表6 HealthReportRiskReason 参数 参数类型 描述 reason_code String 参数解释： 可能原因编码。 取值范围： 不涉及。 reason_content String 参数解释： 可能原因内容。 取值范围： 不涉及。 suggestions Array of 表7 objects 参数解释： 建议优化措施列表。 取值范围： 不涉及。 表7 HealthReportRiskSuggestion 参数 参数类型 描述 suggestion_code String 参数解释： 建议优化措施编码。 取值范围： 不涉及。 suggestion_content String 参数解释： 建议优化措施。 取值范围： 不涉及。 表8 HealthReportInstanceInfo 参数 参数类型 描述 tenant_id String 参数解释： 账号ID。 取值范围： 不涉及。 project_id String 参数解释： 项目ID。 取值范围： 不涉及。 instance_id String 参数解释： 实例ID。 取值范围： 不涉及。 master_node_id String 参数解释： 主节点ID。 取值范围： 不涉及。 instance_name String 参数解释： 实例名称。 取值范围： 不涉及。 cpu Integer 参数解释： 实例cpu核数。 取值范围： 不涉及。 mem Integer 参数解释： 实例内存大小。 取值范围： 不涉及。 disk_size Integer 参数解释： 磁盘大小。 取值范围： 不涉及。 disk_type String 参数解释： 磁盘类型。 取值范围： 不涉及。 engine String 参数解释： 实例引擎类型。 取值范围： 不涉及。 engine_version String 参数解释： 引擎内核版本。 取值范围： 不涉及。 表9 HealthReportPerformanceStat 参数 参数类型 描述 peak_stats Array of 表11 objects 参数解释： 峰值统计信息列表。 取值范围： 不涉及。 ratio_stats Array of 表12 objects 参数解释： 比率值数据列表。 取值范围： 不涉及。 analyze_success Boolean 参数解释： 统计分析是否成功。 取值范围： 不涉及。 error_message String 参数解释： 错误信息。 取值范围： 不涉及。 表10 HealthReportDiskStat 参数 参数类型 描述 peak_stats Array of 表11 objects 参数解释： 峰值统计信息列表。 取值范围： 不涉及。 ratio_stats Array of 表12 objects 参数解释： 比率值数据列表。 取值范围： 不涉及。 analyze_success Boolean 参数解释： 统计分析是否成功。 取值范围： 不涉及。 error_message String 参数解释： 错误信息。 取值范围： 不涉及。 表11 HealthReportSingleValueStat 参数 参数类型 描述 metric String 参数解释： 指标名。 取值范围： 不涉及。 value Double 参数解释： 数值。 取值范围： 不涉及。 max_value Double 参数解释： 最大值。 取值范围： 不涉及。 normalized Double 参数解释： 归一化值。 取值范围： 不涉及。 stage String 参数解释： 当前状态。 取值范围： 不涉及。 timestamp Long 参数解释： 指标采集时间。 取值范围： 不涉及。 表12 HealthReportRatioStat 参数 参数类型 描述 metric String 参数解释： 指标名。 取值范围： 不涉及。 max_value Double 参数解释： 最大值。 取值范围： 不涉及。 critical_ratio Double 参数解释： 高水位占比。 取值范围： 不涉及。 medium_ratio Double 参数解释： 中水位占比。 取值范围： 不涉及。 light_ratio Double 参数解释： 低水位占比。 取值范围： 不涉及。 表13 HealthReportTableSpaceStat 参数 参数类型 描述 size_top Array of 表14 objects 参数解释： 表大小Top列表。 取值范围： 不涉及。 rows_top Array of 表14 objects 参数解释： 表行数量Top列表。 取值范围： 不涉及。 size_incr_top Array of 表15 objects 参数解释： 表大小增长Top列表。 取值范围： 不涉及。 rows_incr_top Array of 表15 objects 参数解释： 表行数量增长Top列表。 取值范围： 不涉及。 analyze_success Boolean 参数解释： 统计分析是否成功。 取值范围： 不涉及。 error_message String 参数解释： 错误信息。 取值范围： 不涉及。 表14 HealthReportTableSpaceInfo 参数 参数类型 描述 database String 参数解释： 数据库名。 取值范围： 不涉及。 table String 参数解释： 表名。 取值范围： 不涉及。 db_engine String 参数解释： 数据库引擎。 取值范围： 不涉及。 table_size Long 参数解释： 表大小。 取值范围： 不涉及。 data_size Long 参数解释： 数据大小。 取值范围： 不涉及。 index_size Long 参数解释： 索引大小。 取值范围： 不涉及。 rows Long 参数解释： 行数量。 取值范围： 不涉及。 表15 HealthReportTableSpaceIncrInfo 参数 参数类型 描述 database String 参数解释： 数据库名。 取值范围： 不涉及。 table String 参数解释： 表名。 取值范围： 不涉及。 increment Long 参数解释： 增长量。 取值范围： 不涉及。 analyze_success Boolean 参数解释： 统计分析是否成功。 取值范围： 不涉及。 error_message String 参数解释： 错误信息。 取值范围： 不涉及。 表16 HealthReportSlowLogStat 参数 参数类型 描述 collect_slow_log Boolean 参数解释： 是否收集慢SQL。 取值范围： 不涉及。 top_execute_slow_logs Array of 表18 objects 参数解释： 慢SQL Top执行次数列表。 取值范围： 不涉及。 top_avg_query_time_slow_logs Array of 表18 objects 参数解释： 慢SQL Top平均执行时间列表。 取值范围： 不涉及。 top_max_query_time_slow_logs Array of 表18 objects 参数解释： 慢SQL Top最大执行时间列表。 取值范围： 不涉及。 rows_examined_exceeding Array of 表18 objects 参数解释： 慢SQL Top扫描返回比列表。 取值范围： 不涉及。 analyze_success Boolean 参数解释： 统计分析是否成功。 取值范围： 不涉及。 error_message String 参数解释： 错误信息。 取值范围： 不涉及。 表17 HealthReportFullSqlStat 参数 参数类型 描述 collect_full_sql Boolean 参数解释： 是否收集全量SQL。 取值范围： 不涉及。 execute_top_templates Array of 表18 objects 参数解释： 全量SQL Top总执行次数列表。 取值范围： 不涉及。 sum_rows_examined_top_templates Array of 表18 objects 参数解释： 全量SQL Top总扫描行数列表。 取值范围： 不涉及。 avg_cost_top_templates Array of 表18 objects 参数解释： 全量SQL Top平均执行耗时列表。 取值范围： 不涉及。 analyze_success Boolean 参数解释： 统计分析是否成功。 取值范围： 不涉及。 error_message String 参数解释： 错误信息。 取值范围： 不涉及。 表18 HealthReportSqlTemplate 参数 参数类型 描述 template_id String 参数解释： 模板ID。 取值范围： 不涉及。 template String 参数解释： 模板内容。 取值范围： 不涉及。 databases Array of strings 参数解释： 数据库列表。 取值范围： 不涉及。 times Long 参数解释： 执行次数。 取值范围： 不涉及。 avg_query_time Double 参数解释： 平均执行时间。 取值范围： 不涉及。 max_query_time Double 参数解释： 最大执行时间。 取值范围： 不涉及。 avg_rows_examined Double 参数解释： 平均扫描行数。 取值范围： 不涉及。 max_rows_examined Double 参数解释： 最大扫描行数。 取值范围： 不涉及。 sum_rows_examined Double 参数解释： 总扫描行数。 取值范围： 不涉及。 avg_rows_sent Double 参数解释： 平均返回行数。 取值范围： 不涉及。 max_rows_sent Double 参数解释： 最大返回行数。 取值范围： 不涉及。 表19 HealthReportInspectionStat 参数 参数类型 描述 inspection_score Array of 表20 objects 参数解释： 巡检评分。 取值范围： 不涉及。 analyze_success Boolean 参数解释： 统计分析是否成功。 取值范围： 不涉及。 error_message String 参数解释： 错误信息。 取值范围： 不涉及。 表20 HealthReportInspectionScore 参数 参数类型 描述 score Double 参数解释： 得分。 取值范围： 不涉及。 critical Integer 参数解释： 严重事件。 取值范围： 不涉及。 medium Integer 参数解释： 警告事件。 取值范围： 不涉及。 light Integer 参数解释： 优化事件。 取值范围： 不涉及。 cpu_usage Double 参数解释： CPU使用率。 取值范围： 不涉及。 mem_usage Double 参数解释： 内存使用率。 取值范围： 不涉及。 space_usage Double 参数解释： 空间使用率。 取值范围： 不涉及。 connection_rate Double 参数解释： 连接使用率。 取值范围： 不涉及。 iops_usage Double 参数解释： IOPS使用率。 取值范围： 不涉及。 thread_running Double 参数解释： 活跃会话。 取值范围： 不涉及。 slow_sql_total Long 参数解释： 慢SQL数量。 取值范围： 不涉及。 lost_points_detail_list Array of 表21 objects 参数解释： 扣分详情。 取值范围： 不涉及。 表21 HealthReportLostPointsDetail 参数 参数类型 描述 metric String 参数解释： 扣分项。 取值范围： 不涉及。 lost_points Double 参数解释： 所扣分数。 取值范围： 不涉及。 risk_level String 参数解释： 事件等级。 取值范围： 不涉及。

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

请求示例 创建实例健康诊断任务。 POST https://das.cn-north-7.myhuaweicloud.com/v3/052041494800d57c2f02c00275b4c247/instances/bcfa975193f1402fa11a6d4fd6baf5fbin01/create-instance-health-report-task { "start_at" : 1728103093329, "end_at" : 1729103093329 }

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

请求参数 表2 请求Body参数 参数 是否必选 参数类型 描述 start_at 是 Long 参数解释： 开始时间（Unix timestamp），单位：毫秒。 约束限制： 不涉及。 取值范围： [0, 2^31-1]，实际取决于查询。 默认取值： 不涉及。 end_at 是 Long 参数解释： 结束时间（Unix timestamp），单位：毫秒。 约束限制： 不涉及。 取值范围： [0, 2^31-1]，实际取决于查询。 默认取值： 不涉及。

请求示例 删除共享链接。 DELETE https://{{endpoint}}/v3/{{project_id}}/connections/share { "users" : [ { "user_id" : "0852a89ae180d5401f5ac00271a4a02e", "user_name" : "username1" }, { "user_id" : "07da4af00180d5651f49c00200b352b5", "user_name" : "username2" } ], "shared_conn_id" : "ee64e597-4f25-486f-bba1-0c850b3b59d6" }

请求参数 表2 请求Body参数 参数 是否必选 参数类型 描述 shared_conn_id 是 String 参数解释： 共享连接ID。用户使用数据库账号与数据库建立的连接ID（数据库用户ID由创建实例连接接口创建）。 约束限制： 不涉及。 取值范围： 只能由英文字母、数字、中划线组成，且长度为36个字符的UUID。 默认取值： 不涉及 users 是 Array of ShareConnUserInfo objects 参数解释： 用户。 约束限制： 可组合，用逗号分隔。 取值范围： 不涉及。 默认取值： 不涉及。 表3 ShareConnUserInfo 参数 是否必选 参数类型 描述 user_id 是 String 参数解释： 用户ID。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 user_name 是 String 参数解释： 用户名。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。

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

请求参数 表2 请求Body参数 参数 是否必选 参数类型 描述 engine_type 是 String 参数解释： 数据库引擎类型。 约束限制： 不涉及。 取值范围： mysql sqlserver postgresql taurus gaussdbv5 mongodb ddm 默认取值： 不涉及。 network_type 是 String 参数解释： 数据库来源类型。 约束限制： 不涉及。 取值范围： rds gaussdb dds ddm 默认取值： 不涉及。 username 是 String 参数解释： 用户名。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 is_save_password 是 Boolean 参数解释： 是否保存密码。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 password 是 String 参数解释： 密码。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 node_ids 否 Array of strings 参数解释： 节点ID。标识实例节点的唯一标识。 约束限制： 不涉及。 取值范围： 只能由英文字母、数字组成，且长度为32个字符。 默认取值： 不涉及。 remarks 否 String 参数解释： 备注。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 port 否 Integer 参数解释： 端口。 约束限制： 不涉及。 取值范围： [1,65536] 默认取值： 不涉及。 database_name 否 String 参数解释： 数据库名字。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 sql_record_flag 否 Boolean 参数解释： sql记录开关。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。

请求示例 创建实例连接。 POST https://das.cn-north-7.myhuaweicloud.com/v3/052041494800d57c2f02c00275b4c247/instances/bcfa975193f1402fa11a6d4fd6baf5fbin01/create-connection { "engine_type" : "mysql", "network_type" : "rds", "username" : "root", "is_save_password" : true, "password" : "Gauss_2345", "sql_record_flag" : true, "remarks" : "create by api" }

响应示例 状态码： 200 Success. { "tasks": [ { "id": 1128, "instance_id": "da304cd5bbb944de828759bc7be3d3fein01", "start_at": 1738717200000, "end_at": 1738720800000, "status": 2, "progress": 100, "create_at": 1738740285113, "update_at": 1738740294826 } ], "total": 1 }

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 tasks Array of 表4 objects 参数解释： SQL洞察任务列表。 取值范围： 不涉及。 total Integer 参数解释： 总数。 取值范围： 不涉及。 表4 FullSqlTask 参数 参数类型 描述 id Long 参数解释： 任务ID。 取值范围： 不涉及。 instance_id String 参数解释： 实例ID。 取值范围： 不涉及。 instance_name String 参数解释： 实例名称。 取值范围： 不涉及。 node_id String 参数解释： 节点ID。 取值范围： 不涉及。 start_at Long 参数解释： 开始时间（Unix timestamp），单位：毫秒。 取值范围： 不涉及。 end_at Long 参数解释： 结束时间（Unix timestamp），单位：毫秒。 取值范围： 不涉及。 batch_id String 参数解释： 批次ID。 取值范围： 不涉及。 user_list Array of strings 参数解释： 用户名。 取值范围： 不涉及。 keyword Array of strings 参数解释： 关键字。 取值范围： 不涉及。 db_list Array of strings 参数解释： 数据库。 取值范围： 不涉及。 operation_list Array of strings 参数解释： 操作类型。 取值范围： 不涉及。 thread_id_list Array of strings 参数解释： 线程ID。 取值范围： 不涉及。 trx_id_list Array of strings 参数解释： 事务ID。 取值范围： 不涉及。 status_list Array of strings 参数解释： 执行状态。 取值范围： 0：成功 1：失败 sql_template_ids Array of strings 参数解释： SQL模板ID。 取值范围： 不涉及。 status Integer 参数解释： 任务状态。 取值范围： 0：等待解析 1：解析中 2：解析完成 -1：失败。 progress Double 参数解释： 任务进度。 取值范围： [0,100] reason String 参数解释： 失败原因。 取值范围： 不涉及。 create_at Long 参数解释： 创建时间（Unix timestamp），单位：毫秒。 取值范围： 不涉及。 update_at Long 参数解释： 更新时间（Unix timestamp），单位：毫秒。 取值范围： 不涉及。

URI GET /v3/{project_id}/instances/{instance_id}/full-sql-tasks 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 参数解释： 租户在某一Region下的项目ID。 获取方法请参见获取项目ID。 约束限制： 不涉及。 取值范围： 只能由英文字母、数字组成，且长度为32个字符。 默认取值： 不涉及。 instance_id 是 String 参数解释： 实例ID。标识实例的唯一标识。 约束限制： 不涉及。 取值范围： 只能由英文字母、数字组成，且长度为32个字符。 默认取值： 不涉及。 表2 Query参数 参数 是否必选 参数类型 描述 range_left 否 Long 参数解释： 最小任务起止时间。 约束限制： Unix timestamp，单位：毫秒。 取值范围： [0, 2^31-1]，实际取决于查询。 默认取值： 不涉及。 range_right 否 Long 参数解释： 最大任务起止时间。 约束限制： Unix timestamp，单位：毫秒。 取值范围： [0, 2^31-1]，实际取决于查询。 默认取值： 不涉及。 create_at_left 否 Long 参数解释： 最小任务创建时间。 约束限制： Unix timestamp，单位：毫秒。 取值范围： [0, 2^31-1]，实际取决于查询。 默认取值： 不涉及。 create_at_right 否 Long 参数解释： 最大任务创建时间。 约束限制： Unix timestamp，单位：毫秒。 取值范围： [0, 2^31-1]，实际取决于查询。 默认取值： 不涉及。 user 否 String 参数解释： 用户名 约束限制： 可组合，用逗号分隔。 取值范围： 不涉及。 默认取值： 不涉及。 keyword 否 String 参数解释： 关键字。 约束限制： 可组合，用逗号分隔。 取值范围： 不涉及。 默认取值： 不涉及。 db_name 否 String 参数解释： 数据库名。 约束限制： 可组合，用逗号分隔。 取值范围： 不涉及。 默认取值： 不涉及。 operation 否 String 参数解释： 操作类型 约束限制： 可组合，用逗号分隔。 取值范围： 不涉及。 默认取值： 不涉及。 thread_id 否 String 参数解释： 线程ID 约束限制： 可组合，用逗号分隔。 取值范围： 不涉及。 默认取值： 不涉及。 trx_id 否 String 参数解释： 事务ID 约束限制： 可组合，用逗号分隔。 取值范围： 不涉及。 默认取值： 不涉及。 status 否 String 参数解释： 执行状态 约束限制： 可组合，用逗号分隔。 取值范围： 0：成功 1：失败 默认取值： 不涉及。 sql_template_id 否 String 参数解释： SQL模板ID 约束限制： 可组合，用逗号分隔。 取值范围： 不涉及。 默认取值： 不涉及。 sort_field 否 String 参数解释： 排序字段。 create_at：任务创建时间 range_start_at，range_end_at：任务起止时间 约束限制： 不涉及。 取值范围： create_at：任务创建时间 range_start_at，range_end_at：任务起止时间 默认取值： 不涉及。 asc 否 Boolean 参数解释： 排序顺序。 约束限制： 不涉及。 取值范围： true：正序 false：逆序 默认取值： 不涉及。 page 否 Integer 参数解释： 页码。 约束限制： 不涉及。 取值范围： [0, 2^31-1]，实际取决于查询。 默认取值： 不涉及。 limit 否 Integer 参数解释： 每页记录数。 约束限制： 不涉及。 取值范围： [0, 100]，实际取决于查询。 默认取值： 不涉及。

响应参数 状态码： 200 表1 响应Body参数 参数 参数类型 描述 versions Array of ApiVersion objects 参数解释： API版本详细信息列表。 取值范围： 不涉及。 表2 ApiVersion 参数 参数类型 描述 id String 参数解释： API版本号，如v3。 取值范围： 不涉及。 status String 参数解释： 版本状态。 取值范围： CURRENT：主推版本。 SUPPORTED：老版本，但是现在还继续支持。 DEPRECATED：废弃版本，存在后续删除的可能。 updated String 参数解释： 版本发布时间。 格式为“yyyy-mm-ddThh:mm:ssZ”。 其中，T指某个时间的开始；Z指UTC时间。 取值范围： 不涉及。 version String 参数解释： API的微版本，如果不支持微版本，则为空。 取值范围： 不涉及。

请求参数 表2 请求Body参数 参数 是否必选 参数类型 描述 database_name 是 String 参数解释： 数据库名称。 约束限制： 仅支持MySQ L实例 的数据库。 取值范围： 不涉及。 默认取值： 不涉及。 schema_name 否 String 参数解释： Schema名称。 约束限制： 仅支持MySQL实例的数据库。 取值范围： 不涉及。 默认取值： 不涉及。 sql_script 是 String 参数解释： SQL脚本。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 node_type 否 String 参数解释： 节点ID。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 node_id 否 String 参数解释： 节点ID。 约束限制： 不涉及。 取值范围： 只能由英文字母、数字组成，且长度为32个字符。 默认取值： 不涉及。

请求示例 执行SQL诊断。 POST https://{{endpoint}}/v3/{{project_id}}/connections/{connection_id}/tuning/create-tuning { "database_name" : "string", "schema_name" : "string", "sql_script" : "string" }

URI POST /v3/{project_id}/connections/{connection_id}/tuning/create-tuning 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 参数解释： 租户在某一Region下的项目ID。 获取方法请参见获取项目ID。 约束限制： 不涉及。 取值范围： 只能由英文字母、数字组成，且长度为32个字符。 默认取值： 不涉及。 connection_id 是 String 参数解释： 数据库用户ID。用户使用数据库账号与数据库建立的连接ID（数据库用户ID由注册数据库用户接口创建）。 取值范围： 只能由英文字母、数字、中划线组成，且长度为36个字符的UUID。

基础概念 账号 用户注册时的账号，账号对其所拥有的资源及云服务具有完全的访问权限，可以重置用户密码、分配用户权限等。由于账号是付费主体，为了确保账号安全，建议您不要直接使用账号进行日常管理工作，而是创建用户并进行日常管理工作。 用户 由账号在 IAM 中创建的用户，是云服务的使用人员，具有身份凭证（密码和访问密钥）。 在我的凭证下，您可以查看账号ID和用户ID。通常在调用API的鉴权过程中，您需要用到账号、用户和密码等信息。 区域 指云资源所在的物理位置，同一区域内可用区间内网互通，不同区域间内网不互通。通过在不同地区创建云资源，可以将应用程序设计的更接近特定客户的要求，或满足不同地区的法律或其他要求。 可用区 一个可用区是一个或多个物理数据中心的集合，有独立的风火水电，AZ内逻辑上再将计算、网络、存储等资源划分成多个集群。一个Region中的多个AZ间通过高速光纤相连，以满足用户跨AZ构建高可用性系统的需求。 项目 区域默认对应一个项目，这个项目由系统预置，用来隔离物理区域间的资源（计算资源、存储资源和网络资源），以默认项目为单位进行授权，用户可以访问您账号中该区域的所有资源。如果您希望进行更加精细的权限控制，可以在区域默认的项目中创建子项目，并在子项目中购买资源，然后以子项目为单位进行授权，使得用户仅能访问特定子项目中资源，使得资源的权限控制更加精确。 图1 项目隔离模型 企业项目 企业项目是项目的升级版，针对企业不同项目间资源的分组和管理，是逻辑隔离。企业项目中可以包含多个区域的资源，且项目中的资源可以迁入迁出。 关于企业项目ID的获取及企业项目特性的详细信息，请参见《企业管理服务用户指南》。

请求示例 查询实例健康诊断报告列表。 GET https://das.cn-north-7.myhuaweicloud.com/v3/052041494800d57c2f02c00275b4c247/instances/bcfa975193f1402fa11a6d4fd6baf5fbin01/get-instance-health-report-task-list?start_at=1727177896507&end_at=1728871794805

响应示例 状态码： 200 Success. { "health_report_task_list" : [ { "instance_id" : "bcfa975193f1402fa11a6d4fd6baf5fbin01", "task_id" : "8aa02bb1-ca4a-4724-ad3b-00993d6e08e0", "create_at" : 1727200803179, "report_status" : "SUC CES S", "risk_count" : 1, "origin" : "SYSTEM", "start_at" : 1727064000211, "end_at" : 1727150400211 } ], "total" : 22 }

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 total Long 参数解释： 诊断报告总数。 取值范围： 不涉及。 health_report_task_list Array of 表4 objects 参数解释： 诊断报告列表。 取值范围： 不涉及。 表4 HealthReportTask 参数 参数类型 描述 task_id String 参数解释： 报告ID。 取值范围： 不涉及。 instance_id String 参数解释： 实例ID。 取值范围： 不涉及。 create_at Long 参数解释： 创建时间（Unix timestamp），单位：毫秒。 取值范围： 不涉及。 report_status String 参数解释： 诊断状态。 取值范围： 不涉及。 risk_count Integer 参数解释： 风险点数量。 取值范围： 不涉及。 origin String 参数解释： 触发源。 取值范围： 不涉及。 start_at Long 参数解释： 日报诊断区间的起始时间（Unix timestamp），单位：毫秒。 取值范围： 不涉及。 end_at Long 参数解释： 日报诊断区间的结束时间（Unix timestamp），单位：毫秒。 取值范围： 不涉及。

URI GET /v3/{project_id}/instances/{instance_id}/get-instance-health-report-task-list 表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]，实际取决于查询。 默认取值： 不涉及。 offset 否 Integer 参数解释： 索引位置，偏移量。从第一条数据偏移offset条数据后开始查询。例如：该参数指定为1，limit指定为10，则只展示第2~11条数据。 约束限制： 不涉及。 取值范围： [0, 2^31-1] 默认取值： 默认为0（偏移0条数据，表示从第一条数据开始查询）。 limit 否 Integer 参数解释： 每页记录数。 约束限制： 不涉及。 取值范围： [0, 200]，实际取决于查询。 默认取值： 10

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 total_record Integer 参数解释： 总记录数目。 取值范围： 不涉及。 das_conn_info_list Array of 表4 objects 参数解释： 连接信息列表。 取值范围： 不涉及。 表4 das_conn_info_list 参数 参数类型 描述 connection_id String 参数解释： 连接ID。 取值范围： 只能由英文字母、数字、中划线组成，且长度为36个字符的UUID。 instance_id String 参数解释： 实例ID。 取值范围： 只能由英文字母、数字组成，且长度为32个字符。 instance_name String 参数解释： 实例名称。 取值范围： 不涉及。 network_type String 参数解释： 数据库来源类型。 取值范围： rds gaussdb dds ddm engine_type String 参数解释： 数据库引擎类型。 取值范围： mysql sqlserver postgresql taurus gaussdbv5 mongodb ddm datastore_version String 参数解释： 数据库版本。 取值范围： 不涉及。 user_name String 参数解释： 用户名。 取值范围： 不涉及。 database_name String 参数解释： 数据库名称。 取值范围： 不涉及。 is_save_password Boolean 参数解释： 是否保存密码。 取值范围： 不涉及。 ip_address String 参数解释： IP地址。 取值范围： 不涉及。 port Integer 参数解释： 端口号。 取值范围： [1,65536] remarks String 参数解释： 备注。 取值范围： 不涉及。 create_at Long 参数解释： 连接的创建时间。 取值范围： 不涉及。 status String 参数解释： 状态。 取值范围： NORMAL：正常 INSTANCE_DELETE：实例删除 conn_share_type String 参数解释： 连接类型。 取值范围： NORMAL：正常连接 SHARE：共享连接 shared_user_name String 参数解释： 共享人名称。 取值范围： 不涉及。 shared_user_id String 参数解释： 共享人ID。 取值范围： 不涉及。 expired_time Long 参数解释： 共享过期时间。 取值范围： 不涉及。