基本信息
| CAM中产品名 | CAM中简称 | 控制台访问 | 按标签授权 | 授权粒度 | IP限制 |
|---|---|---|---|---|---|
| 云数据库 MySQL | cdb | 支持 | 支持 | 资源级 | 部分支持 |
说明：云产品的授权粒度按照粒度粗细分为服务级、操作级和资源级三个级别。
- 服务级：定义对服务的整体是否拥有访问权限，分为允许对服务拥有全部操作权限或者拒绝对服务拥有全部操作权限。服务级授权粒度的云产品，不支持对具体的接口进行授权。
- 操作级：定义对服务的特定接口（API）是否拥有访问权限，例如：授权某账号对云服务器服务进行只读操作。
- 资源级：定义对特定资源是否有访问权限，这是最细的授权粒度，例如：授权某账号仅读写操作某台云服务器实例。能支持资源级接口授权的产品，则会被认定为资源级授权粒度。
接口授权粒度
接口授权粒度分为资源级和操作级两个级别：
- 资源级接口：此类型接口支持对某一个具体特定的资源进行授权。
- 操作级接口：此类型接口不支持对某一个特定的资源进行授权。授权时策略语法若限定了具体的资源，CAM会判断此接口不在授权范围，判断为无权限。
写操作
| 接口名 | 接口描述 | 授权粒度 | 资源六段式 | IP限制 |
|---|---|---|---|---|
| AddInstanceInDeployGroup | 新增实例部署组 | 资源级 | qcs::cdb:$region:$account:instanceId/$instanceId | 支持 |
| AddPartSqlFile | ql大文件上传-保存分片信息 | 操作级 | * | 不支持 |
| AddTimeWindow | 为云数据库实例添加维护时间窗 | 资源级 | qcs::cdb:$region:$account:instanceId/$instanceId | 支持 |
| AddTimeWindowSwitchForZone | 该接口添加的地区，用户主动发起的时间窗内切换的任务全都失效，不进行切换 | 操作级 | * | 支持 |
| AdjustCdbProxy | 调整数据库代理 | 资源级 | qcs::cdb:${region}:uin/${uin}:instanceId/${instanceId} | 支持 |
| AdjustCdbProxyAddress | 调整数据库代理地址 | 操作级 | * | 支持 |
| AssociateSecurityGroups | 批量绑定安全组 | 资源级 | qcs::cdb:$region:$account:instanceId/$instanceId | 不支持 |
| BalanceRoGroupLoad | 均衡Ro组内的负载 | 操作级 | * | 支持 |
| BatchUpgradeDBInstance | 本接口(BatchUpgradeDBInstance)用于批量升级或降级云数据库实例的配置，实例类型支持主实例、灾备实例和只读实例。 | 资源级 | qcs::cdb:${region}:uin/${uin}:instanceId/${instanceId} | 支持 |
| CancelBatchOperation | 停止批量导入任务 | 操作级 | * | 支持 |
| CancelDBInstanceTask | 取消任务 | 资源级 | qcs::cdb:$region:$account:instanceId/$instanceId | 不支持 |
| ClearInstanceAuditPolicy | 清理实例审计策略 | 操作级 | * | 不支持 |
| CloseAuditService | 实例关闭审计服务 | 资源级 | qcs::cdb:${region}:uin/${uin}:instanceId/${InstanceId} | 支持 |
| CloseCDBProxy | 关闭数据库代理 | 操作级 | * | 支持 |
| CloseCdbProxyAddress | 关闭数据库代理地址 | 操作级 | * | 支持 |
| CloseDBInstanceAudit | 关闭实例审计 | 操作级 | * | 不支持 |
| CloseTransparentSlaveAccess | 本接口（CloseTransparentSlaveAccess）用于关闭透明备机只读。 | 操作级 | * | 支持 |
| CloseWanService | 关闭实例外网访问 | 资源级 | qcs::cdb:$region:$account:instanceId/$instanceId | 支持 |
| ConfigDataComparisonJob | 数据对比任务 | 操作级 | * | 不支持 |
| CreateAccounts | 创建云数据库的账户 | 资源级 | qcs::cdb:$region:$account:instanceId/$instanceId | 支持 |
| CreateAuditLogFile | 创建实例审计日志文件 | 资源级 | qcs::cdb:$region:$account:instanceId/$instanceId | 支持 |
| CreateAuditPolicy | 创建实例审计策略 | 资源级 | qcs::cdb:$region:$account:instanceId/$instanceId | 支持 |
| CreateAuditRule | 创建审计规则 | 操作级 | * | 不支持 |
| CreateAuditRuleTemplate | 创建审计规则模板 | 操作级 | * | 支持 |
| CreateBackup | 创建云数据库备份 | 资源级 | qcs::cdb:$region:$account:instanceId/$instanceId | 支持 |
| CreateBatchJobFiles | 批量导入-批量上传SQL文件 | 操作级 | * | 支持 |
| CreateCdbProxy | 创建数据库代理 | 操作级 | * | 支持 |
| CreateCdbProxyAddress | 创建数据库代理地址 | 操作级 | * | 支持 |
| CreateCloneInstance | 创建克隆实例 | 资源级 | qcs::cdb:$region:$account:instanceId/$instanceId | 不支持 |
| CreateDBImportJob | 创建数据导入任务 | 资源级 | qcs::cdb:$region:$account:instanceId/$instanceId | 支持 |
| CreateDBInstance | 创建云数据库实例 | 操作级 | * | 不支持 |
| CreateDBInstanceHour | 创建云数据库按量计费实例 | 操作级 | * | 不支持 |
| CreateDatabase | 创建数据库 | 资源级 | qcs::cdb:${region}:uin/${uin}:instanceId/${instanceId} | 支持 |
| CreateDeployGroup | 创建组 | 操作级 | * | 支持 |
| CreateMigrateJob | 创建迁移任务 | 操作级 | * | 支持 |
| CreateMonitorTemplate | 监控模板创建监控项 | 操作级 | * | 支持 |
| CreateParamTemplate | 创建参数模板 | 操作级 | * | 支持 |
| CreateRoInstanceIp | ro示例绑定独立vip | 资源级 | qcs::cdb:$region:$account:instanceId/$instanceId | 支持 |
| DeleteAccounts | 删除云数据库的账号 | 资源级 | qcs::cdb:$region:$account:instanceId/$instanceId | 支持 |
| DeleteAuditLogFile | 删除实例审计日志文件 | 资源级 | qcs::cdb:$region:$account:instanceId/$instanceId | 支持 |
| DeleteAuditPolicy | 删除实例审计策略 | 资源级 | qcs::cdb:$region:$account:instanceId/$instanceId | 支持 |
| DeleteAuditRule | 删除审计策略 | 操作级 | * | 不支持 |
| DeleteAuditRuleTemplates | 删除审计规则模板 | 操作级 | * | 支持 |
| DeleteBackup | 删除云数据库备份 | 资源级 | qcs::cdb:$region:$account:instanceId/$instanceId | 支持 |
| DeleteBackups | 批量删除云数据库备份 | 操作级 | * | 支持 |
| DeleteBatchJobFiles | 批量导入 - 删除用户提交的SQL文件列表 | 操作级 | * | 支持 |
| DeleteDatabase | 删除数据库 | 资源级 | qcs::cdb:${region}:uin/${uin}:instanceId/${instanceId} | 支持 |
| DeleteDeployGroups | 删除组 | 操作级 | * | 支持 |
| DeleteInstanceFromDeployGroup | 删除实例部署组 | 资源级 | qcs::cdb:$region:$account:instanceId/$instanceId | 支持 |
| DeleteMonitorTemplate | 监控模板删除监控项 | 操作级 | * | 支持 |
| DeleteParamTemplate | 删除参数模板 | 操作级 | * | 支持 |
| DeleteReadOnlyInstanceIp | 本接口(DeleteReadOnlyInstanceIp)删除云数据库只读实例的独立VIP。 | 操作级 | * | 不支持 |
| DeleteTableSmoothly | 平滑删除数据表。操作步骤：需要分为三步1.用户调用该接口，建立表的硬链接2.用户手动drop表3.用户调用该接口，异步地truncate文件 | 资源级 | qcs::cdb:${region}:uin/${uin}:instanceId/${instanceId} | 支持 |
| DeleteTimeWindow | 删除与云数据库实例相关的时间窗口 | 资源级 | qcs::cdb:$region:$account:instanceId/$instanceId | 支持 |
| DeleteTimeWindowSwitchForZone | 该接口删除了的地区，之后该地区用户主动发起的时间窗内切换的任务不会失效，恢复正常逻辑，任务时间窗内便会进行切换 | 操作级 | * | 支持 |
| DisassociateSecurityGroups | 安全组批量解绑 | 资源级 | qcs::cdb:$region:$account:instanceId/$instanceId | 不支持 |
| DropDatabaseTables | 删除云数据库的库或者表 | 资源级 | qcs::cdb:$region:$account:instanceId/$instanceId | 支持 |
| EndReservedRollbackInstance | 结束版本升级支持回滚的状态。结束后，当前实例版本为5.7，不再支持回滚到5.6版本。 | 资源级 | qcs::cdb:${region}:uin/${uin}:instanceId/${instanceId} | 支持 |
| InitDBInstances | 初始化云数据库 | 资源级 | qcs::cdb:$region:$account:instanceId/$instanceId | 支持 |
| IsolateDBInstance | 隔离云数据库实例 | 资源级 | qcs::cdb:$region:$account:instanceId/$instanceId | 不支持 |
| IsolateDBInstances | 实例需要先通过DescribeInstancesReturnable接口判断是否可退。对于按量计费的实例，直接销毁。对于包年包月的实例，退还实例并且部分退费，具体退费金额由计费控制。实例销毁后会进入回收站，可以续费恢复。 | 资源级 | qcs::cdb:${region}:uin/${uin}:instanceId/${instanceId} | 支持 |
| KillDBProcessByIds | 终止云数据库的执行线程 | 资源级 | qcs::cdb:$region:$account:instanceId/$instanceId | 不支持 |
| ModifyAccountDescription | 修改云数据库实例账号的备注信息 | 资源级 | qcs::cdb:$region:$account:instanceId/$instanceId | 支持 |
| ModifyAccountHost | 本接口(ModifyAccountHost)用于修改云数据库账户的主机。 | 资源级 | qcs::cdb:${region}:uin/${uin}:instanceId/$instanceId | 支持 |
| ModifyAccountMaxUserConnections | 修改云数据库账户最大可用连接数 | 资源级 | qcs::cdb:$region:$account:instanceId/$instanceId | 支持 |
| ModifyAccountPassword | 修改云数据库实例账号的密码 | 资源级 | qcs::cdb:$region:$account:instanceId/$instanceId | 支持 |
| ModifyAccountPrivileges | 修改云数据库实例账号的权限 | 资源级 | qcs::cdb:$region:$account:instanceId/$instanceId | 支持 |
| ModifyAuditConfig | 修改实例审计配置 | 资源级 | qcs::cdb:$region:$account:instanceId/$instanceId | 支持 |
| ModifyAuditPolicy | 修改审计策略 | 操作级 | * | 不支持 |
| ModifyAuditRule | 修改审计规则 | 操作级 | * | 不支持 |
| ModifyAuditRuleTemplates | 修改审计规则模板 | 操作级 | * | 支持 |
| ModifyAuditService | 本接口(ModifyAuditService)用于修改云数据库审计日志保存时长、审计规则等服务配置 | 资源级 | qcs::cdb:${region}:uin/${uin}:instanceId/${InstanceId} | 支持 |
| ModifyAutoRenewFlag | 修改云数据库实例的自动续费标记 | 资源级 | qcs::cdb:$region:$account:instanceId/$instanceId | 支持 |
| ModifyBackupConfig | 修改云数据库备份配置信息 | 资源级 | qcs::cdb:$region:$account:instanceId/$instanceId | 支持 |
| ModifyBackupDownloadRestriction | 该接口用于修改用户当前地域的备份文件限制下载来源，可以设置内外网均可下载、仅内网可下载，或内网指定的vpc、ip可以下载。 | 操作级 | * | 不支持 |
| ModifyBackupEncryptionStatus | 本接口(ModifyBackupEncryptionStatus)用于设置实例备份文件是否加密。 | 资源级 | qcs::cdb:${region}:uin/${uin}:instanceId/${instanceId} | 支持 |
| ModifyBackupInfo | 修改备份信息 | 操作级 | * | 支持 |
| ModifyCDBProxyConnectionPool | 请求该接口配置数据库连接池；支持的连接池配置请求DescribeProxyConnectionPoolConf接口获取。 | 操作级 | * | 不支持 |
| ModifyCDBProxyDesc | 修改数据库代理描述 | 操作级 | * | 不支持 |
| ModifyCDBProxyVipVPort | 修改数据库代理VIP或端口 | 操作级 | * | 支持 |
| ModifyCdbProxyAddressDesc | 修改代理地址描述 | 操作级 | * | 支持 |
| ModifyCdbProxyAddressVipAndVPort | 修改数据库代理地址VPC | 操作级 | * | 支持 |
| ModifyCdbProxyParam | 配置数据库代理参数 | 操作级 | * | 支持 |
| ModifyDBInstanceLogToCLS | 开启或关闭CDB日志投递CLS | 资源级 | qcs::cdb:${region}:uin/${uin}:instanceId/${instanceId} | 支持 |
| ModifyDBInstanceModes | 更改云数据库的模式 | 资源级 | qcs::cdb:$region:$account:instanceId/$instanceId | 支持 |
| ModifyDBInstanceName | 修改云数据库实例名 | 资源级 | qcs::cdb:$region:$account:instanceId/$instanceId | 支持 |
| ModifyDBInstanceProject | 修改云数据库实例的所属项目 | 资源级 | qcs::cdb:$region:$account:instanceId/$instanceId | 支持 |
| ModifyDBInstanceReadOnlyStatus | 本接口（ModifyDBInstanceReadOnlyStatus）用户设置MySQL云数据库实例为只读。 | 操作级 | * | 支持 |
| ModifyDBInstanceSecurityGroups | 修改实例绑定的安全组 | 资源级 | qcs::cdb:$region:$account:instanceId/$instanceId | 不支持 |
| ModifyDBInstanceVipVport | 修改云数据库实例的vip和vport | 资源级 | qcs::cdb:$region:$account:instanceId/$instanceId | 支持 |
| ModifyDeployGroupConfigure | 修改部署组配置 | 操作级 | * | 支持 |
| ModifyInstanceParam | 修改实例参数 | 资源级 | qcs::cdb:${region}:uin/${uin}:instanceId/${instanceId} | 支持 |
| ModifyInstancePasswordComplexity | 本接口(ModifyInstancePasswordComplexity)用于修改云数据库实例的密码复杂度。 | 操作级 | * | 支持 |
| ModifyInstanceTag | 修改实例TAG | 资源级 | qcs::cdb:$region:$account:instanceId/$instanceId | 支持 |
| ModifyLocalBinlogConfig | 查询本地binlog配置 | 资源级 | qcs::cdb:${region}:uin/${uin}:instanceId/${instanceId} | 支持 |
| ModifyManualBackupName | 本接口(ModifyManualBackupName)用于修改手动备份别名。 | 资源级 | qcs::cdb:${region}:uin/${uin}:instanceId/${instanceId} | 支持 |
| ModifyMonitorTemplate | 监控模板更新监控项 | 操作级 | * | 支持 |
| ModifyNameOrDescByDpId | 修改组名称或者描述 | 操作级 | * | 支持 |
| ModifyPackageAgentInstanceApplyStatus | 审批渠道商待发货实例状态 | 操作级 | * | 支持 |
| ModifyParamTemplate | 修改参数模板 | 操作级 | * | 支持 |
| ModifyProtectMode | 修改实例的同步方式 | 操作级 | * | 支持 |
| ModifyRemoteBackupConfig | 修改云数据库异地备份配置信息 | 操作级 | * | 支持 |
| ModifyRoGroupInfo | 更新Ro组的信息 | 操作级 | * | 支持 |
| ModifyRoGroupVipVport | 修改Ro组的vip和vport | 操作级 | * | 支持 |
| ModifyRollbackInstanceSyncStatus | 跳过版本升级支持回滚过程中数据同步的错误，即跳过5.7复制到5.6版本的异常SQL。 | 资源级 | qcs::cdb:${region}:uin/${uin}:instanceId/${instanceId} | 支持 |
| ModifyTimeWindow | 更新与实例关联时间窗口 | 资源级 | qcs::cdb:$region:$account:instanceId/$instanceId | 支持 |
| OfflineDBInstances | 下线云数据库实例 | 资源级 | qcs::cdb:$region:$account:instanceId/$instanceId | 不支持 |
| OfflineIsolatedInstances | 立即下线隔离状态的云数据库实例 | 资源级 | qcs::cdb:$region:$account:instanceId/$instanceId | 支持 |
| OpenAuditService | CDB实例开通审计服务 | 资源级 | qcs::cdb:${region}:uin/${uin}:instanceId/${instanceId} | 支持 |
| OpenDBInstanceEncryption | 开启数据库实例加密 | 资源级 | qcs::cdb:$region:$account:instanceId/$instanceId | 支持 |
| OpenDBInstanceGTID | 开启云数据库实例的GTID | 资源级 | qcs::cdb:$region:$account:instanceId/$instanceId | 支持 |
| OpenSSL | 开启SSL连接功能。 | 资源级 | qcs::cdb:${region}:uin/${uin}:instanceId/${instanceId} | 支持 |
| OpenTransparentSlaveAccess | 本接口（OpenTransparentSlaveAccess）用于开通透明备机只读。 | 操作级 | * | 支持 |
| OpenWanService | 开通实例外网访问 | 资源级 | qcs::cdb:$region:$account:instanceId/$instanceId | 支持 |
| RecycleVip | 立即回收VIP | 操作级 | * | 支持 |
| RegisterCKafkaToAudit | 注册CKafka实例到审计 | 资源级 | qcs::cdb:$region:$account:instanceId/$instanceId | 支持 |
| ReloadBalanceProxyNode | 重新负载均衡数据库代理 | 操作级 | * | 支持 |
| RemoveMigrateJob | 删除迁移任务 | 操作级 | * | 支持 |
| RenewDBInstance | 续费云数据库实例 | 资源级 | qcs::cdb:$region:$account:instanceId/$instanceId | 不支持 |
| ResetInstancePassword | SSM刷新实例账户密码 | 资源级 | qcs::cdb::uin/${uin}:userResourceId/${UserResourceId} | 支持 |
| ResetRootAccount | 重置实例ROOT账，初始化账号权限 | 资源级 | qcs::cdb:${region}:uin/${uin}:instanceId/${instanceId} | 支持 |
| RestartDBInstances | 重启云数据库实例 | 资源级 | qcs::cdb:$region:$account:instanceId/$instanceId | 支持 |
| RollbackDBInstanceEngineVersion | 回滚发起版本升级的实例，目前仅支持5.6升级到5.7版本使用，即回滚5.7版本到5.6版本 | 资源级 | qcs::cdb:${region}:uin/${uin}:instanceId/${instanceId} | 支持 |
| StartBatchRollback | 发起批量回档任务 | 资源级 | qcs::cdb:$region:$account:instanceId/$instanceId | 支持 |
| StartCheckMasterInstanceStockByMultiCondition | 发起查询后端资源库存的任务 | 操作级 | * | 支持 |
| StartCheckRoInstanceStockByMultiCondition | 发起查询后端RO资源库存的任务 | 操作级 | * | 支持 |
| StartCpuExpand | 开启 CPU 弹性扩容。 | 资源级 | qcs::cdb:${region}:uin/${uin}:instanceId/${instanceId} | 支持 |
| StartInstanceAutoTune | 发起调参任务。 | 资源级 | qcs::cdb:${region}:uin/${uin}:instanceId/${instanceId} | 支持 |
| StartMigrateCluster | 迁移集群版 | 资源级 | qcs::cdb::uin/${uin}:instanceId/${instanceId} | 支持 |
| StartMigrateJob | 启动迁移任务 | 操作级 | * | 支持 |
| StartReplay | 开启定点回放，回放到指定时间点或者指定位点 | 资源级 | qcs::cdb:${region}:uin/${uin}:instanceId/${instanceId} | 支持 |
| StartReplication | 开启 RO 复制，从主实例同步数据。 | 资源级 | qcs::cdb:${region}:uin/${uin}:instanceId/${instanceId} | 支持 |
| StopCpuExpand | 停止CPU弹性扩容。 | 资源级 | qcs::cdb:${region}:uin/${uin}:instanceId/${instanceId} | 支持 |
| StopDBImportJob | 终止数据导入任务 | 操作级 | * | 支持 |
| StopReplication | 停止 RO 复制，中断从主实例同步数据。 | 资源级 | qcs::cdb:${region}:uin/${uin}:instanceId/${instanceId} | 支持 |
| StopRollback | 撤销回档任务 | 资源级 | qcs::cdb:$region:$account:instanceId/$instanceId | 支持 |
| SubmitBatchOperation | 提交批量导入任务 | 操作级 | * | 支持 |
| SubmitInstanceUpgradeCheckJob | 提交实例版本升级检查任务 | 资源级 | qcs::cdb:${region}:uin/${uin}:instanceId/${instanceId} | 支持 |
| SwitchCDBProxy | 数据库代理配置变更或则升级版本后手动发起立即切换 | 操作级 | * | 支持 |
| SwitchDBInstanceMasterSlave | 支持用户主动切换实例主从角色 | 资源级 | qcs::cdb:$region:$account:instanceId/$instanceId | 支持 |
| SwitchDrInstanceToMaster | 云数据库灾备实例切换为主实例 | 资源级 | qcs::cdb:$region:$account:instanceId/$instanceId | 支持 |
| SwitchDrMasterRole | 本接口（SwitchDrMasterRole）用于灾备回切。 | 操作级 | * | 支持 |
| SwitchForMigrateCluster | 立即切换集群版 | 资源级 | qcs::cdb::uin/${uin}:instanceId/${instanceId} | 支持 |
| SwitchForUpgrade | 升级切换VIP | 资源级 | qcs::cdb:$region:$account:instanceId/$instanceId | 支持 |
| TerminateInstanceAutoTune | 取消调参任务。只有未完成且实例未被销毁的调参任务，可以执行取消操作。 | 资源级 | qcs::cdb:${region}:uin/${uin}:instanceId/${instanceId} | 支持 |
| TerminateMigrateJob | 中止迁移任务 | 操作级 | * | 支持 |
| TransferPreToPost | 预付费转后付费接口 | 操作级 | * | 支持 |
| UnAssociateSecurityGroups | 安全组批量解绑云资源 | 资源级 | qcs::cdb:${region}:uin/${uin}:instanceId/${instanceId} | 不支持 |
| UpgradeCDBProxyVersion | 升级数据库代理版本 | 资源级 | qcs::cdb:${region}:uin/${uin}:instanceId/${instanceId} | 支持 |
| UpgradeDBInstanceEngineVersion | 升级云数据库实例版本 | 资源级 | qcs::cdb:$region:$account:instanceId/$instanceId | 不支持 |
| UploadSqlFiles | 上传SQL文件 | 操作级 | * | 不支持 |
读操作
| 接口名 | 接口描述 | 授权粒度 | 资源六段式 | IP限制 |
|---|---|---|---|---|
| AnalyzeAuditLogs | 对审计日志进行聚合统计分析 | 资源级 | qcs::cdb:${region}:uin/${uin}:instanceId/${InstanceId} | 支持 |
| CheckDrInstanceRecovery | 本接口（CheckDrInstanceRecovery）用于校验灾备可否回切。在提升灾备为主实例前，可以通过该接口校验灾备实例与主实例的延迟和 GTID，如果校验成功，那么灾备实例提升为主后可以发起灾备回切。 | 资源级 | qcs::cdb:${region}:uin/${uin}:instanceId/${instanceId} | 支持 |
| CheckIpInSubnet | 该接口（CheckIpInSubnet）用于校验IP是否在子网内。 | 操作级 | * | 支持 |
| CheckMigrateCluster | 迁移集群版校验 | 资源级 | qcs::cdb:${Region}:uin/${uin}:instanceId/${instanceId} | 支持 |
| CheckMigrateJob | 校验迁移任务 | 操作级 | * | 支持 |
| DescribeAccountPrivileges | 查询云数据库账户的权限信息 | 资源级 | qcs::cdb:$region:$account:instanceId/$instanceId | 支持 |
| DescribeAsyncRequestInfo | 查询云数据库实例异步任务的执行结果 | 操作级 | * | 支持 |
| DescribeAuditConfig | 查询实例审计配置 | 资源级 | qcs::cdb:$region:$account:instanceId/$instanceId | 支持 |
| DescribeAuditInstanceList | 获取审计实例列表 | 操作级 | * | 不支持 |
| DescribeAuditLogFiles | 查询实例审计日志文件 | 资源级 | qcs::cdb:$region:$account:instanceId/$instanceId | 支持 |
| DescribeAuditLogs | 查询实例审计日志 | 资源级 | qcs::cdb:$region:$account:instanceId/$instanceId | 支持 |
| DescribeAuditLogsForVStation | 查询审计日志 | 操作级 | * | 不支持 |
| DescribeAuditPolicies | 查询实例审计策略 | 资源级 | qcs::cdb:$region:$account:instanceId/$instanceId | 不支持 |
| DescribeAuditRuleTemplateModifyHistory | 查询规则模板变更记录 | 操作级 | * | 支持 |
| DescribeAuditRuleTemplates | 查询审计规则模板信息 | 操作级 | * | 支持 |
| DescribeAuditRuleWithInstanceIds | 根据实例ID，查询实例的审计规则 | 资源级 | qcs::cdb:${region}:uin/${uin}:instanceId/${InstanceIds} | 支持 |
| DescribeAuditRules | 查询审计规则 | 操作级 | * | 不支持 |
| DescribeAuditStatus | 查询审计状态 | 操作级 | * | 不支持 |
| DescribeBackupConfig | 查询云数据库备份配置信息 | 资源级 | qcs::cdb:$region:$account:instanceId/$instanceId | 不支持 |
| DescribeBackupDecryptionKey | 本接口(DescribeBackupDecryptionKey)用于查询备份文件解密密钥。 | 资源级 | qcs::cdb:${region}:uin/${uin}:instanceId/${instanceId} | 支持 |
| DescribeBackupDownloadDbTableCode | 查询分库分表下载位点 | 操作级 | * | 支持 |
| DescribeBackupDownloadRestriction | 该接口用户查询当前地域用户设置的默认备份下载来源限制。 | 操作级 | * | 支持 |
| DescribeBackupEncryptionStatus | 本接口(DescribeBackupEncryptionStatus)用于查询实例默认备份加密状态。 | 资源级 | qcs::cdb:${region}:uin/${uin}:instanceId/${instanceId} | 支持 |
| DescribeBackupOverview | 用于查询用户的备份概览 | 操作级 | * | 支持 |
| DescribeBackupSummaries | 用于查询备份的统计情况 | 操作级 | * | 支持 |
| DescribeBackups | 查询备份日志 | 资源级 | qcs::cdb:${region}:uin/${uin}:instanceId/${instanceId} | 不支持 |
| DescribeBackupsForBackupService | 查询数据备份文件列表 | 资源级 | qcs::cdb:${region}:uin/${uin}:instanceId/${instanceId} | 支持 |
| DescribeBatchJobFileContent | 批量导入 - 获取SQL文件内容 | 操作级 | * | 支持 |
| DescribeBatchJobInfo | 批量导入 - 查询任务详细信息 | 操作级 | * | 不支持 |
| DescribeBinlogBackupOverview | 用于查询用户在当前地域总的日志备份概览 | 操作级 | * | 支持 |
| DescribeBinlogs | 获取云数据库实例的二进制日志 | 资源级 | qcs::cdb:${region}:uin/${uin}:instanceId/${instanceId} | 支持 |
| DescribeBinlogsForBackupService | 查询二进制日志备份文件列表 | 资源级 | qcs::cdb:${region}:uin/${uin}:instanceId/${instanceId} | 支持 |
| DescribeCDBProxy | 查询数据库代理 | 操作级 | * | 支持 |
| DescribeCKafkaTaskStatus | 查询注册Ckafka任务状态 | 资源级 | qcs::cdb:$region:$account:instanceId/$instanceId | 支持 |
| DescribeCageRealServerUsage | 查询金融围拢内物理机的资源使用情况 | 操作级 | * | 支持 |
| DescribeCdbProxyInfo | 查询数据库代理详情 | 操作级 | * | 支持 |
| DescribeCdbZoneConfig | 本接口(DescribeCdbZoneConfig)用于查询云数据库各地域可售卖的规格配置。 | 操作级 | * | 不支持 |
| DescribeCdzRealServerUsage | 获取 CDZ 可用区的资源使用情况。 | 操作级 | * | 支持 |
| DescribeCloneList | 查询克隆任务列表 | 资源级 | qcs::cdb:$region:$account:instanceId/$instanceId | 支持 |
| DescribeClusterInfo | 查询集群版实例信息 | 资源级 | qcs::cdb:${region}:uin/${uin}:instanceId/${instanceId} | 支持 |
| DescribeCpuExpandStrategy | 获取当前实例的CPU弹性扩容策略。 | 资源级 | qcs::cdb:${region}:uin/${uin}:instanceId/${instanceId} | 支持 |
| DescribeDBDiskInfo | 本接口(DescribeDBDiskInfo)用于查询云数据库物理机磁盘信息。 | 资源级 | qcs::cdb:${region}:uin/${uin}:instanceId/${instanceId} | 支持 |
| DescribeDBFeatures | 本接口(DescribeDBFeatures)用于查询云数据库版本属性，包括是否支持数据库加密、数据库审计等功能。 | 资源级 | qcs::cdb:${region}:uin/${uin}:instanceId/${instanceId} | 支持 |
| DescribeDBInstanceCharset | 查询云数据库实例的字符集 | 资源级 | qcs::cdb:$region:$account:instanceId/$instanceId | 支持 |
| DescribeDBInstanceConfig | 查询云数据库实例的配置 | 资源级 | qcs::cdb:$region:$account:instanceId/$instanceId | 支持 |
| DescribeDBInstanceGTID | 查询云数据库实例是否开通GTID | 资源级 | qcs::cdb:$region:$account:instanceId/$instanceId | 不支持 |
| DescribeDBInstanceInfo | 查询实例基本信息（实例 ID ，实例名称，是否开通加密 ） | 资源级 | qcs::cdb:${region}:uin/${uin}:instanceId/${instanceId} | 支持 |
| DescribeDBInstanceLogToCLS | 查询实例日志投递CLS的配置 | 资源级 | qcs::cdb:${region}:uin/${uin}:instanceId/${instanceId} | 支持 |
| DescribeDBInstanceProcess | 本接口（DescribeDBInstanceProcess）用于查询实例活动线程。 | 操作级 | * | 支持 |
| DescribeDBInstanceRebootTime | 查询云数据库实例的预期重启时间 | 资源级 | qcs::cdb:$region:$account:instanceId/$instanceId | 支持 |
| DescribeDBInstances | 查询实例列表 | 资源级 | qcs::cdb:$region:$account:instanceId/$instanceId | 不支持 |
| DescribeDBPrice | 查询数据库实例价格 | 资源级 | qcs::cdb:$region:$account:instanceId/$instanceId | 不支持 |
| DescribeDBRoutes | 查询云数据库的路由 | 资源级 | qcs::cdb:$region:$account:instanceId/$instanceId | 不支持 |
| DescribeDBSecurityGroupsDetail | 查询安全组详细信息 | 操作级 | * | 不支持 |
| DescribeDataBackupOverview | 用于查询用户在当前地域总的数据备份概览 | 操作级 | * | 支持 |
| DescribeDataBackupSavePlan | 本接口(DescribeDataBackupSavePlan)用查询未来一年数据库备份保留计划。 | 资源级 | qcs::cdb:${region}:uin/${uin}:instanceId/${instanceId} | 支持 |
| DescribeDatabases | 查询数据库 | 资源级 | qcs::cdb:${region}:uin/${uin}:instanceId/${instanceId} | 不支持 |
| DescribeDbTknPwdRules | 查询密码规则 | 资源级 | qcs::cdb::uin/${uin}:userResourceId/$UserResourceId | 支持 |
| DescribeDbTknResource | 查询 DbTkn 类型资源是否开启密码轮转 | 资源级 | qcs::cdb::uin/${uin}:userResourceId/$UserResourceId | 支持 |
| DescribeDefaultParamTemplates | 查询默认参数模板列表 | 操作级 | * | 支持 |
| DescribeDeployGroupList | 查询组列表 | 操作级 | * | 支持 |
| DescribeDeviceMonitorInfo | 查询云数据库物理机当天的监控信息 | 资源级 | qcs::cdb:$region:$account:instanceId/$instanceId | 支持 |
| DescribeDownloadBackupRecords | 该接口用于查询CDB备份文件的下载记录。 | 操作级 | * | 支持 |
| DescribeErrorLogData | 查询错误日志 | 资源级 | qcs::cdb:${region}:uin/${uin}:instanceId/$instanceId | 支持 |
| DescribeInstanceAlarmEvents | 查询实例发生的事件信息 | 资源级 | qcs::cdb:${region}:uin/${uin}:instanceId/${InstanceId} | 支持 |
| DescribeInstanceAuditConfig | 查询实例审计配置 | 操作级 | * | 支持 |
| DescribeInstanceDiskStatus | 查询实例磁盘状态 | 资源级 | qcs::cdb:${region}:uin/${uin}:instanceId/${instanceId} | 支持 |
| DescribeInstanceGTIDInfo | 查询云数据实例的GTID信息。 | 资源级 | qcs::cdb:${region}:uin/${uin}:instanceId/${instanceId} | 支持 |
| DescribeInstanceInfo | 获取实例详情 | 操作级 | * | 支持 |
| DescribeInstanceNumberByVpcSubnetId | 本接口(DescribeInstanceNumberByVpcSubnetId)用于查询VPC网络当中存在的CDB实例数。 | 操作级 | * | 支持 |
| DescribeInstanceUpgradeCheckJob | 查询实例版本升级校验任务 | 资源级 | qcs::cdb:${region}:uin/${uin}:instanceId/${instanceId} | 支持 |
| DescribeInstancesAuditStatus | 本接口 (DescribeInstancesAuditStatus) 用于查询实例的审计状态，如是否开启审计、审计策略等概览信息。 | 操作级 | * | 支持 |
| DescribeInstancesReturnable | 判断实例是否可退 | 操作级 | * | 支持 |
| DescribeLocalBinlogConfig | 该接口用于查询实例本地binlog保留策略。 | 资源级 | qcs::cdb:${region}:uin/${uin}:instanceId/${instanceId} | 支持 |
| DescribeMasterInstanceStockByMultiCondition | 根据多重条件查询后端资源库存 | 操作级 | * | 不支持 |
| DescribeMonitorData | 获取实例监控数据 | 操作级 | * | 支持 |
| DescribeMonitorTemplate | 查询监控模板监控项 | 操作级 | * | 支持 |
| DescribePackageAgentInfo | 查询渠道商信息 | 操作级 | * | 支持 |
| DescribePackageAgentInstances | 查询渠道商所属实例详情 | 操作级 | * | 支持 |
| DescribePackageAgentSummary | 查询渠道商实例统计 | 操作级 | * | 支持 |
| DescribeParamTemplateInfo | 查询参数模板详情 | 操作级 | * | 支持 |
| DescribeProxyCommercialDate | 查询代理商业化时间 | 操作级 | * | 支持 |
| DescribeProxyConnectionPoolConf | 获取数据库代理连接池相关规格配置 | 资源级 | qcs::cdb:${region}:uin/${uin}:instanceId/${instanceId} | 支持 |
| DescribeProxyCustomConf | 查询代理规格配置 | 资源级 | qcs::cdb:${region}:uin/${uin}:instanceId/${instanceId} | 支持 |
| DescribeProxySpecs | 查询proxy免费规格 | 操作级 | * | 支持 |
| DescribeProxySupportParam | 查询实例支持代理版本和参数 | 操作级 | * | 支持 |
| DescribeRecycleVipList | 查询待回收VIP列表 | 操作级 | * | 支持 |
| DescribeRemoteBackupConfig | 查询云数据库异地备份配置信息 | 操作级 | * | 支持 |
| DescribeRequestResult | 查询异步任务的执行结果 | 操作级 | * | 支持 |
| DescribeResourceDetail | 本接口(DescribeResourceDetail)用于查询资源详情。 | 资源级 | qcs::cdb:${region}:uin/${uin}:instanceId/${instanceId} | 支持 |
| DescribeRoGroupInfo | 查询Ro组的详细信息 | 操作级 | * | 不支持 |
| DescribeRoInstanceStockByMultiCondition | 根据多重条件查询后端RO资源库存 | 操作级 | * | 不支持 |
| DescribeRoMinScale | 获取只读实例购买的最小规格 | 操作级 | * | 支持 |
| DescribeRollbackInstanceSyncStatus | 获取版本升级支持回滚实例的数据同步状态 | 操作级 | * | 支持 |
| DescribeRollbackRangeTime | 查询可回档的时间 | 资源级 | qcs::cdb:$region:$account:instanceId/$instanceId | 支持 |
| DescribeRollbackTaskDetail | 查询云数据库实例回档任务详情。 | 资源级 | qcs::cdb:$region:$account:instanceId/$instanceId | 支持 |
| DescribeSSLStatus | 查询 SSL 开通情况。如果已经开通 SSL ，会同步返回证书下载链接。 | 资源级 | qcs::cdb:${region}:uin/${uin}:instanceId/${instanceId} | 支持 |
| DescribeSlowLogData | 查询慢日志 | 资源级 | qcs::cdb:${region}:uin/${uin}:instanceId/$instanceId | 支持 |
| DescribeSlowLogs | 获取云数据库实例的慢查询日志 | 资源级 | qcs::cdb:${region}:uin/${uin}:instanceId/${instanceId} | 支持 |
| DescribeStatisticsInfo | 查看监控数据 | 操作级 | * | 不支持 |
| DescribeStockCheckResult | 查询资源库存任务的执行结果 | 操作级 | * | 支持 |
| DescribeSupportDeviceClass | 获取置放群组支持的机型。 | 操作级 | * | 支持 |
| DescribeSupportPOCSubVersions | MySQL相应的版本存储引擎都有其支持的内核小版本号（主要用于POC测试） | 操作级 | * | 支持 |
| DescribeSupportedPrivileges | 查询云数据库实例支持的权限信息 | 资源级 | qcs::cdb:$region:$account:instanceId/$instanceId | 支持 |
| DescribeSwitchableInstanceList | 获取用户所有待切换实例列表 | 资源级 | qcs::cdb:${region}:uin/${uin}:instanceId/${instanceId} | 支持 |
| DescribeTables | 查询数据库表 | 资源级 | qcs::cdb:${region}:uin/${uin}:instanceId/${instanceId} | 支持 |
| DescribeTablesByRegexp | 本接口(DescribeTablesByRegexp)用于根据正则表达式查询表名。 | 资源级 | qcs::cdb:${region}:uin/${uin}:instanceId/${instanceId} | 支持 |
| DescribeTagsOfInstanceIds | 查询实例tag | 操作级 | * | 支持 |
| DescribeTimeWindow | 查询与实例相关的时间窗口 | 资源级 | qcs::cdb:$region:$account:instanceId/$instanceId | 不支持 |
| DescribeTimeWindowSwitchForZone | 该接口获取哪些地区关闭了时间窗，即用户主动发起的时间窗内切换的任务全都失效，不进行切换 | 操作级 | * | 支持 |
| GetCheckMigrateJobResult | 获取校验迁移任务结果 | 操作级 | * | 支持 |
| GetDataComparisonResult | 获取数据对比结果 | 操作级 | * | 不支持 |
| GetMigrateJob | 获取迁移任务 | 操作级 | * | 支持 |
| InquiryPriceUpgradeInstances | 查询升级数据库实例价格 | 资源级 | qcs::cdb:$region:$account:instanceId/$instanceId | 支持 |
| QueryCDBProxy | 查询代理详情 | 操作级 | * | 支持 |
| ReleaseIsolatedDBInstances | 解隔离云数据库实例 | 操作级 | * | 支持 |
| ShowMigrateDatabaseTable | 展示迁移数据库里面的库表信息，供前端展示选择 | 操作级 | * | 支持 |
| UpgradeDBInstance | 升级云数据库实例 | 操作级 | * | 不支持 |
| VerifyRootAccount | 校验云数据库实例的 ROOT 账号是否有足够的权限进行授权操作。 | 资源级 | qcs::cdb:$region:$account:instanceId/$instanceId | 支持 |
其他操作
| 接口名 | 接口描述 | 授权粒度 | 资源六段式 | IP限制 |
|---|---|---|---|---|
| CloseSSL | 关闭SSL连接功能。 | 资源级 | qcs::cdb:${region}:uin/${uin}:instanceId/${instanceId} | 支持 |
列表操作
| 接口名 | 接口描述 | 授权粒度 | 资源六段式 | IP限制 |
|---|---|---|---|---|
| DescribeAccounts | 查询云数据库的所有账号信息 | 资源级 | qcs::cdb:$region:$account:instanceId/$instanceId | 支持 |
| DescribeBackupDatabases | 查询备份数据库列表 | 资源级 | qcs::cdb:$region:$account:instanceId/$instanceId | 支持 |
| DescribeBackupTables | 查询指定数据库的备份数据表列表 | 资源级 | qcs::cdb:$region:$account:instanceId/$instanceId | 不支持 |
| DescribeBatchJobFiles | 批量导入 - 查询用户提交的SQL文件列表 | 操作级 | * | 支持 |
| DescribeDBImportRecords | 查询导入任务操作日志 | 资源级 | qcs::cdb:$region:$account:instanceId/$instanceId | 支持 |
| DescribeDBSecurityGroups | 查询实例安全组信息 | 资源级 | qcs::cdb:$region:$account:instanceId/$instanceId | 不支持 |
| DescribeDBSwitchRecords | 获取实例切换记录 | 资源级 | qcs::cdb:$region:$account:instanceId/$instanceId | 支持 |
| DescribeDatabasesForInstances | 批量查询云数据库实例的数据库 | 资源级 | qcs::cdb:$region:$account:instanceId/$instanceId | 不支持 |
| DescribeDefaultParams | 查询默认的可设置参数列表 | 操作级 | * | 支持 |
| DescribeErrLogInfo | 获取云数据库实例的错误解析日志 | 资源级 | qcs::cdb:$region:$account:instanceId/$instanceId | 不支持 |
| DescribeInstanceParamRecords | 查询实例的参数修改历史 | 资源级 | qcs::cdb:$region:$account:instanceId/$instanceId | 支持 |
| DescribeInstanceParams | 查询实例的可设置参数列表 | 资源级 | qcs::cdb:$region:$account:instanceId/$instanceId | 支持 |
| DescribeParamTemplates | 查询参数模板列表 | 操作级 | * | 支持 |
| DescribeProjectSecurityGroups | 查询项目安全组信息 | 操作级 | * | 不支持 |
| DescribeRoGroups | 查询指定主实例的Ro组信息 | 资源级 | qcs::cdb:$region:$account:instanceId/$instanceId | 不支持 |
| DescribeSlowLogInfo | 获取云数据库实例的慢查询解析日志 | 资源级 | qcs::cdb:$region:$account:instanceId/$instanceId | 不支持 |
| DescribeTableColumns | 查询数据库表的列 | 资源级 | qcs::cdb:$region:$account:instanceId/$instanceId | 支持 |
| DescribeTasks | 查询云数据库实例的任务列表 | 操作级 | * | 支持 |
| DescribeUploadedFiles | 文件导入：获取已经上传的文件 | 操作级 | * | 不支持 |
| ShowProcessList | 查看MySQL的执行线程 | 资源级 | qcs::cdb:$region:$account:instanceId/$instanceId | 不支持 |