CAM 概述
产品功能
应用场景
基本概念
使用限制
用户类型
| CAM中产品名 | CAM中简称 | 控制台访问 | 按标签授权 | 授权粒度 | IP限制 |
|---|---|---|---|---|---|
| 数据库智能管家 | dbbrain | 支持 | 不支持 | 资源级 | 部分支持 |
Note：
云产品的授权粒度按照粒度粗细分为服务级、操作级和资源级三个级别。
- 服务级：定义对服务的整体是否拥有访问权限，分为允许对服务拥有全部操作权限或者拒绝对服务拥有全部操作权限。服务级授权粒度的云产品，不支持对具体的接口进行授权。
- 操作级：定义对服务的特定接口（API）是否拥有访问权限，例如：授权某账号对云服务器服务进行只读操作。
- 资源级：定义对特定资源是否有访问权限，这是最细的授权粒度，例如：授权某账号仅读写操作某台云服务器实例。能支持资源级接口授权的产品，则会被认定为资源级授权粒度。
接口授权粒度分为资源级和操作级两个级别：
| 接口名 | 接口描述 | 授权粒度 | 资源六段式 | IP限制 |
|---|---|---|---|---|
| AddInstanceToGroup | 添加实例到指定分组 | 操作级 | * | 支持 |
| AddInstancesToSecAuditGroup | 添加实例到安全审计组 | 操作级 | * | 支持 |
| AddUserContact | 添加邮件接收联系人的姓名， 邮件地址 | 操作级 | * | 支持 |
| AddUserGroup | 添加用户组信息 | 操作级 | * | 支持 |
| AttachMySqlInstance | 链接自建 mysql 实例 | 操作级 | * | 支持 |
| AuthUserAccount | 认证用户账号 | 资源级 | qcs::dbbrain:${region}:uin/${uin}:instanceId/${InstanceId} | 支持 |
| BindInstanceWithUserProfile | 将实例和配置绑定 | 操作级 | * | 支持 |
| BindRuleToSecAuditGroup | 绑定规则到安全审计组 | 操作级 | * | 支持 |
| BindSensitiveRule | 绑定实例和敏感数据发现规则 | 资源级 | qcs:id/0:cdb:gz:uin/100000983328:instanceId/cdb-e4qazvd8 | 不支持 |
| CancelAuditLogFile | 取消审计日志文件下载 | 资源级 | qcs::dbbrain:${region}:uin/${uin}:instanceId/${InstanceId} | 支持 |
| CancelBuildIndex | 终止实例索引的创建 | 资源级 | qcs::dbbrain:${region}:uin/${uin}:instanceId/${instanceId} | 支持 |
| CancelDBAutonomyAction | 中止实例自治任务 | 资源级 | qcs::dbbrain:${region}:uin/${uin}:instanceId/${instanceId} | 支持 |
| CancelDBAutonomyEvent | 中止实例自治事件 | 资源级 | qcs::dbbrain:${region}:uin/${uin}:instanceId/${instanceId} | 支持 |
| CancelKillTask | 取消中断会话的任务 | 资源级 | qcs::dbbrain:${region}:uin/${uin}:instanceId/${instanceId} | 支持 |
| CancelRedisBigKeyAnalysisTasks | 终止大Key任务 | 资源级 | qcs::dbbrain::uin/${uin}:instanceId/${instanceId} | 支持 |
| CancelSqlExecution | 取消 sql 执行 | 资源级 | qcs::dbbrain:${region}:uin/${uin}:instanceId/${InstanceId} | 支持 |
| CloseAuditService | 关闭审计 | 资源级 | qcs::dbbrain:${region}:uin/${uin}:instanceId/${instanceId} | 支持 |
| CloseInstanceAuditService | 关闭实例审计服务 | 资源级 | qcs::dbbrain:${region}:uin/${uin}:instanceId/${instanceId} | 支持 |
| CloseInstanceDBbrainFullAuditService | 关闭全链路分析 | 资源级 | qcs::dbbrain:${region}:uin/${uin}:instanceId/${InstanceId} | 支持 |
| ConfirmSqlExecution | 确认 sql 继续执行 | 资源级 | qcs::dbbrain:${region}:uin/${uin}:instanceId/${InstanceId} | 支持 |
| ContinueSqlExecution | 持续执行 sql | 资源级 | qcs::dbbrain:${region}:uin/${uin}:instanceId/${InstanceId} | 支持 |
| CreateAlarmPolicy | 创建告警策略 | 操作级 | * | 支持 |
| CreateAlarmTemplate | 创建用户通知模板 | 操作级 | * | 支持 |
| CreateAuditLogFile | 创建审计日志文件下载任务 | 资源级 | qcs::dbbrain:${region}:uin/${uin}:instanceId/${instanceId} | 支持 |
| CreateAuditLogStatsTask | 创建审计日志分析任务 | 资源级 | qcs:id/0:cdb:gz:uin/100000983328:instanceId/cdb-e4qazvd8 | 支持 |
| CreateCollectionIndex | 创建MongoDB实例集合索引 | 资源级 | qcs::dbbrain:${region}:uin/${uin}:instanceId/${instanceId} | 支持 |
| CreateDBDiagReportTask | 创建健康报告分析任务 | 操作级 | * | 支持 |
| CreateDBDiagReportUrl | 创建异常检测报告 | 操作级 | * | 支持 |
| CreateDBDiagReportUrls | 生成健康报告的url链接 | 操作级 | * | 支持 |
| CreateDesensitizationAlgorithm | 创建数据脱敏算法 | 操作级 | * | 支持 |
| CreateDesensitizationRule | 创建数据脱敏规则 | 操作级 | * | 支持 |
| CreateDesensitizationTask | 创建数据脱敏任务 | 操作级 | * | 支持 |
| CreateDiagInstanceGroup | 创建实例分组 | 操作级 | * | 支持 |
| CreateIgnoreDiagRecord | 开通、关闭诊断类型忽略 | 资源级 | qcs::dbbrain:${region}:uin/${uin}:instanceId/${instanceId} | 支持 |
| CreateInnodbHotUpdateDetectTask | 创建热点更新保护任务 | 资源级 | qcs::dbbrain:${region}:uin/${uin}:instanceId/${InstanceId} | 支持 |
| CreateKillTask | 创建中断会话的任务 | 资源级 | qcs::dbbrain:${region}:uin/${uin}:instanceId/${instanceId} | 支持 |
| CreateKillTasks | 批量创建 kill 任务 | 资源级 | qcs::dbbrain:${region}:uin/${uin}:instanceId/${instanceId} | 支持 |
| CreateMailProfile | 创建邮件配置 | 操作级 | * | 支持 |
| CreateMongoDBKillTask | 创建MongoDB中断会话的任务 | 资源级 | qcs::dbbrain::uin/${uin}:instanceId/${InstanceId} | 支持 |
| CreateNodeComparingTask | 创建多节点性能对比 | 资源级 | qcs::dbbrain:${region}:uin/${uin}:instanceId/${InstanceId} | 支持 |
| CreateProxySessionKillTask | 创建中止所有代理节点连接会话的异步任务。当前仅支持 Redis | 资源级 | qcs::dbbrain:${region}:uin/${uin}:instanceId/${instanceId} | 支持 |
| CreateRedisBigKeyAnalysisTask | 创建redis实例即时大key分析任务。 | 资源级 | qcs::dbbrain:${region}:uin/${uin}:instanceId/${instanceId} | 支持 |
| CreateRiskSqlReportTask | 创建风险sql报告导出任务 | 操作级 | * | 支持 |
| CreateRiskSqlReportUrl | 创建风险报告访问链接 | 操作级 | * | 不支持 |
| CreateRiskSqlTplReportTask | 创建实例风险 sql 模板报告任务 | 资源级 | qcs::dbbrain:${region}:uin/${uin}:instanceId/${instanceId} | 支持 |
| CreateSchedulerMailProfile | 创建定期生成健康报告的邮件发送配置 | 操作级 | * | 支持 |
| CreateSecAuditGroup | 创建安全审计组 | 操作级 | * | 支持 |
| CreateSecAuditRule | 创建安全审计规则 | 操作级 | * | 支持 |
| CreateSecurityAuditLogExportTask | 创建安全审计日志导出任务 | 操作级 | * | 支持 |
| CreateSensitiveRule | 创建敏感数据发现规则 | 操作级 | * | 支持 |
| CreateSensitiveType | 创建敏感数据发现敏感类型 | 操作级 | * | 支持 |
| CreateSqlAnalysisTask | 创建 sql 分析任务 | 资源级 | qcs::dbbrain:${region}:uin/${uin}:instanceId/${InstanceId} | 支持 |
| CreateSqlFilter | 创建实例SQL限流任务。 | 资源级 | qcs::dbbrain:${region}:uin/${uin}:instanceId/${instanceId} | 支持 |
| CreateUserAutonomyProfile | 创建实例自治配置 | 资源级 | qcs::dbbrain:${region}:uin/${uin}:instanceId/${instanceId} | 支持 |
| CreateUserProfile | 创建用户配置 | 操作级 | * | 支持 |
| CreateUserReportUrl | 创建安全审计日志报告访问链接 | 操作级 | * | 支持 |
| CreateUserSession | 创建用户会话 | 资源级 | qcs::dbbrain::uin/${uin}:instanceId/${InstanceId} | 支持 |
| DeleteAlarmPolicy | 删除告警策略 | 操作级 | * | 支持 |
| DeleteAlarmTemplate | 删除通知模板 | 操作级 | * | 支持 |
| DeleteAuditLogFile | 删除审计日志文件 | 资源级 | qcs::dbbrain:${region}:uin/${uin}:instanceId/${instanceId} | 支持 |
| DeleteAuditLogStatsTask | 删除审计日志分析任务 | 资源级 | qcs:id/0:cdb:gz:uin/100000983328:instanceId/cdb-e4qazvd8 | 支持 |
| DeleteBindRulesByRuleIds | 删除绑定到安全组的规则 | 操作级 | * | 支持 |
| DeleteCollectionIndex | 删除MongoDB实例集合索引 | 资源级 | qcs::dbbrain:${region}:uin/${uin}:instanceId/${instanceId} | 支持 |
| DeleteDBDiagReportTasks | 删除健康诊断报告分析任务 | 操作级 | * | 支持 |
| DeleteDesensitizationAlgorithm | 删除数据脱敏算法 | 操作级 | * | 支持 |
| DeleteDesensitizationRule | 删除数据脱敏规则 | 操作级 | * | 支持 |
| DeleteDesensitizationTask | 删除数据脱敏任务 | 操作级 | * | 支持 |
| DeleteDiagInstanceGroup | 删除实例分组 | 操作级 | * | 支持 |
| DeleteInnodbHotUpdateDetectTasks | 删除热点更新保护任务 | 资源级 | qcs::dbbrain:${region}:uin/${uin}:instanceId/${InstanceId} | 支持 |
| DeleteKillTaskRecord | 删除kill会话任务记录 | 资源级 | qcs::dbbrain:${region}:uin/${uin}:instanceId/${instanceId} | 支持 |
| DeleteMailProfile | 删除邮件发送配置 | 操作级 | * | 支持 |
| DeleteRedisBigKeyAnalysisTasks | 删除redis实例即时大key分析任务。 | 资源级 | qcs::dbbrain:${region}:uin/${uin}:instanceId/${instanceId} | 支持 |
| DeleteRiskSqlTplReportTask | 删除风险 sql 模版报告 | 资源级 | qcs::dbbrain:${region}:uin/${uin}:instanceId/${instanceId} | 支持 |
| DeleteSecAuditGroup | 删除安全审计组 | 操作级 | * | 支持 |
| DeleteSecAuditRule | 删除安全审计规则 | 操作级 | * | 支持 |
| DeleteSecurityAuditLogExportTasks | 删除安全审计日志导出任务 | 操作级 | * | 支持 |
| DeleteSensitiveGroup | 删除敏感数据发现敏感类型分组 | 操作级 | * | 不支持 |
| DeleteSensitiveRule | 删除敏感数据发现规则 | 操作级 | * | 不支持 |
| DeleteSensitiveType | 删除敏感数据发现敏感类型 | 操作级 | * | 支持 |
| DeleteSqlFilters | 删除实例SQL限流任务。 | 资源级 | qcs::dbbrain:${region}:uin/${uin}:instanceId/${instanceId} | 支持 |
| DeleteUserContact | 删除用户联系人 | 操作级 | * | 支持 |
| DeleteUserGroup | 删除用户组 | 操作级 | * | 支持 |
| DeleteUserProfile | 删除用户配置 | 操作级 | * | 支持 |
| DeleteUserReportTasks | 删除用户健康报告任务 | 操作级 | * | 支持 |
| DestroyAgent | 销毁自建数据库agent | 操作级 | * | 支持 |
| DestroyInstance | 销毁自建数据库实例 | 操作级 | * | 支持 |
| DestroyUserSession | 销毁用户会话 | 资源级 | qcs::dbbrain:${region}:uin/${uin}:instanceId/${InstanceId} | 支持 |
| ExecuteUserSql | 执行 Sql 语句 | 资源级 | qcs::dbbrain:${region}:uin/${uin}:instanceId/${instanceId} | 支持 |
| KillMongoDBThreads | 终止 mongodb 线程 | 资源级 | qcs::dbbrain:${region}:uin/${uin}:instanceId/${InstanceId} | 支持 |
| KillMySqlThreads | 终止进程 | 资源级 | qcs::dbbrain:${region}:uin/${uin}:instanceId/${instanceId} | 支持 |
| ModifyAlarmPolicy | 修改告警策略 | 操作级 | * | 支持 |
| ModifyAuditService | 修改审计 | 资源级 | qcs::dbbrain:${region}:uin/${uin}:instanceId/${instanceId} | 支持 |
| ModifyDesensitizationAlgorithm | 修改数据脱敏算法 | 操作级 | * | 支持 |
| ModifyDesensitizationRule | 修改数据脱敏规则 | 操作级 | * | 支持 |
| ModifyDesensitizationTask | 修改数据脱敏任务 | 操作级 | * | 支持 |
| ModifyDesensitizationTaskStatus | 修改数据脱敏任务状态 | 操作级 | * | 支持 |
| ModifyDiagDBInstanceConf | 修改实例巡检开关 | 操作级 | * | 支持 |
| ModifyDiagInstanceGroup | 修改实列分组 | 操作级 | * | 支持 |
| ModifyInnodbHotUpdateDetectTasks | 修改热点更新保护任务 | 资源级 | qcs::dbbrain:${region}:uin/${uin}:instanceId/${InstanceId} | 支持 |
| ModifyMailProfile | 修改邮件发送配置 | 操作级 | * | 支持 |
| ModifySecAuditGroup | 修改安全审计组 | 操作级 | * | 支持 |
| ModifySecAuditRule | 修改安全审计规则 | 操作级 | * | 支持 |
| ModifySensitiveRule | 修改敏感数据发现规则 | 操作级 | * | 支持 |
| ModifySensitiveType | 修改敏感数据发现敏感类型 | 操作级 | * | 支持 |
| ModifySqlFilters | 更改实例SQL限流任务状态。 | 资源级 | qcs::dbbrain:${region}:uin/${uin}:instanceId/${instanceId} | 支持 |
| ModifyUserAutonomyProfile | 更新实例自治配置 | 资源级 | qcs::dbbrain:${region}:uin/${uin}:instanceId/${instanceId} | 支持 |
| ModifyUserAutonomyProfileStatus | 修改自治配置状态 | 资源级 | qcs::dbbrain::uin/:instanceId/${instanceId} | 支持 |
| ModifyUserContact | 修改邮件发送联系人信息 | 操作级 | * | 支持 |
| ModifyUserGroup | 修改用户组信息 | 操作级 | * | 支持 |
| ModifyUserProfile | 修改用户配置 | 操作级 | * | 支持 |
| OpenAuditService | 开通审计 | 资源级 | qcs::dbbrain:${region}:uin/${uin}:instanceId/${instanceId} | 支持 |
| OpenInstanceAuditService | 开通实例审计服务 | 资源级 | qcs::dbbrain:${region}:uin/${uin}:instanceId/${instanceId} | 支持 |
| OpenInstanceDBbrainFullAuditService | 开启全链路分析 | 资源级 | qcs::dbbrain:${region}:uin/${uin}:instanceId/${InstanceId} | 支持 |
| OpenMailTemplate | 开启邮件模版配置 | 操作级 | * | 支持 |
| ParseSqlText | SQL 分词转换 | 资源级 | qcs::dbbrain:${region}:uin/${uin}:instanceId/${InstanceId} | 支持 |
| RemoveGroupMember | 移除联系组成员 | 操作级 | * | 支持 |
| RemoveInstancesFromSecAuditGroup | 从安全审计组中移除实例 | 操作级 | * | 支持 |
| ReplicateUserSession | 复制用户会话 | 资源级 | qcs::dbbrain:${region}:uin/${uin}:instanceId/${InstanceId} | 支持 |
| RetryIndexOperationTask | 重试实例索引操作任务 | 资源级 | qcs::dbbrain:${region}:uin/${uin}:instanceId/${instanceId} | 支持 |
| SendMailManually | 手动发送邮件 | 资源级 | qcs::dbbrain:${region}:uin/${uin}:instanceId/${instanceId} | 支持 |
| SyncInst2RiskDashBoard | 同步实例至风险大盘 | 资源级 | qcs::cdb:${region}:uin/${uin}:instanceId/${InstanceId} | 支持 |
| UnbindSensitiveRule | 解绑实例和敏感数据发现规则 | 资源级 | qcs:id/0:cdb:gz:uin/100000983328:instanceId/cdb-e4qazvd8 | 不支持 |
| UpdateAgentSwitch | 更新agent状态（停止或重连Agent） | 操作级 | * | 支持 |
| UpdateDatabaseAutonomyStatus | 更改实例数据库自治状态 | 资源级 | qcs::dbbrain:${region}:uin/${uin}:instanceId/${instanceId} | 支持 |
| UpdateDiagEventStatus | 忽略、取消忽略单个告警 | 资源级 | qcs::dbbrain:${region}:uin/${uin}:instanceId/${instanceId} | 支持 |
| UpdateEventAlarmRecordStatus | 屏蔽、取消屏蔽 | 资源级 | qcs::dbbrain:${region}:uin/${uin}:instanceId/${instanceId} | 支持 |
| UpdateInstanceConfig | 更新自建实例配置 | 操作级 | * | 支持 |
| UpdateInstanceUser | 更改自建数据库用户名密码 | 操作级 | * | 支持 |
| UpdateMonitorSwitch | 更新Agent实例状态（停止或重连实例） | 资源级 | qcs::dbbrain:${region}:uin/${uin}:instanceId/${instanceId} | 支持 |
| UpdateSlowLogSwitch | 更改自建数据库慢日志采集状态 | 操作级 | * | 支持 |
| VerifyUserAccount | 验证用户数据库账号权限。 | 资源级 | qcs::dbbrain:${region}:uin/${uin}:instanceId/${instanceId} | 支持 |
| 接口名 | 接口描述 | 授权粒度 | 资源六段式 | IP限制 |
|---|---|---|---|---|
| DescribeAgentInstances | 查看自建agent实例 | 操作级 | * | 支持 |
| DescribeAgents | 获取自建代理 | 操作级 | * | 支持 |
| DescribeAlarmRules | 获取告警规则 | 操作级 | * | 支持 |
| DescribeDBDiagItem | 获取异常告警项 | 操作级 | * | 支持 |
| DescribeDBDiagItemTimeSeries | 获取异常诊断项数量的时间分布趋势 | 操作级 | * | 支持 |
| DescribeDiagInstanceGroups | 查询实例分组信息 | 操作级 | * | 支持 |
| DescribeDirectInstances | 查看自建直连实例 | 操作级 | * | 支持 |
| DescribeInstanceTopSqls | 获取实例 top sqls | 资源级 | qcs::dbbrain:${region}:uin/${uin}:instanceId/${instanceId} | 支持 |
| DescribeKilledThreadHistory | 获取终止线程的历史记录 | 资源级 | qcs::dbbrain:${region}:uin/${uin}:instanceId/${InstanceId} | 支持 |
| DescribeMailRecord | 获取邮件发送记录 | 操作级 | * | 支持 |
| DescribeMetricStatTopInstances | 获取根据指标排序的实例列表 | 操作级 | * | 支持 |
| DescribeMetricTopInstances | 获取根据指标类型排名的实例列表 | 操作级 | * | 支持 |
| DescribeNodeComparingTask | 查询多节点对比任务列表 | 资源级 | qcs::dbbrain:${region}:uin/${uin}:instanceId/${InstanceId} | 支持 |
| DescribeRiskInstances | 获取风险实例详情 | 操作级 | * | 支持 |
| DescribeRiskProducts | 获取风险实例大盘 | 操作级 | * | 支持 |
| DescribeTopHealthScoreAvg | 获取实例健康得分排行列表 | 操作级 | * | 支持 |
| DescribeUserContact | 获取用户联系人列表 | 操作级 | * | 支持 |
| DescribeUserGroup | 获取用户联系组 | 操作级 | * | 支持 |
| 接口名 | 接口描述 | 授权粒度 | 资源六段式 | IP限制 |
|---|---|---|---|---|
| DescribeAgentServicePorts | 查看 agent 服务端口 | 操作级 | * | 支持 |
| DescribeAlarmPolicy | 查看告警策略 | 操作级 | * | 支持 |
| DescribeAlarmTemplate | 用户通知模板列表 | 操作级 | * | 支持 |
| DescribeAlarmTemplateView | 用户通知模板查看视图 | 操作级 | * | 支持 |
| DescribeAllNodeComparingResult | 获取多节点对比结果 | 资源级 | qcs::dbbrain:${region}:uin/${uin}:instanceId/${InstanceId} | 支持 |
| DescribeAllUserContact | 获取邮件发送中联系人的相关信息 | 操作级 | * | 支持 |
| DescribeAllUserGroup | 获取邮件发送联系组的相关信息 | 操作级 | * | 支持 |
| DescribeAuditInstanceList | 从业务中台查询实例列表 | 操作级 | * | 支持 |
| DescribeAuditLogDimensionValues | 获取审计日志维度值 | 资源级 | qcs::dbbrain:${region}:uin/${uin}:instanceId/${InstanceId} | 支持 |
| DescribeAuditLogFiles | 查询审计日志文件 | 资源级 | qcs::dbbrain:${region}:uin/${uin}:instanceId/${instanceId} | 支持 |
| DescribeAuditLogMetricRatio | 获取给定任务的维度耗时比例 | 资源级 | qcs:id/0:cdb:gz:uin/100000983328:instanceId/cdb-e4qazvd8 | 不支持 |
| DescribeAuditLogSeries | cdb审计指标趋势图 | 资源级 | qcs::dbbrain:${region}:uin/${uin}:instanceId/${instanceId} | 支持 |
| DescribeAuditLogSeriesForSqlTime | 获取给定任务的时间轴统计图表数据 | 资源级 | qcs:id/0:cdb:gz:uin/100000983328:instanceId/cdb-e4qazvd8 | 支持 |
| DescribeAuditLogStatsTasks | 获取当前任务列表 | 资源级 | qcs:id/0:cdb:gz:uin/100000983328:instanceId/cdb-e4qazvd8 | 支持 |
| DescribeAuditLogTopSqls | 获取给定任务的Top SQL | 资源级 | qcs:id/0:cdb:gz:uin/100000983328:instanceId/cdb-e4qazvd8 | 支持 |
| DescribeAuditLogs | 查询审计日志 | 资源级 | qcs::dbbrain:${region}:uin/${uin}:instanceId/${instanceId} | 支持 |
| DescribeBindRulesByGroupId | 根据安全组id查询绑定的规则列表 | 操作级 | * | 支持 |
| DescribeCloudInstances | 获取云实例信息 | 操作级 | * | 支持 |
| DescribeCollectionIndexInfo | 查询MongoDB实例集合索引 | 资源级 | qcs::dbbrain:${region}:uin/${uin}:instanceId/${instanceId} | 支持 |
| DescribeDBAutonomyAction | 获取实例自治任务详情 | 资源级 | qcs::dbbrain:${region}:uin/${uin}:instanceId/${instanceId} | 支持 |
| DescribeDBAutonomyActionHistory | 获取实例自治任务历史 | 资源级 | qcs::dbbrain:${region}:uin/${uin}:instanceId/${instanceId} | 支持 |
| DescribeDBAutonomyActions | 获取实例自治任务列表 | 资源级 | qcs::dbbrain:${region}:uin/${uin}:instanceId/${instanceId} | 支持 |
| DescribeDBAutonomyEvents | 获取自治事件列表 | 资源级 | qcs::dbbrain:${region}:uin/${uin}:instanceId/${instanceId} | 支持 |
| DescribeDBDiagEvent | 获取诊断事件详情 | 操作级 | * | 支持 |
| DescribeDBDiagEvents | 获取指定时间段内的诊断事件列表，支持依据风险等级、实例ID等条件过滤。 | 操作级 | * | 不支持 |
| DescribeDBDiagHistory | 获取实例诊断历史 | 操作级 | * | 支持 |
| DescribeDBDiagItemInstanceStatistics | 获取实例告警数分布 | 资源级 | qcs::dbbrain:${region}:uin/${uin}:instanceId/${InstanceId} | 支持 |
| DescribeDBDiagItemOverview | 获取异常告警概览 | 操作级 | * | 不支持 |
| DescribeDBDiagItemStatistics | 描述数据库诊断项统计信息 | 操作级 | * | 支持 |
| DescribeDBDiagItemTopInstances | 获取数据库诊断项top实例 | 操作级 | * | 支持 |
| DescribeDBDiagReport | 查询健康诊断报告 | 资源级 | qcs:id/0:cdb:gz:uin/100000983328:instanceId/cdb-e4qazvd8 | 支持 |
| DescribeDBDiagReportContent | 查询健康诊断报告内容 | 资源级 | qcs::dbbrain::uin/${uin}:instanceId/${instanceId} | 支持 |
| DescribeDBDiagReportTasks | 查询健康报告生成任务列表 | 操作级 | * | 支持 |
| DescribeDBPerfTimeSeries | 获取实例性能曲线数据。 | 资源级 | qcs::dbbrain::uin/${uin}:instanceId/${instanceId} | 支持 |
| DescribeDBSpaceStatus | 获取给定时间段空间使用概览 | 操作级 | * | 支持 |
| DescribeDailyReport | 获取日报 | 操作级 | * | 不支持 |
| DescribeDailyReportSubscribes | 获取日报订阅信息 | 操作级 | * | 支持 |
| DescribeDatabaseAutonomyStatus | 查询实例数据库自治状态 | 资源级 | qcs::dbbrain:${region}:uin/${uin}:instanceId/${instanceId} | 支持 |
| DescribeDatabaseObject | 查询实例数据库表 | 资源级 | qcs::dbbrain:${region}:uin/${uin}:instanceId/${instanceId} | 支持 |
| DescribeDeadLockTrxSqls | 查询死锁的事物sql列表 | 资源级 | qcs::dbbrain:${region}:uin/${uin}:instanceId/${InstanceId} | 支持 |
| DescribeDeployAgentCommand | 查看部署 agent 命令 | 操作级 | * | 支持 |
| DescribeDiagDBInstanceNodes | 查看实例详情 | 操作级 | * | 支持 |
| DescribeDiagDBInstances | 获取实例信息列表 | 操作级 | * | 不支持 |
| DescribeEventAlarmHistory | 查询事件历史列表 | 资源级 | qcs::dbbrain:${region}:uin/${uin}:instanceId/${instanceId} | 支持 |
| DescribeEventAlarmOperate | 查询屏蔽历史列表 | 资源级 | qcs::dbbrain:${region}:uin/${uin}:instanceId/${instanceId} | 支持 |
| DescribeHealthScore | 获取健康打分详情 | 操作级 | * | 支持 |
| DescribeHealthScoreAndLevel | 根据实例ID获取实时健康分、指定时间段最低健康得分以及性能维度健康得分、等级。 | 资源级 | qcs::dbbrain:${region}:uin/${uin}:instanceId/${instanceId} | 支持 |
| DescribeHealthScoreTimeSeries | 获取健康打分趋势 | 资源级 | qcs::dbbrain::uin/${uin}:instanceId/${InstanceId} | 支持 |
| DescribeIgnoreDiagRecord | 查询已忽略的诊断类型 | 资源级 | qcs::dbbrain:${region}:uin/${uin}:instanceId/${instanceId} | 支持 |
| DescribeIndexBuildProgress | 查询实例索引创建进度 | 资源级 | qcs::dbbrain:${region}:uin/${uin}:instanceId/${instanceId} | 支持 |
| DescribeIndexRecommendAggregationSlowLogs | 查询实例推荐索引相关慢日志聚合结果 | 资源级 | qcs::dbbrain:${region}:uin/${uin}:instanceId/${instanceId} | 支持 |
| DescribeIndexRecommendInfo | 查询实例推荐索引信息 | 资源级 | qcs::dbbrain:${region}:uin/${uin}:instanceId/${instanceId} | 支持 |
| DescribeIndexRecommendSlowLogs | 查询实例推荐索引相关慢日志 | 资源级 | qcs::dbbrain:${region}:uin/${uin}:instanceId/${instanceId} | 支持 |
| DescribeInnodbHotUpdateDetectTasks | 查询实例热点更新保护任务 | 资源级 | qcs::dbbrain:${region}:uin/${uin}:instanceId/${instanceId} | 支持 |
| DescribeInstanceAuditService | 查询实例审计服务状态 | 资源级 | qcs::dbbrain:${region}:uin/${uin}:instanceId/${instanceId} | 支持 |
| DescribeInstanceBusinessTag | 获取标签数据 | 操作级 | * | 支持 |
| DescribeInstanceDBDiagOverview | 获取实例异常诊断概览 | 资源级 | qcs::dbbrain:${region}:uin/${uin}:instanceId/${InstanceId} | 支持 |
| DescribeInstanceDBNodes | 获取实例节点列表 | 资源级 | qcs::dbbrain:${region}:uin/${uin}:instanceId/${instanceId} | 支持 |
| DescribeInstanceLatestDBDiagItem | 获取实例最新诊断信息 | 资源级 | qcs::dbbrain:${region}:uin/${uin}:instanceId/${InstanceId} | 支持 |
| DescribeInstanceProxyList | 获取实例proxy列表 | 资源级 | qcs::dbbrain:${region}:uin/${uin}:instanceId/${instanceId} | 支持 |
| DescribeInstanceStateTimeSeries | 获取实例风险趋势图 风险/健康 | 操作级 | * | 支持 |
| DescribeInstanceStatistics | 查看自建接入概览 | 操作级 | * | 支持 |
| DescribeInstancesPerfTimeSeries | 获取实例性能指标时间分布 | 操作级 | * | 支持 |
| DescribeKillTask | 获取终止会话任务的详细信息 | 资源级 | qcs::dbbrain:${region}:uin/${uin}:instanceId/${instanceId} | 支持 |
| DescribeKillTaskRecord | 查询kill会话任务列表 | 资源级 | qcs::dbbrain:${region}:uin/${uin}:instanceId/${instanceId} | 支持 |
| DescribeMailProfile | 获取发送邮件的配置 | 操作级 | * | 支持 |
| DescribeMetricStatTopSecAuditGroups | 查询安全组的风险分布 | 操作级 | * | 支持 |
| DescribeMetricTopProxies | 获取实例指标top proxy列表 | 资源级 | qcs::dbbrain:${region}:uin/${uin}:instanceId/${InstanceId} | 支持 |
| DescribeMongoDBProcessList | 查询MongoDB实时会话列表 | 资源级 | qcs::mongodb:${region}:uin/${uin}:instanceId/${InstanceId} | 支持 |
| DescribeMongoDBSlowLogTopSqlList | 获取MongoDB慢sql模版列表 | 资源级 | qcs::dbbrain::uin/${uin}:instanceId/${InstanceId} | 支持 |
| DescribeMongoStatus | 获取MongoDB实例mongostat检测状态 | 资源级 | qcs::dbbrain:${region}:uin/${uin}:instanceId/${instanceId} | 支持 |
| DescribeMongoTop | 获取MongoDB实例mongotop检测状态 | 资源级 | qcs::dbbrain:${region}:uin/${uin}:instanceId/${instanceId} | 支持 |
| DescribeMonitorSnapshot | 获取实例当前监控快照 | 资源级 | qcs::dbbrain:${region}:uin/${uin}:instanceId/${instanceId} | 支持 |
| DescribeMySqlProcessList | 查询关系型数据库的实时线程列表。 | 资源级 | qcs::dbbrain:${region}:uin/${uin}:instanceId/${InstanceId} | 支持 |
| DescribeNoPrimaryKeyTables | 查询实例无主键表列表。 | 资源级 | qcs::dbbrain:${region}:uin/${uin}:instanceId/${instanceId} | 支持 |
| DescribeOperationHistory | 查询实例数据库操作历史记录 | 资源级 | qcs::dbbrain:${region}:uin/${uin}:instanceId/${instanceId} | 支持 |
| DescribeOptimizedHistory | 查询实例优化历史记录 | 资源级 | qcs::dbbrain:${region}:uin/${uin}:instanceId/${instanceId} | 支持 |
| DescribePrivilegeGrantCommand | 查看自建数据库授权命令 | 操作级 | * | 支持 |
| DescribeProcessList | 获取Processlist | 资源级 | qcs:id/0:cdb:gz:uin/100000983328:instanceId/cdb-e4qazvd8 | 支持 |
| DescribeProxyAggregationSeries | redis全局-单实例proxy节点展示 | 资源级 | qcs::dbbrain:${region}:uin/${uin}:instanceId/${instanceId} | 支持 |
| DescribeProxyProcessStatistics | 获取实例proxy会话统计 | 资源级 | qcs::dbbrain:${region}:uin/${uin}:instanceId/${instanceId} | 支持 |
| DescribeProxySessionKillTasks | 用于查询 redis 执行 kill 会话任务后代理节点的执行结果，入参异步任务 ID 从接口 CreateProxySessionKillTask 调用成功后取得。当前 product 只支持：redis。 | 资源级 | qcs::dbbrain:${region}:uin/${uin}:instanceId/${instanceId} | 支持 |
| DescribeRedisBigKeyAnalysisTasks | 获取redis实例大key分析任务列表 | 资源级 | qcs::dbbrain:${region}:uin/${uin}:instanceId/${instanceId} | 支持 |
| DescribeRedisCmdPerfTimeSeries | 获取redis实例命令延迟趋势 | 资源级 | qcs::dbbrain:${region}:uin/${uin}:instanceId/${instanceId} | 支持 |
| DescribeRedisCommandCostStatistics | 获取redis实例命令延迟分布统计 | 资源级 | qcs::dbbrain:${region}:uin/${uin}:instanceId/${instanceId} | 支持 |
| DescribeRedisCommandOverview | 获取redis实例访问命令统计 | 资源级 | qcs::dbbrain:${region}:uin/${uin}:instanceId/${instanceId} | 支持 |
| DescribeRedisProcessList | 获取Redis实例proxy实时会话列表。 | 资源级 | qcs::dbbrain:${region}:uin/${uin}:instanceId/${instanceId} | 支持 |
| DescribeRedisProxyAttributes | 获取 redis 代理特性 | 资源级 | qcs::redis:${region}:uin/${uin}:instanceId/${InstanceId} | 支持 |
| DescribeRedisSlowLogTopSqls | 获取redis慢SQL模板列表 | 资源级 | qcs::dbbrain::uin/${uin}:instanceId/${instanceId} | 支持 |
| DescribeRedisTopBigKeys | 查询redis实例大key列表。 | 资源级 | qcs::dbbrain:${region}:uin/${uin}:instanceId/${instanceId} | 支持 |
| DescribeRedisTopCostCommands | 获取redis实例top耗时命令 | 资源级 | qcs::dbbrain:${region}:uin/${uin}:instanceId/${instanceId} | 支持 |
| DescribeRedisTopHotKeys | 获取redis top热key | 资源级 | qcs::dbbrain:${region}:uin/${uin}:instanceId/${instanceId} | 支持 |
| DescribeRedisTopKeyPrefixList | 查询redis实例top key前缀列表 | 资源级 | qcs::dbbrain:${region}:uin/${uin}:instanceId/${instanceId} | 支持 |
| DescribeRedisUnExpiredKeyStatistics | 查询 redis key 过期时间分布 | 资源级 | qcs::dbbrain::uin/:instanceId/${InstanceId} | 支持 |
| DescribeRiskHistory | 获取实例风险历史 | 资源级 | qcs::dbbrain:${region}:uin/${uin}:instanceId/${instanceId} | 支持 |
| DescribeRiskSqlReport | 查看风险 sql 报告 | 操作级 | * | 不支持 |
| DescribeRiskSqlReportTasks | 查看风险 sql 报告任务 | 操作级 | * | 支持 |
| DescribeRiskSqlTimeSeries | 获取风险 SQL 模版问题分布图 | 操作级 | * | 支持 |
| DescribeRiskSqlTplReportTask | 获取风险 sql 模板报告任务 | 操作级 | * | 支持 |
| DescribeRiskTplTrendTimeSeries | 获取实例风险模版变化趋势 | 操作级 | * | 支持 |
| DescribeSecAuditGroups | 查询安全审计组列表 | 操作级 | * | 支持 |
| DescribeSecAuditInstances | 查询安全审计实列列表 | 操作级 | * | 支持 |
| DescribeSecAuditRules | 查看安全审计日志规则 | 操作级 | * | 支持 |
| DescribeSecurityAuditLogDownloadUrls | 查询安全审计日志导出文件下载链接目前日志文件下载仅提供腾讯云内网地址，请通过广州地域 | 操作级 | * | 支持 |
| DescribeSecurityAuditLogExportTasks | 查询安全审计日志导出任务 | 操作级 | * | 支持 |
| DescribeSensitiveDetectResult | 获取敏感数据发现结果 | 资源级 | qcs:id/0:cdb:gz:uin/100000983328:instanceId/cdb-e4qazvd8 | 不支持 |
| DescribeSlowLogQueryTimeStats | 获取慢日志分段耗时统计 | 资源级 | qcs::dbbrain::uin/${uin}:instanceId/${instanceId} | 支持 |
| DescribeSlowLogTimeSeriesStats | 获取慢日志柱状图统计 | 资源级 | qcs::dbbrain::uin/${uin}:instanceId/${instanceId} | 支持 |
| DescribeSlowLogTopProxyTimeSeries | 获取实例慢日志top proxy趋势图 | 资源级 | qcs::dbbrain:${region}:uin/${uin}:instanceId/${instanceId} | 支持 |
| DescribeSlowLogTopSqls | 获取慢日志TopSql列表。 | 资源级 | qcs::dbbrain::uin/${uin}:instanceId/${instanceId} | 不支持 |
| DescribeSlowLogUserHostStats | 获取慢日志来源地址统计分布图。 | 资源级 | qcs::dbbrain:${region}:uin/${uin}:instanceId/${instanceId} | 支持 |
| DescribeSlowLogs | 查询慢日志明细。 | 资源级 | qcs::dbbrain:${region}:uin/${uin}:instanceId/${instanceId} | 支持 |
| DescribeSqlAdvice | 创建审计日志分析任务 | 资源级 | qcs:id/0:cdb:gz:uin/100000983328:instanceId/cdb-e4qazvd8 | 支持 |
| DescribeSqlAnalysisStatus | 获取 sql 分析状态 | 资源级 | qcs::dbbrain:${region}:uin/${uin}:instanceId/${InstanceId} | 支持 |
| DescribeSqlExplain | 获取SQL执行计划 | 资源级 | qcs:id/0:cdb:gz:uin/100000983328:instanceId/cdb-e4qazvd8 | 支持 |
| DescribeSqlFilters | 查询实例SQL限流任务列表。 | 资源级 | qcs::dbbrain:${region}:uin/${uin}:instanceId/${instanceId} | 支持 |
| DescribeSqlTemplate | 查询SQL语句的模版。 | 资源级 | qcs::dbbrain:${region}:uin/${uin}:instanceId/${instanceId} | 支持 |
| DescribeSqlTemplateDetail | 获取 SQL 模版详情 | 资源级 | qcs::dbbrain:${region}:uin/${uin}:instanceId/${InstanceId} | 支持 |
| DescribeTXSQLIndexAdvice | 获取txsql内核对单条SQL的索引推荐 | 资源级 | qcs::dbbrain:${region}:uin/${uin}:instanceId/${InstanceId} | 不支持 |
| DescribeTableDDLDataRefreshTasks | 手动刷新表数据 | 资源级 | qcs::dbbrain:${region}:uin/${uin}:instanceId/${InstanceId} | 支持 |
| DescribeTableSpaceData | 查询实例库表的空间数据 | 资源级 | qcs::dbbrain:${region}:uin/${uin}:instanceId/${instanceId} | 支持 |
| DescribeTableSpaceDataRefreshTasks | 刷新实例表空间分析数据 | 资源级 | qcs::dbbrain:${region}:uin/${uin}:instanceId/${InstanceId} | 支持 |
| DescribeTableSpaceTimeSeries | 查询实例库表空间数据趋势 | 资源级 | qcs::dbbrain:${region}:uin/${uin}:instanceId/${instanceId} | 支持 |
| DescribeTopSpaceSchemaLatestRecords | 获取Top库最新定时采集的空间数据 | 资源级 | qcs:id/0:cdb:gz:uin/100000983328:instanceId/cdb-e4qazvd8 | 支持 |
| DescribeTopSpaceSchemaTimeSeries | 获取Top库在指定时间段内的每日空间统计信息 | 操作级 | * | 支持 |
| DescribeTopSpaceSchemas | 获取实例Top库的实时空间统计信息，默认返回按大小排序。 | 资源级 | qcs::dbbrain:${region}:uin/${uin}:instanceId/${instanceId} | 支持 |
| DescribeTopSpaceTableLatestRecords | 获取Top表最新定时采集的空间数据 | 资源级 | qcs:id/0:cdb:gz:uin/100000983328:instanceId/cdb-e4qazvd8 | 支持 |
| DescribeTopSpaceTableTimeSeries | 获取Top表在指定时间段内的每日空间统计信息 | 操作级 | * | 支持 |
| DescribeTopSpaceTables | 获取Top表的统计信息 | 操作级 | * | 支持 |
| DescribeUserAutonomyProfile | 查询实例自治配置 | 资源级 | qcs::dbbrain:${region}:uin/${uin}:instanceId/${instanceId} | 支持 |
| DescribeUserAutonomyProfileList | 查询自治配置列表 | 操作级 | * | 支持 |
| DescribeUserLatestDBDiagItem | 获取用户最新异常诊断数据 | 操作级 | * | 不支持 |
| DescribeUserPrivilege | 获取用户权限 | 资源级 | qcs::dbbrain:${region}:uin/${uin}:instanceId/${InstanceId} | 支持 |
| DescribeUserProfile | 获取用户配置 | 操作级 | * | 支持 |
| DescribeUserReport | 查看安全审计报告 | 操作级 | * | 支持 |
| DescribeUserReportTasks | 查询用户安全审计报告任务列表 | 操作级 | * | 支持 |
| DescribeUserSessionStatus | 获取用户会话状态 | 资源级 | qcs::dbbrain:${region}:uin/${uin}:instanceId/${InstanceId} | 支持 |
| DescribeUserSessions | 描述用户会话 | 资源级 | qcs::dbbrain:${region}:uin/${uin}:instanceId/${InstanceId} | 支持 |
| DescribeUserSqlAdvice | 获取SQL优化建议。 | 资源级 | qcs::dbbrain:${region}:uin/${uin}:instanceId/${instanceId} | 支持 |
| DescribeUserSqlHistory | 获取中止会话的历史记录 | 资源级 | qcs::dbbrain:${region}:uin/${uin}:instanceId/${instanceId} | 支持 |
| 接口名 | 接口描述 | 授权粒度 | 资源六段式 | IP限制 |
|---|---|---|---|---|
| DescribePrettySql | 格式化 SQL | 资源级 | qcs::dbbrain::uin/${uin}:instanceId/${InstanceId} | 支持 |
| FeedbackAnalysisResult | 反馈分析结果 | 资源级 | qcs::dbbrain:${region}:uin/${uin}:instanceId/${InstanceId} | 不支持 |
| KillPostgreSQLThreads | 中断Postgres的会话 | 资源级 | qcs::postgres:${region}:uin/${uin}:instance/${InstanceId} | 支持 |
| PrepareAgent | 准备自建数据库实例代理 | 操作级 | * | 支持 |
| TakeOverUserSession | 接管用户会话 | 资源级 | qcs::dbbrain:${region}:uin/${uin}:instanceId/${InstanceId} | 不支持 |
文档反馈