CLI命令参考
获取API版本
云DBA
| API名称 | 命令 | 描述 | 操作 |
|---|---|---|---|
| 查询SQL执行计划 | hcloud DAS ShowSqlExecutionPlan | 查询SQL执行计划。 | |
| 查询SQL执行计划 | hcloud DAS ShowSqlExplain | 查询SQL执行计划。 | |
| 查杀会话 | hcloud DAS DeleteProcess | 查杀会话。支持按照用户、数据库、会话列表查杀会话,三个条件至少指定一个。 | |
| 查询元数据锁列表 | hcloud DAS ListMetadataLocks | 查询元数据锁列表。 | |
| 查询InnoDB锁等待列表 | hcloud DAS ListInnodbLocks | 查询InnoDB锁等待列表。 | |
| 查询数据库用户列表 | hcloud DAS ListDbUsers | 查询注册在DAS里的数据库用户列表,后续调用其他接口时(如查询实例会话列表接口)需要用到此接口返回的db_user_id。此接口不会返回数据库实例上的数据库用户对象。 | |
| 注册数据库用户 | hcloud DAS RegisterDbUser | 此接口是将数据库用户和密码注册进DAS系统,同时会返回一个数据库用户ID,后续调用其他接口时(如查询实例会话列表接口)需要用到此数据库用户ID。密码为加密存储,且仅用于DAS API相关功能。此接口不会在数据库实例上创建数据库用户对象。请确保输入的用户名和密码是已经存在并且是正确的。 | |
| 查询实例会话列表 | hcloud DAS ListProcesses | 支持根据数据库、用户查询实例会话列表。 | |
| 查询数据库用户信息 | hcloud DAS ShowDbUser | 查询注册在DAS里的数据库用户信息。此接口不能查询数据库实例上的数据库用户对象。 | |
| 修改数据库用户 | hcloud DAS UpdateDbUser | 修改注册在DAS里的数据库用户名和密码。此接口不会修改数据库实例上的数据库用户对象的用户名和密码。请确保输入的用户名和密码是已经存在并且是正确的。 | |
| 删除数据库用户 | hcloud DAS DeleteDbUser | 删除注册在DAS里的数据库用户。此接口只是将注册的数据库用户在DAS系统里删除,不会真正删除数据库用户对象。 | |
| 获取空间分析数据列表 | hcloud DAS ListSpaceAnalysis | 获取空间分析数据列表。实例级别数据来源于文件系统,库级别和表级别数据来源于information_schema.tables表。空间&元数据分析最多分析10000张表,若缺少库表空间数据,可能是因为数据库实例表个数过多或者账号未保存密码。如果未保存密码,请使用用户管理接口或页面录入数据库账号。 支持MySQL、TaurusDB和SQL Server引擎。 | |
| 创建空间分析任务 | hcloud DAS CreateSpaceAnalysisTask | 创建空间分析任务,如触发重新分析,支持MySQL和TaurusDB引擎。 | |
| 开启/关闭全量SQL、慢SQL开关 | hcloud DAS ChangeSqlSwitch | 打开或者关闭DAS收集全量SQL开关,开启后,实例的性能损耗在5%以内。开启全量SQL后,本服务会对SQL的文本内容进行存储,以便进行分析。用户可自行设置全量SQL的保存时间范围,到期后会自动删除;如果未设置,数据默认保留7天。 | |
| 查询全量SQL和慢SQL的开关状态 | hcloud DAS ShowSqlSwitchStatus | 查询DAS收集全量SQL和慢SQL的开关状态。该功能仅支持付费实例。 | |
| 导出慢SQL数据 | hcloud DAS ExportSlowQueryLogs | DAS收集慢SQL开关打开后,一次性导出指定时间范围内的慢SQL数据,支持分页滚动获取。免费实例仅支持查看最近一小时数据。 | |
| 导出全量SQL | hcloud DAS ExportSqlStatements | 全量SQL开关打开后,一次性导出指定时间范围内的全量SQL数据,支持分页滚动获取。该功能仅支持付费实例。 | |
| 导出全量SQL明细 | hcloud DAS ExportFullSqlDetails | 全量SQL开关打开后,创建SQL洞察任务,支持按节点、用户名、数据库、操作类型等导出全量SQL明细数据。该功能仅支持付费实例。 | |
| 查询SQL洞察任务列表 | hcloud DAS ListFullSqlTasks | 全量SQL开关打开后,查询SQL洞察任务列表。该功能仅支持付费实例。 | |
| 查询云DBA配额 | hcloud DAS ShowQuotas | 查询云DBA配额。 | |
| 查看SQL限流开关状态 | hcloud DAS ShowSqlLimitSwitchStatus | 查询SQL限流的开关状态。目前仅支持MySQL实例。 | |
| 设置SQL限流开关状态 | hcloud DAS ChangeSqlLimitSwitchStatus | 设置SQL限流开关状态。目前仅支持MySQL数据库。 | |
| 查询SQL限流规则列表 | hcloud DAS ListSqlLimitRules | 查询SQL限流规则。目前仅支持MySQL和PostgreSQL数据库。 | |
| 创建SQL限流规则 | hcloud DAS CreateSqlLimitRules | 添加SQL限流规则。目前仅支持MySQL和PostgreSQL数据库。 | |
| 删除SQL限流规则 | hcloud DAS DeleteSqlLimitRules | 删除SQL限流规则。目前仅支持MySQL和PostgreSQL数据库。 | |
| 修改SQL限流规则 | hcloud DAS UpdateSqlLimitRules | 修改SQL限流规则。目前仅支持PostgreSQL数据库。 | |
| 导出TopSQL模板列表 | hcloud DAS ExportTopSqlTemplatesDetails | TopSQL开关打开后,导出TopSQL模板列表。该功能仅支持付费实例。查询时间间隔最长一小时。 | |
| 查询SQL限流任务 | hcloud DAS ShowSqlLimitJobInfo | 查询指定ID的SQL限流任务信息。 | |
| 导出慢SQL模板列表 | hcloud DAS ExportSlowSqlTemplatesDetails | 慢SQL开关打开后,导出慢SQL模板列表。免费实例仅支持查看最近一小时数据。查询时间间隔最长一天。 | |
| 导出SQL执行耗时区间数据 | hcloud DAS ExportTopSqlTrendDetails | TopSQL开关打开后,导出SQL执行耗时区间数据。该功能仅支持付费实例。查询时间间隔最长六小时。 | |
| 执行SQL诊断 | hcloud DAS CreateTuning | 执行SQL诊断。 | |
| 获取诊断结果 | hcloud DAS ShowTuning | 获取诊断结果。 | |
| 导出慢SQL统计数据 | hcloud DAS ExportSlowSqlStatistics | 慢SQL开关打开后,导出慢SQL统计数据。 | |
| 查询历史事务开关 | hcloud DAS ShowTransactionSwitchStatus | 查询历史事务开关。 | |
| 开启/关闭历史事务开关 | hcloud DAS ChangeTransactionSwitchStatus | 开启/关闭历史事务开关,仅支持MySQL引擎,并且依赖开启全量SQL或者慢SQL功能。 | |
| 查询历史事务列表 | hcloud DAS ListTransactions | 查询历史事务列表。 | |
| 创建导出历史事务任务 | hcloud DAS CreateHistoryTransactionExportTask | DAS收集历史事务开关打开后,支持创建一次性导出指定时间范围内的历史事务数据任务。 | |
| 删除导出历史事务任务 | hcloud DAS DeleteHistoryTransactionExportTask | DAS收集历史事务开关打开后,删除历史事务导出任务记录对应的OBS文件。 | |
| 查询历史事务导出任务列表 | hcloud DAS ListHistoryTransactionExportTask | DAS收集历史事务开关打开后,查询历史事务导出任务列表。 | |
| 查询历史事务导出任务详情 | hcloud DAS ShowHistoryTransactionExportTaskInfo | DAS收集历史事务开关打开后,查询历史事务导出任务详情。 | |
| 根据原始SQL生成SQL限流关键字 | hcloud DAS ParseSqlLimitRules | 根据原始SQL生成SQL限流关键字,目前支持MySQL、MariaDB、TaurusDB三种引擎。 | |
| 导出慢SQL数量趋势 | hcloud DAS ExportSlowSqlTrendDetails | 慢SQL开关打开后,导出慢SQL数量趋势。免费实例仅支持查看最近一小时数据。查询时间间隔最长一天。 | |
| 导出TOP风险实例列表 | hcloud DAS ExportTopRiskInstances | 导出TOP风险实例列表,支持查看最近24小时数据。 | |
| 查询实例分布情况 | hcloud DAS ListInstanceDistribution | 查询实例分布情况。 | |
| 查询TOP慢SQL列表 | hcloud DAS ListTopSlowLog | 查询TOP慢SQL列表。 | |
| 查询实例的TOP慢SQL列表 | hcloud DAS ListInstanceTopSlowLog | 查询实例的TOP慢SQL列表。 | |
| 多节点单指标支持指标信息 | hcloud DAS ShowMetricNamesSupport | 多节点单指标支持指标信息。 | |
| 获取单个实例节点信息 | hcloud DAS ListInstanceNodesInfo | 获取单个实例节点信息。 | |
| 获取多节点单指标数据 | hcloud DAS ListInstanceMultiNodesSingleMetric | 获取多节点单指标数据。 | |
| 查询资源风险实例风险项 | hcloud DAS ListRiskItems | 查询资源风险实例风险项。 | |
| 查询资源风险实例风险趋势 | hcloud DAS ListRiskTrend | 查询资源风险实例风险趋势。 | |
| 设置指标阈值 | hcloud DAS SetThresholdForMetric | 设置指标阈值。 | |
| 获取DAS云DBA实例列表 | hcloud DAS ListCloudDbaInstances | 获取DAS云DBA实例列表。 | |
| 创建实例健康诊断任务 | hcloud DAS CreateHealthReportTask | 创建实例健康诊断任务。 | |
| 查询实例健康诊断报告列表 | hcloud DAS ListHealthReportTask | 查询实例健康诊断报告列表。 | |
| 获取实例健康诊断报告内容 | hcloud DAS ShowInstanceHealthReport | 获取实例健康诊断报告内容。 | |
| 同步实例列表 | hcloud DAS SynchronizeInstances | 同步实例列表。 | |
| 设置实例付费/免费模式 | hcloud DAS ChangeChargeMode | 设置实例付费/免费模式。 | |
| 设置实例付费/免费模式 | hcloud DAS ChangePaymentModeNew | 设置实例付费/免费模式。 | |
| 创建全量SQL明细解析任务 | hcloud DAS AddFullSqlTask | 创建全量SQL明细解析任务。 | |
| 设置全量死锁开关 | hcloud DAS ChangeFullDeadLockSwitch | 设置全量死锁开关。 | |
| 获取全量死锁开关 | hcloud DAS ShowFullDeadLockSwitch | 获取全量死锁开关。 | |
| 获取全量死锁信息 | hcloud DAS ShowFullDeadLockList | 获取全量死锁信息。 | |
| 获取死锁的快照信息 | hcloud DAS ShowLatestDeadLockSnapshot | 获取死锁的快照信息。 | |
| 查询快照列表 | hcloud DAS ListSnapshots | 查询快照列表。 | |
| 创建快照 | hcloud DAS CreateSnapshots | 创建快照。 | |
| 测试AK/SK | hcloud DAS CheckCredential | 测试AK/SK,测试用户AK/SK能否正常访问OBS桶。 | |
| 保存AK/SK | hcloud DAS SaveCredential | 保存AK/SK,用于后台任务访问OBS上传实例诊断报告。 | |
| 查看实例诊断报告设置 | hcloud DAS ShowHealthReportSettings | 查看实例诊断报告设置。 | |
| 更新实例诊断报告设置 | hcloud DAS UpdateHealthReportSettings | 更新实例诊断报告设置。 | |
| 内置账号登录 | hcloud DAS LoginBuiltInAccount | 内置账号登录。 | |
| 内置账号登出 | hcloud DAS LogoffBuiltInAccount | 内置账号登出。 | |
| 自动推荐SQL限流规则 | hcloud DAS ShowDasRecommendSqlLimitRule | 根据条件(包括模板所代表的sql平均时长,条数,最大执行时长,前三者混合)自动推荐SQL限流规则。 | |
| 查询自增配额 | hcloud DAS ListAutoIncrementUsage | 查询自增配额。 | |
| 查询巡检报告列表 | hcloud DAS ListInspectionReport | 查询巡检报告列表。 | |
| 查询邮件推送记录 | hcloud DAS ListEmailRecord | 查询邮件推送记录。 | |
| 查询邮件模板列表 | hcloud DAS ListEmailTemplate | 查询邮件模板列表。 | |
| 新增邮件模板 | hcloud DAS AddEmailTemplate | 新增邮件模板。 | |
| 修改邮件模板 | hcloud DAS UpdateEmailTemplate | 修改邮件模板。 | |
| 删除邮件模板 | hcloud DAS DeleteEmailTemplate | 删除邮件模板。 | |
| 批量订阅/取消订阅 | hcloud DAS BatchSubscribeReport | 批量订阅/取消订阅。 | |
| 查询实例组列表 | hcloud DAS ListInstanceGroup | 查询实例组列表。 | |
| 新增实例组 | hcloud DAS AddInstanceGroup | 新增实例组。 | |
| 修改实例组 | hcloud DAS UpdateInstanceGroup | 修改实例组。 | |
| 删除实例组 | hcloud DAS DeleteInstanceGroup | 删除实例组。 | |
| 将实例添加到实例组 | hcloud DAS AddInstanceToGroup | 将实例添加到实例组。 | |
| 批量发送邮件 | hcloud DAS BatchSendEmail | 批量发送邮件。 | |
| 测试AK/SK | hcloud DAS CheckCredentialForBatchInspection | 测试AK/SK,测试用户AK/SK能否正常访问OBS桶。 | |
| 保存AK/SK | hcloud DAS SaveCredentialForBatchInspection | 保存AK/SK,用于后台任务访问OBS上传实例诊断报告。 | |
| 查询AK/SK | hcloud DAS ShowCredential | 查询AK/SK。用于判断是否已保存AK/SK。 | |
| 查询锁阻塞数据库名列表 | hcloud DAS ListLockBlockingDb | 查询锁阻塞数据库名列表。 | |
| 查询锁阻塞明细列表 | hcloud DAS ListLockBlockingDetail | 查询锁阻塞明细列表。 | |
| 查询锁阻塞关系 | hcloud DAS ListLockBlockingRelationship | 查询锁阻塞关系。 | |
| 查询锁阻塞数量统计 | hcloud DAS ShowLockBlockingStatistics | 查询锁阻塞数量统计。 | |
| 查询锁阻塞趋势列表 | hcloud DAS ShowLockBlockingTrend | 查询锁阻塞趋势列表。 | |
| 查询锁阻塞开关和保存时长 | hcloud DAS ShowLockBlockingSwitch | 查询锁阻塞开关和保存时长。 | |
| 设置锁阻塞开关和保存时长 | hcloud DAS SetLockBlockingSwitch | 设置锁阻塞开关和保存时长,仅支持SQL Server引擎。 | |
| 开始会话分析 | hcloud DAS StartAnalysisSession | 开始会话分析。 | |
| 查询会话分析状态 | hcloud DAS ShowAnalysisSessionStatus | 查询会话分析状态。 | |
| 查询会话分析结果 | hcloud DAS ShowAnalysisSessionResult | 查询会话分析结果。 | |
| 获取死锁拓扑图数据 | hcloud DAS ShowDeadLockTopology | 获取死锁拓扑图数据。 | |
| 一键分析死锁日志 | hcloud DAS ParseDeadLock | 一键分析死锁日志。 | |
| 查询死锁日志分析结果 | hcloud DAS ShowDeadLockAnalysisResult | 查询死锁日志分析结果。 | |
| 取消共享链接 | hcloud DAS CancelShareNew | 取消共享链接。 | |
| 批量删除连接 | hcloud DAS BatchDeleteConnectionNew | 批量删除连接。 | |
| 获取最新的数据库健康日报内容 | hcloud DAS ShowLatestInstanceHealthReport | 获取最新的数据库健康日报内容。 | |
| 新增SQL限流规则 | hcloud DAS AddSqlLimitingRecordNew | 新增SQL限流规则。 | |
| 查看全量SQL导出任务详情 | hcloud DAS ShowExportTaskInfo | 查看全量SQL导出任务详情。 | |
| 判断该实例能否使用云DBA功能 | hcloud DAS ShowWhetherUseCloudDba | 判断该实例能否使用云DBA功能。 | |
| 开通配额询价 | hcloud DAS ShowDasCloudDbaPrice | 开通配额询价。 | |
| 查询searchpath开关状态 | hcloud DAS ShowClouddbaGetSearchPathFlagNew | 查询searchpath开关状态。 | |
| 查询死锁开关状态 | hcloud DAS ShowDeadLockSwitchNew | 查询死锁开关状态。 | |
| 查看支持的引擎类型 | hcloud DAS ShowSupportedEngines | 查看支持的引擎类型。 | |
| 开启/关闭全量SQL开关 | hcloud DAS SwitchFullsqlSwitch | 开启/关闭全量SQL开关。 | |
| 获取全量死锁开关 | hcloud DAS ShowFullDeadLockSwitchNew | 获取全量死锁开关。 | |
| 获取产品级别的安全协议 | hcloud DAS ShowGlobalPrivacyNew | 获取产品级别的安全协议。 | |
| 查询历史事务开关 | hcloud DAS ShowHistoryTransactionSwitchNew | 查询历史事务开关。 | |
| 查询长事务开关 | hcloud DAS ShowLongHistoryTransactionSwitchNew | 查询长事务开关。 | |
| 查询索引使用开关 | hcloud DAS ShowIndexUsageSwitchNew | 查询索引使用开关。 | |
| 查询慢日志开关 | hcloud DAS ShowSlowLogSwitchNew | 查询慢日志开关。 | |
| 查询SQL限流开关 | hcloud DAS ShowSqlLimitingSwitchNew | 查询SQL限流开关。 | |
| 获取库名列表 | hcloud DAS ListDbNames | 获取库名列表。 | |
| 查看库名列表 | hcloud DAS ShowNameList | 查看库名列表。 | |
| 查询自治限流开关 | hcloud DAS ShowKillProcessTaskSwitch | 查询自治限流开关。 |
开发工具
| API名称 | 命令 | 描述 | 操作 |
|---|---|---|---|
| 设置共享链接 | hcloud DAS CreateShareConnections | 设置共享链接。 | |
| 删除共享链接 | hcloud DAS CancelShareConnections | 删除共享链接。 | |
| 创建实例连接 | hcloud DAS CreateInstanceConnection | 创建实例连接。 | |
| 查询实例连接列表 | hcloud DAS ListConnections | 查询实例连接列表。 | |
| 立即执行导出任务 | hcloud DAS ExecuteExportTask | 立即执行导出任务。 | |
| 立即执行导入任务 | hcloud DAS ExecuteImportTask | 立即执行导入任务。 |