TencentDB for DBbrain
Last updated: 2025-12-04 09:09:28
Fundamental information
| Product | Abbreviation in CAM | Console | Authorization by Tag | Authorization Granularity | IP Restriction |
|---|---|---|---|---|---|
| TencentDB for DBbrain | dbbrain | Supported | not supported | Resource level | Partially supported |
Note：
The authorization granularity of cloud products is divided into three levels: service level, operation level, and resource level, based on the degree of granularity.
- Service level: It defines whether a user has the permission to access the service as a whole. A user can have either full access or no access to the service. For the authorization granularity of cloud products at service level, the authorization of specific APIs are not supported.
- Operation level: It defines whether a user has the permission to call a specific API of the service. For example, granting an account read-only access to the CVM service is an authorization at the operation level.
- Resource level: It is the finest authorization granularity which defines whether a user has the permission to access specific resources. For example, granting an account read/write access to a specific CVM instance is an authorization at the resource level.
API authorization granularity
Two authorization granularity levels of API are supported: resource level, and operation level.
- Resource level: It supports the authorization of a specific resource.
- Operation level: It does not support the authorization of a specific resource. If the policy syntax restricts a specific resource during authorization, CAM will determine that this API is not within the scope of authorization, and deem it as unauthorized.
Write operations
| API | API Description | Authorization Granularity | Six-segment Resource Description | IP Restriction |
|---|---|---|---|---|
| AddInstanceToGroup | Add instance to group | Operation level | * | Supported |
| AddInstancesToSecAuditGroup | add instances to security audit group | Operation level | * | Supported |
| AddUserContact | Add user contact info | Operation level | * | Supported |
| AddUserGroup | add user group | Operation level | * | Supported |
| AttachMySqlInstance | attach mySql instance | Operation level | * | Supported |
| AuthUserAccount | auth user account | Resource level | qcs::dbbrain:${region}:uin/${uin}:instanceId/${InstanceId} | Supported |
| BindInstanceWithUserProfile | Bind instance with userProfile | Operation level | * | not supported |
| BindRuleToSecAuditGroup | Bind rule to security audit group | Operation level | * | not supported |
| BindSensitiveRule | Bind instance and sensitive detect rule | Resource level | qcs:id/0:cdb:gz:uin/100000983328:instanceId/cdb-e4qazvd8 | not supported |
| CancelAuditLogFile | cancel audit log file | Resource level | qcs::dbbrain:${region}:uin/${uin}:instanceId/${InstanceId} | Supported |
| CancelBuildIndex | Cancel instance build index | Resource level | qcs::dbbrain:${region}:uin/${uin}:instanceId/${instanceId} | Supported |
| CancelDBAutonomyAction | Cancel instance autonomy action | Resource level | qcs::dbbrain:${region}:uin/${uin}:instanceId/${instanceId} | not supported |
| CancelDBAutonomyEvent | Cancel instance autonomy event | Resource level | qcs::dbbrain:${region}:uin/${uin}:instanceId/${instanceId} | not supported |
| CancelKillTask | cancel kill threads task | Resource level | qcs::dbbrain:${region}:uin/${uin}:instanceId/${instanceId} | Supported |
| CancelRedisBigKeyAnalysisTasks | Terminate the big key task | Resource level | qcs::dbbrain::uin/${uin}:instanceId/${instanceId} | Supported |
| CancelSqlExecution | cancel sql execution | Resource level | qcs::dbbrain:${region}:uin/${uin}:instanceId/${InstanceId} | Supported |
| CloseAuditService | close audit | Resource level | qcs::dbbrain:${region}:uin/${uin}:instanceId/${instanceId} | Supported |
| CloseInstanceAuditService | Close instance audit service | Resource level | qcs::dbbrain:${region}:uin/${uin}:instanceId/${instanceId} | Supported |
| CloseInstanceDBbrainFullAuditService | Disable full chain analysis | Resource level | qcs::dbbrain:${region}:uin/${uin}:instanceId/${InstanceId} | Supported |
| ConfirmSqlExecution | confirm sql execution | Resource level | qcs::dbbrain:${region}:uin/${uin}:instanceId/${InstanceId} | Supported |
| ContinueSqlExecution | continue sql execution | Resource level | qcs::dbbrain:${region}:uin/${uin}:instanceId/${InstanceId} | Supported |
| CreateAlarmPolicy | Create Alarm policy | Operation level | * | Supported |
| CreateAlarmTemplate | Create user notice template | Operation level | * | Supported |
| CreateAuditLogFile | create an audit log file download task | Resource level | qcs::dbbrain:${region}:uin/${uin}:instanceId/${instanceId} | Supported |
| CreateAuditLogStatsTask | Create audit log stats task | Resource level | qcs:id/0:cdb:gz:uin/100000983328:instanceId/cdb-e4qazvd8 | Supported |
| CreateCollectionIndex | Create MongoDB instance collection index | Resource level | qcs::dbbrain:${region}:uin/${uin}:instanceId/${instanceId} | Supported |
| CreateDBDiagReportTask | Create a health report task | Operation level | * | Supported |
| CreateDBDiagReportUrl | CreateDBDiagReportUrl | Operation level | * | Supported |
| CreateDBDiagReportUrls | Generate URL link for health report | Operation level | * | Supported |
| CreateDesensitizationAlgorithm | Create desentization algorithm | Operation level | * | not supported |
| CreateDesensitizationRule | Create desentization rule | Operation level | * | Supported |
| CreateDesensitizationTask | Create desentization task | Operation level | * | Supported |
| CreateDiagInstanceGroup | Create Diag Instance Group | Operation level | * | Supported |
| CreateIgnoreDiagRecord | Create ignore diag record | Resource level | qcs::dbbrain:${region}:uin/${uin}:instanceId/${instanceId} | Supported |
| CreateInnodbHotUpdateDetectTask | Create InnodbHotUpdateDetect Task | Resource level | qcs::dbbrain:${region}:uin/${uin}:instanceId/${InstanceId} | Supported |
| CreateKillTask | create kill threads task | Resource level | qcs::dbbrain:${region}:uin/${uin}:instanceId/${instanceId} | Supported |
| CreateKillTasks | create kill tasks | Resource level | qcs::dbbrain:${region}:uin/${uin}:instanceId/${instanceId} | Supported |
| CreateMailProfile | Create mail profile | Operation level | * | Supported |
| CreateMongoDBKillTask | Create a task to interrupt the MongoDB session | Resource level | qcs::dbbrain::uin/${uin}:instanceId/${InstanceId} | Supported |
| CreateNodeComparingTask | create node compare task | Resource level | qcs::dbbrain:${region}:uin/${uin}:instanceId/${InstanceId} | Supported |
| CreateProxySessionKillTask | Create kill session task on all proxy. Support Redis product. | Resource level | qcs::dbbrain:${region}:uin/${uin}:instanceId/${instanceId} | Supported |
| CreateRedisBigKeyAnalysisTask | Create redis instance big key analysis task. | Resource level | qcs::dbbrain:${region}:uin/${uin}:instanceId/${instanceId} | Supported |
| CreateRiskSqlReportTask | Create risk SQL report export task | Operation level | * | not supported |
| CreateRiskSqlReportUrl | Create risk sql report url | Operation level | * | not supported |
| CreateRiskSqlTplReportTask | create risk sql template report task | Resource level | qcs::dbbrain:${region}:uin/${uin}:instanceId/${instanceId} | Supported |
| CreateSchedulerMailProfile | Create scheduler mail profile | Operation level | * | Supported |
| CreateSecAuditGroup | Create security audit group | Operation level | * | Supported |
| CreateSecAuditRule | Create security audit rule | Operation level | * | not supported |
| CreateSecurityAuditLogExportTask | Create security audit log export task | Operation level | * | Supported |
| CreateSensitiveRule | Create sensitive detect rule | Operation level | * | Supported |
| CreateSensitiveType | Create sensitive type for sensitive detect | Operation level | * | Supported |
| CreateSqlAnalysisTask | create sql analysis task | Resource level | qcs::dbbrain:${region}:uin/${uin}:instanceId/${InstanceId} | Supported |
| CreateSqlFilter | Create instance SQL filter task. | Resource level | qcs::dbbrain:${region}:uin/${uin}:instanceId/${instanceId} | Supported |
| CreateUserAutonomyProfile | Create user autonomy profile | Resource level | qcs::dbbrain:${region}:uin/${uin}:instanceId/${instanceId} | Supported |
| CreateUserProfile | Create user profile | Operation level | * | Supported |
| CreateUserReportUrl | create security report url | Operation level | * | not supported |
| CreateUserSession | Creating a user session | Resource level | qcs::dbbrain::uin/${uin}:instanceId/${InstanceId} | Supported |
| DeleteAlarmPolicy | Delete alarm policy | Operation level | * | Supported |
| DeleteAlarmTemplate | Delete user notice template | Operation level | * | Supported |
| DeleteAuditLogFile | delete audit log file | Resource level | qcs::dbbrain:${region}:uin/${uin}:instanceId/${instanceId} | Supported |
| DeleteAuditLogStatsTask | Delete audit log stats task | Resource level | qcs:id/0:cdb:gz:uin/100000983328:instanceId/cdb-e4qazvd8 | Supported |
| DeleteBindRulesByRuleIds | Delete rule bound to security group | Operation level | * | not supported |
| DeleteCollectionIndex | Delete MongoDB instance collection index | Resource level | qcs::dbbrain:${region}:uin/${uin}:instanceId/${instanceId} | Supported |
| DeleteDBDiagReportTasks | Delete health diagnosis report analysis task | Operation level | * | Supported |
| DeleteDesensitizationAlgorithm | Delete desentization algorithm | Operation level | * | Supported |
| DeleteDesensitizationRule | Delete desentization rule | Operation level | * | not supported |
| DeleteDesensitizationTask | Delete desentization task | Operation level | * | Supported |
| DeleteDiagInstanceGroup | Delete Instance Group | Operation level | * | Supported |
| DeleteInnodbHotUpdateDetectTasks | delete detect tasks | Resource level | qcs::dbbrain:${region}:uin/${uin}:instanceId/${InstanceId} | Supported |
| DeleteKillTaskRecord | Delete kill task record | Resource level | qcs::dbbrain:${region}:uin/${uin}:instanceId/${instanceId} | Supported |
| DeleteMailProfile | delete mail profile | Operation level | * | Supported |
| DeleteRedisBigKeyAnalysisTasks | Delete redis instance big key analysis tasks. | Resource level | qcs::dbbrain:${region}:uin/${uin}:instanceId/${instanceId} | Supported |
| DeleteRiskSqlTplReportTask | delete risk sql template report task | Resource level | qcs::dbbrain:${region}:uin/${uin}:instanceId/${instanceId} | not supported |
| DeleteSecAuditGroup | Delete security audit group | Operation level | * | Supported |
| DeleteSecAuditRule | delete security audit rule | Operation level | * | not supported |
| DeleteSecurityAuditLogExportTasks | Delete security audit log export tasks | Operation level | * | Supported |
| DeleteSensitiveGroup | Delete group of sensitive type for sensitive detect | Operation level | * | not supported |
| DeleteSensitiveRule | Delete sensitive detect rule | Operation level | * | not supported |
| DeleteSensitiveType | Delete sensitive type for sensitive detect | Operation level | * | Supported |
| DeleteSqlFilters | Delete instance SQL filter tasks. | Resource level | qcs::dbbrain:${region}:uin/${uin}:instanceId/${instanceId} | Supported |
| DeleteUserContact | delete user contact | Operation level | * | Supported |
| DeleteUserGroup | delete user group | Operation level | * | Supported |
| DeleteUserProfile | Delete user profile | Operation level | * | Supported |
| DeleteUserReportTasks | Delete user health report task | Operation level | * | Supported |
| DestroyAgent | destroy mysql agent | Operation level | * | Supported |
| DestroyInstance | destroy mysql instance | Operation level | * | Supported |
| DestroyUserSession | Destroy user session | Resource level | qcs::dbbrain:${region}:uin/${uin}:instanceId/${InstanceId} | Supported |
| ExecuteUserSql | Execute sql | Resource level | qcs::dbbrain:${region}:uin/${uin}:instanceId/${instanceId} | Supported |
| KillMongoDBThreads | kill mongodb threads | Resource level | qcs::dbbrain:${region}:uin/${uin}:instanceId/${InstanceId} | Supported |
| KillMySqlThreads | kill mysql threads | Resource level | qcs::dbbrain:${region}:uin/${uin}:instanceId/${instanceId} | Supported |
| ModifyAlarmPolicy | Modify alarm policy | Operation level | * | Supported |
| ModifyAuditService | modify audit | Resource level | qcs::dbbrain:${region}:uin/${uin}:instanceId/${instanceId} | Supported |
| ModifyDesensitizationAlgorithm | Modify desentization algorithm | Operation level | * | Supported |
| ModifyDesensitizationRule | Modify desentization rule | Operation level | * | Supported |
| ModifyDesensitizationTask | Modify desentization task | Operation level | * | Supported |
| ModifyDesensitizationTaskStatus | Modify desentization task status | Operation level | * | Supported |
| ModifyDiagDBInstanceConf | Modify instance daily inspection status | Operation level | * | Supported |
| ModifyDiagInstanceGroup | Modify Instance Group | Operation level | * | Supported |
| ModifyInnodbHotUpdateDetectTasks | Modify InnodbHotUpdateDetect Tasks | Resource level | qcs::dbbrain:${region}:uin/${uin}:instanceId/${InstanceId} | Supported |
| ModifyMailProfile | modify mail profile | Operation level | * | Supported |
| ModifySecAuditGroup | Modify security audit group | Operation level | * | Supported |
| ModifySecAuditRule | modify security audit rule | Operation level | * | not supported |
| ModifySensitiveRule | Modify sensitive detect rule | Operation level | * | Supported |
| ModifySensitiveType | Modify sensitive type for sensitive detect | Operation level | * | Supported |
| ModifySqlFilters | Modify instance SQL filter tasks status. | Resource level | qcs::dbbrain:${region}:uin/${uin}:instanceId/${instanceId} | Supported |
| ModifyUserAutonomyProfile | Modify user autonomy profile | Resource level | qcs::dbbrain:${region}:uin/${uin}:instanceId/${instanceId} | Supported |
| ModifyUserContact | modify user contact | Operation level | * | Supported |
| ModifyUserGroup | modify user group | Operation level | * | not supported |
| ModifyUserProfile | Modify user profile | Operation level | * | Supported |
| OpenAuditService | open audit | Resource level | qcs::dbbrain:${region}:uin/${uin}:instanceId/${instanceId} | Supported |
| OpenInstanceAuditService | Open instance audit service | Resource level | qcs::dbbrain:${region}:uin/${uin}:instanceId/${instanceId} | Supported |
| OpenInstanceDBbrainFullAuditService | Open Instance DBbrain FullAuditService | Resource level | qcs::dbbrain:${region}:uin/${uin}:instanceId/${InstanceId} | Supported |
| OpenMailTemplate | open mail template | Operation level | * | Supported |
| ParseSqlText | Get parse sql text | Resource level | qcs::dbbrain:${region}:uin/${uin}:instanceId/${InstanceId} | Supported |
| RemoveGroupMember | remove group member | Operation level | * | Supported |
| RemoveInstancesFromSecAuditGroup | remove instances from security audit group | Operation level | * | not supported |
| ReplicateUserSession | Replicate user session | Resource level | qcs::dbbrain:${region}:uin/${uin}:instanceId/${InstanceId} | Supported |
| RetryIndexOperationTask | Retry instance index operation task | Resource level | qcs::dbbrain:${region}:uin/${uin}:instanceId/${instanceId} | Supported |
| SendMailManually | send mail manually | Resource level | qcs::dbbrain:${region}:uin/${uin}:instanceId/${instanceId} | Supported |
| SyncInst2RiskDashBoard | sync instance to risk dashBoard | Resource level | qcs::cdb:${region}:uin/${uin}:instanceId/${InstanceId} | Supported |
| UnbindSensitiveRule | Unbind instance and sensitive detect rule | Resource level | qcs:id/0:cdb:gz:uin/100000983328:instanceId/cdb-e4qazvd8 | not supported |
| UpdateAgentSwitch | update agent switch | Operation level | * | Supported |
| UpdateDatabaseAutonomyStatus | Update instance database autonomy status | Resource level | qcs::dbbrain:${region}:uin/${uin}:instanceId/${instanceId} | Supported |
| UpdateDiagEventStatus | update diag event status | Resource level | qcs::dbbrain:${region}:uin/${uin}:instanceId/${instanceId} | Supported |
| UpdateEventAlarmRecordStatus | Block or not block | Resource level | qcs::dbbrain:${region}:uin/${uin}:instanceId/${instanceId} | Supported |
| UpdateInstanceConfig | update instance config | Operation level | * | Supported |
| UpdateInstanceUser | update instance user info | Operation level | * | not supported |
| UpdateMonitorSwitch | update monitor switch | Resource level | qcs::dbbrain:${region}:uin/${uin}:instanceId/${instanceId} | Supported |
| UpdateSlowLogSwitch | update slow log switch | Operation level | * | Supported |
| VerifyUserAccount | Verity user database account，get session token. | Resource level | qcs::dbbrain:${region}:uin/${uin}:instanceId/${instanceId} | Supported |
List Operations
| API | API Description | Authorization Granularity | Six-segment Resource Description | IP Restriction |
|---|---|---|---|---|
| DescribeAgentInstances | describe agent instances | Operation level | * | Supported |
| DescribeAgents | describe agents | Operation level | * | Supported |
| DescribeAlarmRules | Describe alarm rules | Operation level | * | Supported |
| DescribeDBDiagItem | describe diag item | Operation level | * | Supported |
| DescribeDBDiagItemTimeSeries | Get DB diag event items by timeSeries | Operation level | * | Supported |
| DescribeDiagInstanceGroups | describe Instance group info | Operation level | * | Supported |
| DescribeDirectInstances | describe direct instances | Operation level | * | Supported |
| DescribeInstanceTopSqls | Describe instance top sqls | Resource level | qcs::dbbrain:${region}:uin/${uin}:instanceId/${instanceId} | Supported |
| DescribeKilledThreadHistory | describe kill thread history | Resource level | qcs::dbbrain:${region}:uin/${uin}:instanceId/${InstanceId} | Supported |
| DescribeMailRecord | describe mail record | Operation level | * | Supported |
| DescribeMetricStatTopInstances | Get instances order by metric | Operation level | * | Supported |
| DescribeMetricTopInstances | Get instances by metric | Operation level | * | Supported |
| DescribeNodeComparingTask | Describe NodeComparing Task | Resource level | qcs::dbbrain:${region}:uin/${uin}:instanceId/${InstanceId} | Supported |
| DescribeRiskInstances | describe risk instances | Operation level | * | Supported |
| DescribeRiskProducts | describe risk products | Operation level | * | Supported |
| DescribeTopHealthScoreAvg | Get instances top health score list | Operation level | * | Supported |
| DescribeUserContact | Describe user contact | Operation level | * | Supported |
| DescribeUserGroup | describe user group | Operation level | * | Supported |
Read operations
| API | API Description | Authorization Granularity | Six-segment Resource Description | IP Restriction |
|---|---|---|---|---|
| DescribeAgentServicePorts | describe agent service ports | Operation level | * | Supported |
| DescribeAlarmPolicy | Describe alarm policy | Operation level | * | Supported |
| DescribeAlarmTemplate | User notice template list | Operation level | * | Supported |
| DescribeAlarmTemplateView | User notice template view | Operation level | * | Supported |
| DescribeAllNodeComparingResult | describe all node compare result | Resource level | qcs::dbbrain:${region}:uin/${uin}:instanceId/${InstanceId} | Supported |
| DescribeAllUserContact | Get all email contacts | Operation level | * | Supported |
| DescribeAllUserGroup | Get all email contact groups | Operation level | * | Supported |
| DescribeAuditInstanceList | Query the instance list from the business center | Operation level | * | Supported |
| DescribeAuditLogDimensionValues | Describe auditLog dimension values | Resource level | qcs::dbbrain:${region}:uin/${uin}:instanceId/${InstanceId} | Supported |
| DescribeAuditLogFiles | query audit log files | Resource level | qcs::dbbrain:${region}:uin/${uin}:instanceId/${instanceId} | Supported |
| DescribeAuditLogMetricRatio | Describe audit log metric ratio | Resource level | qcs:id/0:cdb:gz:uin/100000983328:instanceId/cdb-e4qazvd8 | not supported |
| DescribeAuditLogSeries | cdb audit indicator trend chart | Resource level | qcs::dbbrain:${region}:uin/${uin}:instanceId/${instanceId} | Supported |
| DescribeAuditLogSeriesForSqlTime | Describe audit log series for sql time | Resource level | qcs:id/0:cdb:gz:uin/100000983328:instanceId/cdb-e4qazvd8 | Supported |
| DescribeAuditLogStatsTasks | Describe audit log stats tasks | Resource level | qcs:id/0:cdb:gz:uin/100000983328:instanceId/cdb-e4qazvd8 | Supported |
| DescribeAuditLogTopSqls | Describe audit log top sql list | Resource level | qcs:id/0:cdb:gz:uin/100000983328:instanceId/cdb-e4qazvd8 | Supported |
| DescribeAuditLogs | querying audit logs | Resource level | qcs::dbbrain:${region}:uin/${uin}:instanceId/${instanceId} | Supported |
| DescribeBindRulesByGroupId | Query rule list bound to security group by group ID | Operation level | * | Supported |
| DescribeCloudInstances | describe cloud instances | Operation level | * | Supported |
| DescribeCollectionIndexInfo | Describe MongoDB instance collection index info | Resource level | qcs::dbbrain:${region}:uin/${uin}:instanceId/${instanceId} | Supported |
| DescribeDBAutonomyAction | Describe instance autonomy action | Resource level | qcs::dbbrain:${region}:uin/${uin}:instanceId/${instanceId} | Supported |
| DescribeDBAutonomyActionHistory | Describe instance autonomy action history | Resource level | qcs::dbbrain:${region}:uin/${uin}:instanceId/${instanceId} | Supported |
| DescribeDBAutonomyActions | Describe instance autonomy actions | Resource level | qcs::dbbrain:${region}:uin/${uin}:instanceId/${instanceId} | Supported |
| DescribeDBAutonomyEvents | Describe instance autonomy events | Resource level | qcs::dbbrain:${region}:uin/${uin}:instanceId/${instanceId} | Supported |
| DescribeDBDiagEvent | Get the details of an instance exception diagnosis event | Operation level | * | Supported |
| DescribeDBDiagEvents | Describe user all instances diag events. | Operation level | * | not supported |
| DescribeDBDiagHistory | Obtain instance diagnosis history | Operation level | * | Supported |
| DescribeDBDiagItemInstanceStatistics | Describe db diagItem instance | Resource level | qcs::dbbrain:${region}:uin/${uin}:instanceId/${InstanceId} | Supported |
| DescribeDBDiagItemOverview | Get an overview of abnormal alarms | Operation level | * | not supported |
| DescribeDBDiagItemStatistics | Describe DB Diag Item Statistics | Operation level | * | Supported |
| DescribeDBDiagItemTopInstances | DescribeDBDiagItemTopInstances | Operation level | * | Supported |
| DescribeDBDiagReport | Describe db diag report | Resource level | qcs:id/0:cdb:gz:uin/100000983328:instanceId/cdb-e4qazvd8 | Supported |
| DescribeDBDiagReportContent | Describe Diag Report Content | Resource level | qcs::dbbrain::uin/${uin}:instanceId/${instanceId} | Supported |
| DescribeDBDiagReportTasks | Retrieve health report generation task list | Operation level | * | Supported |
| DescribeDBPerfTimeSeries | Describe DB perf time series. | Resource level | qcs::dbbrain::uin/${uin}:instanceId/${instanceId} | Supported |
| DescribeDBSpaceStatus | Query space overview | Operation level | * | Supported |
| DescribeDailyReport | Describe daily report | Operation level | * | not supported |
| DescribeDailyReportSubscribes | describe daily report subscribes | Operation level | * | Supported |
| DescribeDatabaseAutonomyStatus | Describe instance database autonomy status | Resource level | qcs::dbbrain:${region}:uin/${uin}:instanceId/${instanceId} | Supported |
| DescribeDatabaseObject | Describe database object | Resource level | qcs::dbbrain:${region}:uin/${uin}:instanceId/${instanceId} | Supported |
| DescribeDeployAgentCommand | describe deploy agent command | Operation level | * | Supported |
| DescribeDiagDBInstanceNodes | Describe Instance and node | Operation level | * | Supported |
| DescribeDiagDBInstances | Get instances info list | Operation level | * | not supported |
| DescribeEventAlarmHistory | Describe event alarm history | Resource level | qcs::dbbrain:${region}:uin/${uin}:instanceId/${instanceId} | Supported |
| DescribeEventAlarmOperate | Describe block history list | Resource level | qcs::dbbrain:${region}:uin/${uin}:instanceId/${instanceId} | Supported |
| DescribeHealthScore | Get the health score and deduction for exceptions | Operation level | * | Supported |
| DescribeHealthScoreAndLevel | describe health score and level | Resource level | qcs::dbbrain:${region}:uin/${uin}:instanceId/${instanceId} | Supported |
| DescribeHealthScoreTimeSeries | Get health scoring trends | Resource level | qcs::dbbrain::uin/${uin}:instanceId/${InstanceId} | Supported |
| DescribeIgnoreDiagRecord | Get ignore diag record | Resource level | qcs::dbbrain:${region}:uin/${uin}:instanceId/${instanceId} | Supported |
| DescribeIndexBuildProgress | Describe instance index build progress | Resource level | qcs::dbbrain:${region}:uin/${uin}:instanceId/${instanceId} | Supported |
| DescribeIndexRecommendAggregationSlowLogs | Describe instance index recommend aggregation slow logs | Resource level | qcs::dbbrain:${region}:uin/${uin}:instanceId/${instanceId} | Supported |
| DescribeIndexRecommendInfo | Describe instance index recommend Info | Resource level | qcs::dbbrain:${region}:uin/${uin}:instanceId/${instanceId} | Supported |
| DescribeIndexRecommendSlowLogs | Describe instance index recommend slow logs | Resource level | qcs::dbbrain:${region}:uin/${uin}:instanceId/${instanceId} | Supported |
| DescribeInnodbHotUpdateDetectTasks | DescribeI Innodb DB hot update detect tasks | Resource level | qcs::dbbrain:${region}:uin/${uin}:instanceId/${instanceId} | Supported |
| DescribeInstanceAuditService | Describe instance audit service | Resource level | qcs::dbbrain:${region}:uin/${uin}:instanceId/${instanceId} | Supported |
| DescribeInstanceBusinessTag | Describe instance bussiness tag | Operation level | * | Supported |
| DescribeInstanceDBDiagOverview | describe instance diag overview | Resource level | qcs::dbbrain:${region}:uin/${uin}:instanceId/${InstanceId} | Supported |
| DescribeInstanceDBNodes | Describe instance DB nodes | Resource level | qcs::dbbrain:${region}:uin/${uin}:instanceId/${instanceId} | Supported |
| DescribeInstanceLatestDBDiagItem | describe instance latest diag item | Resource level | qcs::dbbrain:${region}:uin/${uin}:instanceId/${InstanceId} | Supported |
| DescribeInstanceProxyList | Describe instance proxy list | Resource level | qcs::dbbrain:${region}:uin/${uin}:instanceId/${instanceId} | Supported |
| DescribeInstanceStateTimeSeries | Get instance risk trend chart (risk/health) | Operation level | * | Supported |
| DescribeInstanceStatistics | describe instance statistics | Operation level | * | Supported |
| DescribeInstancesPerfTimeSeries | Get instance perf timeSeries | Operation level | * | Supported |
| DescribeKillTask | get kill threads task info | Resource level | qcs::dbbrain:${region}:uin/${uin}:instanceId/${instanceId} | Supported |
| DescribeKillTaskRecord | Get kill task record | Resource level | qcs::dbbrain:${region}:uin/${uin}:instanceId/${instanceId} | Supported |
| DescribeMailProfile | Get mail send profile | Operation level | * | Supported |
| DescribeMetricStatTopSecAuditGroups | Query risk distribution of security group | Operation level | * | Supported |
| DescribeMetricTopProxies | Describe instance metric top proxies | Resource level | qcs::dbbrain:${region}:uin/${uin}:instanceId/${InstanceId} | Supported |
| DescribeMongoDBProcessList | Query the real-time session list of MongoDB | Resource level | qcs::mongodb:${region}:uin/${uin}:instanceId/${InstanceId} | not supported |
| DescribeMongoDBSlowLogTopSqlList | Get the list of MongoDB slow sql templates | Resource level | qcs::dbbrain::uin/${uin}:instanceId/${InstanceId} | Supported |
| DescribeMongoStatus | Describe MongoDB instance mongostat | Resource level | qcs::dbbrain:${region}:uin/${uin}:instanceId/${instanceId} | Supported |
| DescribeMongoTop | Describe MongoDB instance mongotop | Resource level | qcs::dbbrain:${region}:uin/${uin}:instanceId/${instanceId} | Supported |
| DescribeMonitorSnapshot | Describe instance monitor snapshot | Resource level | qcs::dbbrain:${region}:uin/${uin}:instanceId/${instanceId} | Supported |
| DescribeMySqlProcessList | Describe mysql instance process list. | Resource level | qcs::dbbrain:${region}:uin/${uin}:instanceId/${InstanceId} | Supported |
| DescribeNoPrimaryKeyTables | Describe instance no primary key tables. | Resource level | qcs::dbbrain:${region}:uin/${uin}:instanceId/${instanceId} | Supported |
| DescribeOperationHistory | Describe instance operation history | Resource level | qcs::dbbrain:${region}:uin/${uin}:instanceId/${instanceId} | Supported |
| DescribeOptimizedHistory | Describe instance optimized history | Resource level | qcs::dbbrain:${region}:uin/${uin}:instanceId/${instanceId} | Supported |
| DescribePrivilegeGrantCommand | describe privilege grant command | Operation level | * | Supported |
| DescribeProcessList | Describe process list | Resource level | qcs:id/0:cdb:gz:uin/100000983328:instanceId/cdb-e4qazvd8 | Supported |
| DescribeProxyAggregationSeries | describe proxy aggregation series | Resource level | qcs::dbbrain:${region}:uin/${uin}:instanceId/${instanceId} | Supported |
| DescribeProxyProcessStatistics | Describe instance proxy process statistics | Resource level | qcs::dbbrain:${region}:uin/${uin}:instanceId/${instanceId} | Supported |
| DescribeProxySessionKillTasks | Describe redis instance kill proxy sessions task list. | Resource level | qcs::dbbrain:${region}:uin/${uin}:instanceId/${instanceId} | Supported |
| DescribeRedisBigKeyAnalysisTasks | Describe redis instance big key analysis tasks | Resource level | qcs::dbbrain:${region}:uin/${uin}:instanceId/${instanceId} | Supported |
| DescribeRedisCmdPerfTimeSeries | Describe redis instance command performance time series | Resource level | qcs::dbbrain:${region}:uin/${uin}:instanceId/${instanceId} | Supported |
| DescribeRedisCommandCostStatistics | Describe redis instance command cost statistics | Resource level | qcs::dbbrain:${region}:uin/${uin}:instanceId/${instanceId} | Supported |
| DescribeRedisCommandOverview | Describe redis instance command overview | Resource level | qcs::dbbrain:${region}:uin/${uin}:instanceId/${instanceId} | Supported |
| DescribeRedisProcessList | Describe redis instance process list. | Resource level | qcs::dbbrain:${region}:uin/${uin}:instanceId/${instanceId} | Supported |
| DescribeRedisProxyAttributes | Describe redis proxy attributes | Resource level | qcs::redis:${region}:uin/${uin}:instanceId/${InstanceId} | Supported |
| DescribeRedisSlowLogTopSqls | Get Redis Slow SQL Template List | Resource level | qcs::dbbrain::uin/${uin}:instanceId/${instanceId} | Supported |
| DescribeRedisTopBigKeys | Describe redis instance top keys. | Resource level | qcs::dbbrain:${region}:uin/${uin}:instanceId/${instanceId} | Supported |
| DescribeRedisTopCostCommands | Describe redis instance top cost commands | Resource level | qcs::dbbrain:${region}:uin/${uin}:instanceId/${instanceId} | Supported |
| DescribeRedisTopHotKeys | Describe redis instance top hot keys | Resource level | qcs::dbbrain:${region}:uin/${uin}:instanceId/${instanceId} | Supported |
| DescribeRedisTopKeyPrefixList | Describe redis top key prefix list | Resource level | qcs::dbbrain:${region}:uin/${uin}:instanceId/${instanceId} | Supported |
| DescribeRedisUnExpiredKeyStatistics | describe redis unExpired key statistics | Resource level | qcs::redis:${region}:uin/${uin}:instanceId/${InstanceId} | Supported |
| DescribeRiskHistory | describe risk history | Resource level | qcs::dbbrain:${region}:uin/${uin}:instanceId/${instanceId} | Supported |
| DescribeRiskSqlReport | describe risk sql report | Operation level | * | not supported |
| DescribeRiskSqlReportTasks | describe risk sql report tasks | Operation level | * | not supported |
| DescribeRiskSqlTimeSeries | Describe risk sql timeSeries | Operation level | * | Supported |
| DescribeRiskSqlTplReportTask | describe risk sql template report task | Operation level | * | Supported |
| DescribeRiskTplTrendTimeSeries | Get instance risk template change trend | Operation level | * | Supported |
| DescribeSecAuditGroups | Query security audit group list | Operation level | * | Supported |
| DescribeSecAuditInstances | Query security audit instance list | Operation level | * | Supported |
| DescribeSecAuditRules | describe security audit rules | Operation level | * | not supported |
| DescribeSecurityAuditLogDownloadUrls | Describe security audit log download urls | Operation level | * | Supported |
| DescribeSecurityAuditLogExportTasks | Describe security audit log export tasks | Operation level | * | Supported |
| DescribeSensitiveDetectResult | Describe sensitive detect result | Resource level | qcs:id/0:cdb:gz:uin/100000983328:instanceId/cdb-e4qazvd8 | not supported |
| DescribeSlowLogQueryTimeStats | Get Slow Log Segment Time Statistics | Resource level | qcs::dbbrain::uin/${uin}:instanceId/${instanceId} | Supported |
| DescribeSlowLogTimeSeriesStats | Describe slow log time series stats | Resource level | qcs::dbbrain::uin/${uin}:instanceId/${instanceId} | Supported |
| DescribeSlowLogTopProxyTimeSeries | Describe instance slow log top proxy time series | Resource level | qcs::dbbrain:${region}:uin/${uin}:instanceId/${instanceId} | Supported |
| DescribeSlowLogTopSqls | Describe slow log top sqls. | Resource level | qcs::dbbrain::uin/${uin}:instanceId/${instanceId} | not supported |
| DescribeSlowLogUserHostStats | Get the statistical distribution chart of slow log source addresses. | Resource level | qcs::dbbrain:${region}:uin/${uin}:instanceId/${instanceId} | Supported |
| DescribeSlowLogs | Describe slow logs. | Resource level | qcs::dbbrain:${region}:uin/${uin}:instanceId/${instanceId} | Supported |
| DescribeSqlAdvice | Describe sql advice | Resource level | qcs:id/0:cdb:gz:uin/100000983328:instanceId/cdb-e4qazvd8 | Supported |
| DescribeSqlAnalysisStatus | describe sql analysis status | Resource level | qcs::dbbrain:${region}:uin/${uin}:instanceId/${InstanceId} | Supported |
| DescribeSqlExplain | Describe sql explain | Resource level | qcs:id/0:cdb:gz:uin/100000983328:instanceId/cdb-e4qazvd8 | Supported |
| DescribeSqlFilters | Describe instance SQL filter tasks. | Resource level | qcs::dbbrain:${region}:uin/${uin}:instanceId/${instanceId} | Supported |
| DescribeSqlTemplate | Describe SQL template. | Resource level | qcs::dbbrain:${region}:uin/${uin}:instanceId/${instanceId} | Supported |
| DescribeSqlTemplateDetail | describe sql template detail | Resource level | qcs::dbbrain:${region}:uin/${uin}:instanceId/${InstanceId} | Supported |
| DescribeTableDDLDataRefreshTasks | Describe Table DDLData Refresh Task | Resource level | qcs::dbbrain:${region}:uin/${uin}:instanceId/${InstanceId} | Supported |
| DescribeTableSpaceData | Describe table space data | Resource level | qcs::dbbrain:${region}:uin/${uin}:instanceId/${instanceId} | Supported |
| DescribeTableSpaceDataRefreshTasks | refresh table table space data | Resource level | qcs::dbbrain:${region}:uin/${uin}:instanceId/${InstanceId} | Supported |
| DescribeTableSpaceTimeSeries | Describe table space time series | Resource level | qcs::dbbrain:${region}:uin/${uin}:instanceId/${instanceId} | Supported |
| DescribeTopSpaceSchemaLatestRecords | Describe the space metric data of top schemas collected at the latest timing | Resource level | qcs:id/0:cdb:gz:uin/100000983328:instanceId/cdb-e4qazvd8 | Supported |
| DescribeTopSpaceSchemaTimeSeries | Describe the daily space metric data statistics of top schemas in the specified time period | Operation level | * | Supported |
| DescribeTopSpaceSchemas | Describe instance top space schemas. | Resource level | qcs::dbbrain:${region}:uin/${uin}:instanceId/${instanceId} | Supported |
| DescribeTopSpaceTableLatestRecords | Describe the space metric data of top tables collected at the latest timing | Resource level | qcs:id/0:cdb:gz:uin/100000983328:instanceId/cdb-e4qazvd8 | Supported |
| DescribeTopSpaceTableTimeSeries | Describe the daily space metric data statistics of top tables in the specified time period | Operation level | * | Supported |
| DescribeTopSpaceTables | Get the space statistics of top tables of an instance | Operation level | * | Supported |
| DescribeUserAutonomyProfile | Describe user autonomy profile | Resource level | qcs::dbbrain:${region}:uin/${uin}:instanceId/${instanceId} | Supported |
| DescribeUserLatestDBDiagItem | Describe User Latest DBDiagItem | Operation level | * | not supported |
| DescribeUserPrivilege | describe user privilege | Resource level | qcs::dbbrain:${region}:uin/${uin}:instanceId/${InstanceId} | Supported |
| DescribeUserProfile | Get user profile | Operation level | * | Supported |
| DescribeUserReport | Describe User Report | Operation level | * | Supported |
| DescribeUserReportTasks | Query user security audit report task list | Operation level | * | Supported |
| DescribeUserSessionStatus | Describe user session status | Resource level | qcs::dbbrain:${region}:uin/${uin}:instanceId/${InstanceId} | Supported |
| DescribeUserSessions | Describe user sessions | Resource level | qcs::dbbrain:${region}:uin/${uin}:instanceId/${InstanceId} | Supported |
| DescribeUserSqlAdvice | Describe sql advice. | Resource level | qcs::dbbrain:${region}:uin/${uin}:instanceId/${instanceId} | Supported |
| DescribeUserSqlHistory | get kill user threads history | Resource level | qcs::dbbrain:${region}:uin/${uin}:instanceId/${instanceId} | Supported |
Other Operations
| API | API Description | Authorization Granularity | Six-segment Resource Description | IP Restriction |
|---|---|---|---|---|
| DescribePrettySql | pretty SQL | Resource level | qcs::dbbrain::uin/${uin}:instanceId/${InstanceId} | Supported |
| FeedbackAnalysisResult | feedback analysis result | Resource level | qcs::dbbrain:${region}:uin/${uin}:instanceId/${InstanceId} | not supported |
| PrepareAgent | prepare mysql agent | Operation level | * | Supported |
| TakeOverUserSession | take over user session | Resource level | qcs::dbbrain:${region}:uin/${uin}:instanceId/${InstanceId} | not supported |
Was this page helpful?
You can also Contact Sales or Submit a Ticket for help.
Yes
No
Feedback