CLI命令参考
审计实例
| API名称 | 命令 | 描述 | 操作 |
|---|---|---|---|
| 云脑链接器获取资源列表 | hcloud DBSS ListDomainAllResource | 云脑链接器获取资源列表 | |
| 云脑链接器获取资源总量 | hcloud DBSS ShowDomainAllResourceCount | 云脑链接器获取资源总量 | |
| 获取实例监控数据 | hcloud DBSS ShowInstanceMonitorInfo | 获取实例监控数据 | |
| 配置审计实例时区信息 | hcloud DBSS SetAuditInstanceTimeZone | 配置审计实例时区信息 | |
| 触发审计实例升级 | hcloud DBSS ConfirmUpgradeAudit | 触发审计实例升级 | |
| 查询租户的实例是否可升级 | hcloud DBSS ShowAuditUpgradeStatus | 查询租户的实例是否可升级 | |
| 查询审计实例列表 | hcloud DBSS ListAuditInstancesLast | 查询审计实例列表 | |
| 删除审计实例 | hcloud DBSS DeleteInstancesNew | 只有按需计费模式实例没有任务时 或 包周期模式实例状态为故障时，才能执行此操作。 | |
| 查询账户配额信息 | hcloud DBSS ShowAuditQuotaNew | 查询账户配额信息 | |
| 查询ECS服务器规格信息 | hcloud DBSS ListEcsSpecificationNew | 查询ECS服务器规格信息 | |
| 查询实例创建任务信息 | hcloud DBSS ListAuditInstanceJobsNew | 查询实例创建任务信息 | |
| 查询用户操作日志信息 | hcloud DBSS ListAuditOperateLogsNew | 查询用户操作日志信息 | |
| 包年包月计费模式创建审计实例 | hcloud DBSS CreateInstancesPeriodOrderNew | 包年包月计费模式创建审计实例 | |
| 修改实例安全组 | hcloud DBSS UpdateAuditSecurityGroupNew | 修改实例安全组 | |
| 开启审计实例 | hcloud DBSS StartAuditInstanceNew | 开启审计实例 | |
| 关闭审计实例 | hcloud DBSS StopAuditInstanceNew | 关闭审计实例 | |
| 重启审计实例 | hcloud DBSS RebootAuditInstanceNew | 重启审计实例 | |
| 更新审计实例信息 | hcloud DBSS UpdateAuditInstanceNew | 更新审计实例信息 | |
| 获取审计实例日志保存时间配置 | hcloud DBSS ShowLogRetentionCommonSettings | 获取审计实例日志保存时间配置 | |
| 设置审计实例日志保存时间配置 | hcloud DBSS UpdateLogRetentionCommonSettings | 设置审计实例日志保存时间配置 |
风险导出
| API名称 | 命令 | 描述 | 操作 |
|---|---|---|---|
| 修改风险导出桶名和路径(按DomainId) | hcloud DBSS UpdateAuditRiskBucketPath | 修改风险导出桶名和路径(按DomainId) | |
| 获取风险导出配置列表 | hcloud DBSS ListAuditBackupRiskTemplates | 获取风险导出配置列表 | |
| 获取单个风险导出配置 | hcloud DBSS ShowAuditBackRiskTemplate | 获取单个风险导出配置 | |
| 获取风险导出桶名和路径 | hcloud DBSS ShowBackupRiskBucketPath | 获取风险导出桶名和路径 | |
| 风险导出开关(按DomainId) | hcloud DBSS SetAuditBackupRiskSwitch | 风险导出开关(按DomainId) |
管理侧查询
总览
数据报表
| API名称 | 命令 | 描述 | 操作 |
|---|---|---|---|
| 获取指定SQL语句的详细信息 | hcloud DBSS ShowSqlDetail | 获取指定SQL语句的详细信息 | |
| 获取指定时间段内的SQL分布统计 | hcloud DBSS CountSqlStatistics | 获取指定时间段内的SQL分布统计 | |
| 获取指定时间段内的查询会话统计 | hcloud DBSS CountSessionStatistics | 获取指定时间段内的查询会话统计 | |
| 获取指定时间段内的风险操作数量分布统计 | hcloud DBSS CountOperationStatistics | 获取指定时间段内的风险操作数量分布统计 | |
| 获取指定时间段内的sql注入分布统计 | hcloud DBSS CountInjectionStatistics | 获取指定时间段内的sql注入分布统计 | |
| 获取指定时间段内的sql数量分布统计 | hcloud DBSS CountSqlTrendStatistics | 获取指定时间段内的sql数量分布统计 | |
| 获取指定时间段内的风险分布统计 | hcloud DBSS CountRiskTrendStatistics | 获取指定时间段内的风险分布统计 | |
| 查询数据库用户会话分布 | hcloud DBSS CountDbAccountSession | 查询数据库用户会话分布 | |
| 查询客户端会话分布 | hcloud DBSS CountDbClientSession | 查询客户端会话分布 | |
| 查询趋势历史数据 | hcloud DBSS ListAuditTrendHistory | 查询趋势历史数据 | |
| 查询审计SQL语句 | hcloud DBSS ListAuditSqlsNew | 查询审计SQL语句 |
审计规则-隐私数据保护
| API名称 | 命令 | 描述 | 操作 |
|---|---|---|---|
| 获取隐私数据结果集开关 | hcloud DBSS ShowSensitiveResultSwitch | 获取隐私数据结果集开关 | |
| 开启关闭结果集存储 | hcloud DBSS SetSensitiveResultSwitch | 开启关闭结果集存储 | |
| 获取隐私数据脱敏开关 | hcloud DBSS ShowSensitiveMaskSwitch | 获取隐私数据脱敏开关 | |
| 开启关闭隐私数据脱敏功能 | hcloud DBSS SetSensitiveSwitch | 开启关闭隐私数据脱敏 | |
| 启用禁用单条隐私数据脱敏规则 | hcloud DBSS SetSensitiveMaskRuleSwitch | 启用禁用隐私数据脱敏规则 | |
| 删除隐私数据脱敏规则 | hcloud DBSS DeleteSensitiveRules | 删除隐私数据脱敏规则 | |
| 修改编辑隐私数据脱敏规则 | hcloud DBSS UpdateSensitiveMaskRule | 修改编辑隐私数据脱敏规则 | |
| 查询隐私数据脱敏规则 | hcloud DBSS ListAuditSensitiveMasksNew | 查询隐私数据脱敏规则 | |
| 增加隐私数据脱敏规则 | hcloud DBSS CreateSensitiveMaskRule | 增加隐私数据脱敏规则 |
审计规则-审计范围
| API名称 | 命令 | 描述 | 操作 |
|---|---|---|---|
| 删除审计范围策略 | hcloud DBSS DeleteAuditScope | 删除审计范围策略 | |
| 编辑审计范围规则 | hcloud DBSS UpdateAuditScopeRule | 编辑审计范围规则 | |
| 审计范围规则操作-删除策略 | hcloud DBSS BatchDeleteAuditScope | 审计范围规则操作-删除策略 | |
| 启用禁用策略 | hcloud DBSS SetAuditScopeRuleSwitch | 启用禁用策略 | |
| 查询审计范围策略列表 | hcloud DBSS ListAuditRuleScopesNew | 查询审计范围策略列表 | |
| 添加审计范围策略 | hcloud DBSS CreateAuditScopeRule | 添加审计范围策略 |
审计规则-风险操作
| API名称 | 命令 | 描述 | 操作 |
|---|---|---|---|
| 审计实例风险规则排序 | hcloud DBSS SetRiskRuleRank | 审计实例风险规则排序 | |
| 删除风险策略 | hcloud DBSS DeleteAuditRuleRisk | 删除风险策略 | |
| 查询风险规则策略 | hcloud DBSS ListAuditRuleRisksNew | 查询风险规则策略 | |
| 添加风险规则 | hcloud DBSS CreateAuditRiskRule | 添加风险规则 | |
| 查询指定风险规则策略 | hcloud DBSS ShowAuditRuleRiskNew | 查询指定风险规则策略 | |
| 编辑风险操作策略 | hcloud DBSS SetRiskOperationPolicy | 编辑风险操作策略 | |
| 开启/关闭风险规则 | hcloud DBSS SwitchRiskRuleNew | 开启/关闭风险规则 |
审计规则-SQL注入
| API名称 | 命令 | 描述 | 操作 |
|---|---|---|---|
| 删除sql自定义规则 | hcloud DBSS DeleteAuditRuleSql | 删除sql自定义规则 | |
| 编辑sql自定义规则 | hcloud DBSS UpdateAuditSqlRule | 编辑sql自定义规则 | |
| sql规则优先级排序 | hcloud DBSS SetSqlRuleRank | sql规则优先级排序 | |
| 添加sql自定义规则 | hcloud DBSS CreateAuditSqlRule | 添加sql自定义规则 | |
| 开启关闭sql注入策略 | hcloud DBSS SetAuditSqlRuleSwitch | 开启关闭sql注入策略 | |
| 查询SQL注入规则策略 | hcloud DBSS ListSqlInjectionRulesNew | 查询SQL注入规则策略 |
审计Agent
| API名称 | 命令 | 描述 | 操作 |
|---|---|---|---|
| 指定agent_id方式添加agent | hcloud DBSS CreateAuditDbAgent | 指定agent_id方式添加agent | |
| 开启/关闭Agent | hcloud DBSS SwitchAgentNew | 用于开启和关闭Agent审计的功能，当开启后，开始抓取用户的访问信息。 | |
| 下载审计Agent | hcloud DBSS DownloadAuditAgentNew | 下载审计Agent | |
| 删除数据库Agent | hcloud DBSS DeleteAuditAgentNew | 删除数据库Agent | |
| 查询数据库Agent列表 | hcloud DBSS ListAuditAgentNew | 查询数据库Agent列表 | |
| 添加审计数据库Agent | hcloud DBSS AddAuditAgentNew | 添加审计数据库Agent |
告警信息
| API名称 | 命令 | 描述 | 操作 |
|---|---|---|---|
| 批量标记 | hcloud DBSS BatchSetAuditAlarmLogStatus | 批量标记 | |
| 删除告警监控记录 | hcloud DBSS DeleteAuditAlarmLog | 删除告警监控记录 | |
| 标记监控告警 | hcloud DBSS SetAuditAlarmLogStatus | 标记监控告警 | |
| 获取实例告警配置 | hcloud DBSS ListAlarmTopicConfigInfoNew | 获取实例告警配置 | |
| 设置实例告警配置 | hcloud DBSS SetAlarmTopicConfigInfoNew | 设置实例告警配置 | |
| 查询审计告警信息 | hcloud DBSS ListAuditAlarmLogNew | 查询审计告警信息 |
运维增强管理
| API名称 | 命令 | 描述 | 操作 |
|---|---|---|---|
| 获取数据库运维集群实例 | hcloud DBSS ListInstances | 获取数据库运维集群实例 | |
| 更改数据库运维实例的名称 | hcloud DBSS UpdateDbOmInstanceName | 更改数据库运维实例的名称 | |
| 解绑数据库运维实例的EIP | hcloud DBSS UnbindDbOmEip | 解绑数据库运维实例的EIP | |
| 绑定数据库运维实例的EIP | hcloud DBSS BindDbOmEip | 绑定数据库运维实例的EIP | |
| 更改数据库运维实例的安全组 | hcloud DBSS ChangeDbOmSecurityGroup | 更改数据库运维实例的安全组 | |
| 重置数据库运维实例的密码 | hcloud DBSS ResetDbOmPassword | 重置数据库运维实例的密码 | |
| 重启数据库运维实例 | hcloud DBSS RebootDbOmInstance | 重启数据库运维实例 | |
| 停止数据库运维实例 | hcloud DBSS StopDbOmInstance | 停止数据库运维实例 | |
| 启动数据库运维实例 | hcloud DBSS StartDbOmInstance | 启动数据库运维实例 | |
| 删除数据库运维实例 | hcloud DBSS DeleteDbOmInstance | 删除数据库运维实例 | |
| 包周期购买数据库运维实例 | hcloud DBSS CreateDbOmInstancePeriod | 包周期购买数据库运维实例 |
加密增强管理
| API名称 | 命令 | 描述 | 操作 |
|---|---|---|---|
| 列举数据库加密实例 | hcloud DBSS ListDbEncryptInstances | 列举数据库加密实例 | |
| 更改数据库加密实例的名称 | hcloud DBSS UpdateDbEncryptInstanceName | 更改数据库加密实例的名称 | |
| 解绑数据库加密实例的EIP | hcloud DBSS UnbindDbEncryptEip | 解绑数据库加密实例的EIP | |
| 绑定数据库加密实例的EIP | hcloud DBSS BindDbEncryptEip | 绑定数据库加密实例的EIP | |
| 更改数据库加密实例的安全组 | hcloud DBSS ChangeDbEncryptSecurityGroup | 更改数据库加密实例的安全组 | |
| 重置数据库加密实例的密码 | hcloud DBSS ResetDbEncryptPassword | 重置数据库加密实例的密码 | |
| 重启数据库加密实例 | hcloud DBSS RebootDbEncryptInstance | 重启数据库加密实例 | |
| 停止数据库加密实例 | hcloud DBSS StopDbEncryptInstance | 停止数据库加密实例 | |
| 启动数据库加密实例 | hcloud DBSS StartDbEncryptInstance | 启动数据库加密实例 | |
| 删除数据库加密实例 | hcloud DBSS DeleteDbEncryptInstance | 删除数据库加密实例 | |
| 按包周期方式购买数据库加密实例 | hcloud DBSS CreateDbEncryptInstancePeriod | 按包周期方式购买数据库加密实例 |
备份管理
| API名称 | 命令 | 描述 | 操作 |
|---|---|---|---|
| 获取所有备份信息 | hcloud DBSS ListAuditBackupInfo | 获取所有备份信息 | |
| 开启/关闭备份 | hcloud DBSS SetAuditBackupSwitch | 开启/关闭备份 | |
| 获取备份状态 | hcloud DBSS ShowAuditBackupStatus | 获取备份状态 | |
| 重试备份任务 | hcloud DBSS RetryAuditBackupTask | 重试备份任务 | |
| 恢复备份信息 | hcloud DBSS RestoreAuditBackup | 恢复备份信息 | |
| 备份或风险导出时，选择obs桶 | hcloud DBSS ListAuditObsBuckets | 备份或风险导出时，选择obs桶 | |
| 删除指定备份任务 | hcloud DBSS DeleteAuditBackupTask | 删除指定备份任务 | |
| 获取备份配置信息 | hcloud DBSS SetAuditAutoBackupTemplate | 设置备份配置信息 |
报表管理
| API名称 | 命令 | 描述 | 操作 |
|---|---|---|---|
| 获取报表模板 | hcloud DBSS ListAuditReportTemplates | 获取报表模板 | |
| 删除报表 | hcloud DBSS DeleteAuditReport | 删除报表 | |
| 下载报表 | hcloud DBSS DownloadAuditReport | 下载报表 | |
| 更改报表的计划任务配置信息（topic方式） | hcloud DBSS UpdateAuditTopicReportSchedulerConfig | 更改报表的计划任务配置信息（topic方式） | |
| 获取报表的计划任务配置信息（topic方式） | hcloud DBSS ShowAuditTopicReportSchedulerConfig | 获取报表的计划任务配置信息（topic方式） | |
| 查询报表 | hcloud DBSS ListAuditReports | 查询报表 | |
| 立即生成报表 | hcloud DBSS CreateReport | 立即生成报表 |
SQL白名单功能
TMS标签
| API名称 | 命令 | 描述 | 操作 |
|---|---|---|---|
| 获取实例标签 | hcloud DBSS ListAuditTags | 获取实例标签 | |
| 查询项目标签 | hcloud DBSS ListProjectResourceTags | 查询项目标签 | |
| 根据标签查询资源实例列表 | hcloud DBSS ListResourceInstanceByTag | 根据标签查询资源实例列表 | |
| 根据标签查询资源实例数量 | hcloud DBSS CountResourceInstanceByTag | 根据标签查询资源实例数量 | |
| 批量添加资源标签 | hcloud DBSS BatchAddResourceTag | 批量添加资源标签 | |
| 批量删除资源标签 | hcloud DBSS BatchDeleteResourceTag | 批量删除资源标签 |
待下线接口
| API名称 | 命令 | 描述 | 操作 |
|---|---|---|---|
| 获取实例告警配置[待下线] | hcloud DBSS ListAlarmTopicConfigInfo | 获取实例告警配置 | |
| 设置实例告警配置[待下线] | hcloud DBSS SetAlarmTopicConfigInfo | 设置实例告警配置 | |
| 开启关闭风险规则[待下线] | hcloud DBSS SwitchRiskRule | 开启关闭风险规则 | |
| 查询审计实例列表[待下线] | hcloud DBSS ListAuditInstances | 查询审计实例列表 | |
| 删除审计实例[待下线] | hcloud DBSS DeleteInstances | 只有按需计费模式实例没有任务时 或 包周期模式实例状态为故障时，才能执行此操作。 | |
| 查询审计实例列表[待下线] | hcloud DBSS ListAuditInstancesNew | 查询审计实例列表 | |
| 查询账户配额信息[待下线] | hcloud DBSS ShowAuditQuota | 查询账户配额信息 | |
| 查询ECS服务器规格信息[待下线] | hcloud DBSS ListEcsSpecification | 查询ECS服务器规格信息 | |
| 查询可用区信息[待下线] | hcloud DBSS ListAvailabilityZoneInfos | 查询可用区信息 | |
| 查询实例创建任务信息[待下线] | hcloud DBSS ListAuditInstanceJobs | 查询实例创建任务信息 | |
| 查询数据库列表[待下线] | hcloud DBSS ListAuditDatabases | 查询数据库列表 | |
| 查询用户操作日志信息[待下线] | hcloud DBSS ListAuditOperateLogs | 查询用户操作日志信息 | |
| 查询审计范围策略列表[待下线] | hcloud DBSS ListAuditRuleScopes | 查询审计范围策略列表 | |
| 查询SQL注入规则策略[待下线] | hcloud DBSS ListSqlInjectionRules | 查询SQL注入规则策略 | |
| 查询风险规则策略[待下线] | hcloud DBSS ListAuditRuleRisks | 查询风险规则策略 | |
| 查询指定风险规则策略[待下线] | hcloud DBSS ShowAuditRuleRisk | 查询指定风险规则策略 | |
| 查询隐私数据脱敏规则[待下线] | hcloud DBSS ListAuditSensitiveMasks | 查询隐私数据脱敏规则 | |
| 包年包月计费模式创建审计实例[待下线] | hcloud DBSS CreateInstancesPeriodOrder | 包年包月计费模式创建审计实例 | |
| 修改实例安全组[待下线] | hcloud DBSS UpdateAuditSecurityGroup | 修改实例安全组 | |
| 添加RDS数据库[待下线] | hcloud DBSS AddRdsNoAgentDatabase | 添加RDS数据库。V1版本已不再维护，待下线 | |
| 开启关闭Agent[待下线] | hcloud DBSS SwitchAgent | 用于开启和关闭Agent审计的功能，当开启后，开始抓取用户的访问信息。 | |
| 添加自建数据库[待下线] | hcloud DBSS AddAuditDatabase | 添加自建数据库 | |
| 添加RDS数据库[待下线] | hcloud DBSS AddRdsDatabase | 添加RDS数据库 | |
| 删除数据库[待下线] | hcloud DBSS DeleteAuditDatabase | 删除数据库 | |
| 开启关闭数据库[待下线] | hcloud DBSS SwitchAuditDatabase | 开启关闭数据库 | |
| 删除数据库Agent[待下线] | hcloud DBSS DeleteAuditAgent | 删除数据库Agent | |
| 下载审计Agent[待下线] | hcloud DBSS DownloadAuditAgent | 下载审计Agent | |
| 开启审计实例[待下线] | hcloud DBSS StartAuditInstance | 开启审计实例 | |
| 关闭审计实例[待下线] | hcloud DBSS StopAuditInstance | 关闭审计实例 | |
| 重启审计实例[待下线] | hcloud DBSS RebootAuditInstance | 重启审计实例 | |
| 更新审计实例信息[待下线] | hcloud DBSS UpdateAuditInstance | 更新审计实例信息 | |
| 查询审计告警信息[待下线] | hcloud DBSS ListAuditAlarmLog | 查询审计告警信息 | |
| 查询审计SQL语句[待下线] | hcloud DBSS ListAuditSqls | 查询审计SQL语句 | |
| 查询数据库Agent列表[待下线] | hcloud DBSS ListAuditAgent | 查询数据库Agent列表 | |
| 添加审计数据库Agent[待下线] | hcloud DBSS AddAuditAgent | 添加审计数据库Agent |
审计数据库
| API名称 | 命令 | 描述 | 操作 |
|---|---|---|---|
| 添加自建数据库 | hcloud DBSS AddAuditDatabaseNew | 添加自建数据库 | |
| 查询数据库列表 | hcloud DBSS ListAuditDatabasesNew | 查询数据库列表 | |
| 添加RDS数据库 | hcloud DBSS AddRdsDatabaseNew | 添加RDS数据库 | |
| 查询RDS数据库列表 | hcloud DBSS ListRdsDatabases | 查询RDS数据库列表 | |
| 删除数据库 | hcloud DBSS DeleteAuditDatabaseNew | 删除数据库 | |
| 往OBS导出审计数据库配置 | hcloud DBSS UploadAuditDbConfig | 往OBS导出审计数据库配置 | |
| 上传/更新数据库私钥 | hcloud DBSS AddDatabaseSslKey | 上传/更新数据库私钥 | |
| 开启关闭数据库 | hcloud DBSS SwitchAuditDatabaseNew | 开启关闭数据库 |
