文档首页/ 云数据库 GaussDB/ API参考/ 权限和授权项/ 身份策略授权参考
更新时间：2025-12-25 GMT+08:00
查看PDF
分享

身份策略授权参考

云服务在IAM预置了常用授权项，称为系统策略。如果IAM系统身份策略无法满足授权要求，管理员可以根据各服务支持的授权项，创建IAM自定义身份策略来进行精细的访问控制，IAM自定义身份策略是对系统身份策略的扩展和补充。

除IAM服务外，Organizations服务中的服务控制策略（Service Control Policies，以下简称SCP）也可以使用这些授权项元素设置访问控制策略。

SCP不直接进行授权，只划定权限边界。将SCP绑定到组织单元或者成员账号时，并没有直接对组织单元或成员账号授予操作权限，而是规定了成员账号或组织单元包含的成员账号的授权范围。IAM身份策略授予权限的有效性受SCP限制，只有在SCP允许范围内的权限才能生效。

IAM服务与Organizations服务在使用这些元素进行访问控制时，存在着一些区别，详情请参见：IAM服务与Organizations服务权限访问控制的区别。

本章节介绍IAM服务身份策略授权场景中自定义身份策略和组织服务中SCP使用的元素，这些元素包含了操作（Action）、资源（Resource）和条件（Condition）。

操作（Action）

操作（Action）即为身份策略中支持的授权项。

  • “访问级别”列描述如何对操作进行分类（list、read和write等）。此分类可帮助您了解在身份策略中相应操作对应的访问级别。
  • “资源类型”列指每个操作是否支持资源级权限。
    • 资源类型支持通配符号*表示所有。如果此列没有值（-），则必须在身份策略语句的Resource元素中指定所有资源类型（“*”）。
    • 如果该列包含资源类型，则必须在具有该操作的语句中指定该资源的URN。
    • 资源类型列中必需资源在表中用星号（*）标识，表示使用此操作必须指定该资源类型。

    关于GaussDB定义的资源类型的详细信息请参见资源类型（Resource）。

  • “条件键”列包括了可以在身份策略语句的Condition元素中GaussDB支持指定的键值。如果此列没有值（-），表示此操作不支持指定条件键。

    关于GaussDB定义的条件键的详细信息请参见条件（Condition）。

  • “别名”列包括了可以在身份策略中配置的策略授权项。通过这些授权项，可以控制支持策略授权的API访问。详细信息请参见身份策略兼容性说明。

您可以在身份策略语句的Action元素中指定以下GaussDB的相关操作。

表1 GaussDB支持的授权项

授权项

描述

访问级别

资源类型（*为必须）

条件键

别名

gaussdb::updateDownloadPolicy

授予编辑下载策略的权限。

write

-

gaussdb:DownloadCategory

-

gaussdb::getDownloadPolicy

授予查询下载策略的权限。

read

-

-

-

gaussdb::listComputeResourcePackage

授予查询计算配额的权限。

list

-

-

gaussdb:instance:listComputeResourcePackage

gaussdb::purchaseResourcePackage

授予购买计算配额权限。

write

-

-

gaussdb:instance:purchaseResourcePackage

gaussdb::modifyHotfix

授予修改热补丁属性的权限。

write

-

-

gaussdb:hotfix:modify

gaussdb::listNetwork

授予查询网络详情信息的权限。

list

-

-

gaussdb:instance:listNetwork

gaussdb::purchaseSubscriptionCode

授予购买订阅码权限。

write

-

-

gaussdb:instance:purchaseSubscriptionCode

gaussdb::listSubscriptionCode

授予查询订阅码列表信息的权限。

list

-

-

gaussdb:instance:listSubscriptionCode

gaussdb::activateSubscriptionCode

授予激活订阅码权限。

write

-

-

gaussdb:instance:activateSubscriptionCode

gaussdb::downloadSubscriptionCode

授予下载订阅码的权限。

read

-

-

gaussdb:instance:downloadSubscriptionCode

gaussdb::expireSubscriptionCode

授予失效订阅码权限。

write

-

-

gaussdb:instance:expireSubscriptionCode

gaussdb::applyApproval

授予申请订阅码权限。

write

-

-

gaussdb:instance:applyApproval

gaussdb::updateApproval

授予修改订阅码申请权限。

write

-

-

gaussdb:instance:updateApproval

gaussdb::listApproval

授予展示订阅码申请列表。

list

-

-

gaussdb:instance:listApproval

gaussdb::getSubscriptionCodeStatistics

授予获取订阅码统计信息。

read

-

-

gaussdb:instance:getSubscriptionCodeStatistics

gaussdb:backup:createBackup

授予创建数据库实例手动备份的权限。

write

instance

-

gaussdb:backup:create

gaussdb:backup:deleteBackup

授予删除备份的权限。

write

instance

-

gaussdb:backup:delete

gaussdb:backup:get

授予查询备份信息的权限。

read

-

-

gaussdb:instance:list

gaussdb:backup:listAll

授予查询备份列表的权限。

list

instance

-

gaussdb:backup:list

gaussdb:backup:download

授予下载备份文件的权限。

read

-

-

gaussdb:backup:list

gaussdb:backup:syncOffSiteBackupData

授予跨区域备份数据同步的权限。

write

-

-

gaussdb:instance:modifyBackupPolicy

gaussdb:backup:check

授予校验备份相关信息的权限。

read

-

-

gaussdb:instance:list

gaussdb:backup:changeBackupMedia

授予切换备份介质的权限。

write

instance

-

-

gaussdb:backup:stopBackup

授予停止进行中的备份的权限。

write

instance

-

-

gaussdb:instance:updateBackupPolicy

授予设置备份策略的权限。

write

instance

gaussdb:BackupEnabled
  • gaussdb:backup:enable
  • gaussdb:backup:switchTableBackup
  • gaussdb:instance:modifyBackupPolicy

gaussdb:param:applyParam

授予应用参数模板的权限。

write

-

-
  • gaussdb:param:apply
  • gaussdb:param:modify
  • gaussdb:instance:modifyParameter

gaussdb:tag:create

授予添加资源标签的权限。

tagging

instance

-

gaussdb:instance:dealTag

gaussdb:tag:update

授予修改资源标签的权限。

tagging

instance

-

gaussdb:instance:dealTag

gaussdb:tag:delete

授予删除资源标签的权限。

tagging

instance

-

gaussdb:instance:dealTag

gaussdb:instance:bindLtsConfig

授予关联LTS日志流的权限。

write

-

-
  • gaussdb:instance:modify
  • gaussdb:instance:operateRuningLog

gaussdb:instance:bindEIP

授予绑定弹性公网IP的权限。

write

instance

-
  • gaussdb:instance:bindPublicIp
  • gaussdb:instance:modify

gaussdb:instance:operateNodeGroup

授予操作节点组的权限。

write

instance

-

gaussdb:instance:modify

gaussdb:instance:changeVolumeType

授予磁盘类型变更的权限。

write

instance

-

-

gaussdb:instance:check

授予校验实例相关信息的权限。

read

-

-

gaussdb:instance:list

gaussdb:instance:createInstance

授予创建数据库实例的权限。

write

instance

gaussdb:instance:create

gaussdb:instance:createDatabase

授予创建数据库的权限。

write

instance

-

gaussdb:instance:modify

gaussdb:instance:createDatabaseSchema

授予创建数据库Schema的权限。

write

instance

-

gaussdb:instance:modify

gaussdb:instance:createDatabaseUser

授予创建数据库用户的权限。

write

instance

-

gaussdb:instance:modify

gaussdb:instance:deleteInstance

授予删除数据库实例的权限。

write

instance

-

gaussdb:instance:delete

gaussdb:instance:downloadSlowLog

授予下载慢日志的权限。

read

instance

-

gaussdb:instance:list

gaussdb:instance:expandReadonlyNode

授予创建只读节点的权限。

write

instance

-

-

gaussdb:instance:forceSwitch

授予操作强切开关的权限。

write

instance

-

gaussdb:instance:modify

gaussdb:instance:get

授予查询实例详情的权限。

read

instance

-

gaussdb:instance:list

gaussdb:instance:getBackupPolicy

授予查询自动备份策略的权限。

read

instance

-
  • gaussdb:instance:list
  • gaussdb:backup:list

gaussdb:instance:getBalanceStatus

授予查询实例主备平衡状态的权限。

read

instance

-

gaussdb:instance:list

gaussdb:instance:getLogCollectionStatus

授予查询错误日志收集开关状态的权限。

read

instance

-

gaussdb:instance:list

gaussdb:instance:getMetricDataCollectionPeriod

授予查询实例指标采样周期的权限。

read

instance

-
  • gaussdb:instance:list
  • gaussdb:instance:secondLevelMonitoring

gaussdb:instance:getDiskUsage

授予查询磁盘使用率的权限。

read

-

-

gaussdb:instance:list

gaussdb:instance:getRetrieveXLogStatus

授予查询实例回收XLog开关状态的权限。

read

instance

-

gaussdb:instance:list

gaussdb:instance:getRecyclePolicy

授予查看实例回收备份策略的权限。

read

instance

-

gaussdb:instance:list

gaussdb:instance:downloadSslCert

授予下载实例SSL证书的权限。

read

instance

-

gaussdb:instance:list

gaussdb:instance:grantDatabasePrivilege

授予授权数据库账号的权限。

write

instance

-

gaussdb:instance:modify

gaussdb:instance:listAll

授予查询数据库实例列表的权限。

list

-

-

gaussdb:instance:list

gaussdb:instance:listAvailabilityZones

授予查询可用区的权限。

list

-

-

gaussdb:instance:list

gaussdb:instance:listTopIoInfo

授予查询io流量的权限。

list

instance

-

-

gaussdb:instance:listPublicIps

授予查询实例已绑定EIP列表的权限。

list

instance

-

gaussdb:instance:list

gaussdb:instance:listCoordinatorNodes

授予查询实例协调节点信息列表的权限。

list

instance

-

gaussdb:instance:list

gaussdb:instance:listComponents

授予查询实例组件列表的权限。

list

instance

-

gaussdb:instance:list

gaussdb:instance:listDatabases

授予查询数据库列表的权限。

list

instance

-

gaussdb:instance:list

gaussdb:instance:listDatabaseUsers

授予查询数据库用户列表的权限。

list

instance

-

gaussdb:instance:list

gaussdb:instance:downloadRetrieveXLog

授予下载实例的XLog的权限。

read

instance

-

gaussdb:instance:list

gaussdb:instance:listLtsConfigs

授予查看LTS日志配置信息的权限。

list

-

-

gaussdb:instance:list

gaussdb:tag:listAll

授予查询资源标签列表的权限。

list

-

-

gaussdb:instance:list

gaussdb:instance:listTagsForResource

授予查询指定资源标签的权限。

list

instance

-

gaussdb:instance:list

gaussdb:tag:listResourceByTag

授予根据标签过滤资源的权限。

list

-

-

gaussdb:instance:list

gaussdb:quota:listAll

授予查询配额列表的权限。

list

-

-

gaussdb:instance:list

gaussdb:instance:listReadonlyNodes

授予查询实例只读节点信息的权限。

list

instance

-

gaussdb:instance:list

gaussdb:instance:listRecoverableTimes

授予查询备份可恢复时间段的权限。

list

instance

-
  • gaussdb:instance:list
  • gaussdb:backup:list

gaussdb:instance:listSchemas

授予查询数据库Schema列表的权限。

list

instance

-

gaussdb:instance:list

gaussdb:instance:listTables

授予查询数据库表列表的权限。

list

instance

-

gaussdb:instance:list

gaussdb:instance:listTableBackupStatus

授予查询表备份状态信息的权限。

list

-

-

gaussdb:instance:list

gaussdb:instance:listRecord

授予查询操作记录的权限。

read

instance

-

-

gaussdb:instance:updateRetrieveXLogStatus

授予实例回收XLog开关的权限。

write

instance

-

gaussdb:instance:modifyRetrieveXLogStatus

gaussdb:instance:operateAuditLog

授予操作审计日志的权限。

write

instance

-

gaussdb:instance:modify

gaussdb:instance:operateRunningLog

授予操作运行日志的权限。

write

instance

-
  • gaussdb:instance:modify
  • gaussdb:instance:operateRuningLog
  • gaussdb:instance:operateErrorLog

gaussdb:instance:operateSlowLog

授予操作慢日志的权限。

write

instance

-

gaussdb:instance:modify

gaussdb:instance:rebalancedShard

授予操作实例重平衡的权限。

write

instance

-
  • gaussdb:instance:modify
  • gaussdb:instance:rebalanceShard

gaussdb:instance:reduceNode

授予节点缩容的权限。

write

instance

-

-

gaussdb:instance:reduceReadonlyNode

授予删除只读节点的权限。

write

instance

-

-

gaussdb:instance:reduceReplica

授予副本缩容的权限。

write

instance

-

gaussdb:instance:modify

gaussdb:instance:renameInstance

授予重置实例名称的权限。

write

instance

-
  • gaussdb:instance:modify
  • gaussdb:instance:rename

gaussdb:instance:resetPassword

授予重置数据库密码的权限。

write

instance

-
  • gaussdb:instance:modify
  • gaussdb:instance:modifyPasswd
  • gaussdb:instance:modifyDatabasePasswd

gaussdb:instance:resizeFlavor

授予变更实例规格的权限。

write

instance

-
  • gaussdb:instance:modify
  • gaussdb:instance:modifySpec

gaussdb:instance:restartInstance

授予重启数据库实例的权限。

write

instance

-
  • gaussdb:instance:modify
  • gaussdb:instance:restart

gaussdb:instance:stop

授予停止数据库实例的权限。

write

instance

-

-

gaussdb:instance:start

授予启动数据库实例的权限。

write

instance

-

-

gaussdb:instance:restoreInstanceInPlace

授予备份恢复原实例的权限。

write

-

-
  • gaussdb:backup:restoreInPlace
  • gaussdb:instance:restoreInPlace

gaussdb:instance:setRecyclePolicy

授予设置实例回收备份策略的权限。

write

-

-

gaussdb:instance:modifyBackupPolicy

gaussdb:instance:switchShard

授予分片节点主备切换的权限。

write

instance

-

gaussdb:instance:modify

gaussdb:instance:unbindLtsConfig

授予解除关联LTS日志流的权限。

write

-

-
  • gaussdb:instance:modify
  • gaussdb:instance:operateRuningLog

gaussdb:instance:setInstanceExtendInfo

授予设置实例扩展信息的权限。

write

-

-

-

gaussdb:instance:switchConsistencyProtocol

授予切换一致性协议的权限。

write

instance

-

-

gaussdb:instance:switchReplica

授予副本角色切换的权限。

write

instance

-

gaussdb:instance:swichReplica

gaussdb:instance:migration

授予GaussDB实例间数据迁移的权限。

write

instance

-

-

gaussdb:instance:extend

授予扩容相关操作的权限。

write

instance

-

gaussdb:instance:modifySpec

gaussdb:instance:unbindEIP

授予解绑弹性公网IP的权限。

write

instance

-
  • gaussdb:instance:modify
  • gaussdb:instance:unbindPublicIp

gaussdb:instance:updateMetricDataCollectionPeriod

授予修改实例指标采样周期的权限。

write

instance

-

gaussdb:instance:secondLevelMonitoring

gaussdb:instance:updatePort

授予修改数据库端口的权限。

write

instance

-
  • gaussdb:instance:modify
  • gaussdb:instance:modifyPort

gaussdb:instance:updateDescription

授予修改实例备注的权限。

write

instance

-

gaussdb:instance:modify

gaussdb:instance:upgradeDatabaseVersion

授予升级数据库版本的权限。

write

instance

-

gaussdb:instance:modify

gaussdb:instance:listErrorLog

授予查询数据库错误日志的权限。

list

instance

-

gaussdb:instance:list

gaussdb:instance:autoEnlargePolicy

授予修改磁盘自动扩容策略的权限。

write

instance

-

-

gaussdb:instance:dropDatabase

授予删除数据库的权限。

write

instance

-

gaussdb:instance:modify

gaussdb:instance:deleteTaskRecord

授予删除任务记录的权限。

write

-

-

gaussdb:instance:modify

gaussdb:instance:switchHaStrategy

授予修改实例高可用策略的权限。

write

instance

-

-

gaussdb:instance:changeDeploymentSolution

授予变更实例数据库部署方案的权限。

write

instance

-

-

gaussdb:instance:getWorkloadManager

授予查询控制组的权限。

read

instance

-

-

gaussdb:instance:deleteCgroup

授予删除控制组的权限。

write

instance

-

-

gaussdb:instance:createCgroup

授予创建控制组的权限。

write

instance

-

-

gaussdb:instance:modifyCgroup

授予更改控制组的权限。

write

instance

-

-

gaussdb:instance:createResourcePool

授予创建资源池的权限。

write

instance

-

-

gaussdb:instance:modifyResourcePool

授予更改资源池的权限。

write

instance

-

-

gaussdb:instance:deleteResourcePool

授予删除资源池的权限。

write

instance

-

-

gaussdb:instance:listFeatures

授予查询高级特性的权限。

write

instance

-

-

gaussdb:instance:updateFeatures

授予修改高级特性的权限。

write

instance

-

-

gaussdb:user:addOrUpdate

授予新增或修改用户的权限。

write

instance

-

-

gaussdb:instance:bindDNS

授予购买绑定内网域名权限。

write

instance

-

-

gaussdb:instance:createDataRecovery

授予数据找回的权限。

write

instance

-

-

gaussdb:instance:reduceVolume

授予磁盘缩容的权限。

write

instance

-

gaussdb:instance:modifySpec

gaussdb:instance:createSQLLimitRule

授予创建SQL限流任务的权限。

write

instance

-

-

gaussdb:instance:updateSQLLimitRule

授予修改SQL限流任务的权限。

write

instance

-

-

gaussdb:instance:deleteSQLLimitRule

授予删除SQL限流任务的权限。

write

instance

-

-

gaussdb:instance:getSQLLimitRule

授予查询SQL限流任务详情的权限。

read

instance

-

-

gaussdb:instance:getSQLLimitRuleTemplate

授予查询SQL模板列表的权限。

list

instance

-

-

gaussdb:instance:getSQLLimitRules

授予查询SQL限流任务列表的权限。

list

instance

-

-

gaussdb:instance:synchronizeSQLLimitRule

授予同步SQL限流任务的权限。

write

instance

-

-

gaussdb:instance:listSlowSqlExecuteNode

授予查询SQL执行节点列表的权限。

list

instance

-

-

gaussdb:instance:listTopSql

授予查询TOP SQL列表的权限。

list

instance

-

-

gaussdb:instance:listSlowSql

授予查询慢SQL列表的权限。

list

instance

-

-

gaussdb:instance:getSlowSqlDetail

授予查询慢SQL详情的权限。

read

instance

-

-

gaussdb:instance:enableFullSql

授予开启或重新开启全量SQL的权限。

write

instance

-

-

gaussdb:instance:disableFullSql

授予关闭全量SQL的权限。

write

instance

-

-

gaussdb:instance:listFullSqls

授予查询全量SQL日志记录列表的权限。

list

instance

-

-

gaussdb:instance:listFullSqlStatistics

授予查询全量SQL统计列表的权限。

list

instance

-

-

gaussdb:instance:listFullSqlSwitches

授予查询全量SQL开关记录列表的权限。

list

instance

-

-

gaussdb:instance:getFullSql

授予查询全量SQL详情的权限。

list

instance

-

-

gaussdb:instance:listSqlLinks

授予查询SQL链路列表的权限。

list

instance

-

-

gaussdb:instance:listKeyViewExecuteNode

授予查询数据库关键视图执行节点列表的权限。

list

instance

-

-

gaussdb:instance:listRealTimeSession

授予查询数据库实时会话列表的权限。

list

instance

-

-

gaussdb:instance:killSession

授予终止数据库会话的权限。

write

instance

-

-

gaussdb:instance:killFreeSession

授予终止数据库空闲会话的权限。

write

instance

-

-

gaussdb:instance:startMySQLCompatibility

授予开启M兼容端口的权限。

write

instance

-

-

gaussdb:instance:updateMySQLCompatibility

授予修改/关闭M兼容端口的权限。

write

instance

-

-

gaussdb:instance:listDatabaseRoles

授予查询数据库角色列表的权限。

list

instance

-

-

gaussdb:instance:createDatabaseRole

授予创建数据库角色的权限。

write

instance

-

-

gaussdb:instance:dropDatabaseRole

授予删除数据库角色的权限。

write

instance

-

-

gaussdb:instance:dropDatabaseSchema

授予删除数据库schema的权限。

write

instance

-

-

gaussdb:instance:killTransaction

授予查杀数据库事务的权限。

write

instance

-

-

gaussdb:instance:listTransaction

授予查询数据库事务列表的权限。

list

instance

-

-

gaussdb:instance:getAutoKillTransactionConfig

授予获取自动查杀事务配置的权限。

read

instance

-

-

gaussdb:instance:configAutoKillTransaction

授予配置自动查杀事务的权限。

write

instance

-

-

gaussdb:instance:listSessionWaitEvents

授予查询等待事件列表的权限。

list

instance

-

-

gaussdb:instance:getSlowSqlStack

授予查询SQL堆栈信息的权限。

read

instance

-

-

gaussdb:instance:getSlowSqlPlan

授予查询SQL执行计划的权限。

read

instance

-

-

gaussdb:instance:listAspReport

授予查询asp采集状态和结果列表的权限。

list

instance

-

-

gaussdb:instance:operateAspReport

授予asp采集操作的权限。

write

instance

-

-

gaussdb:instance:getWdrSnapshotStatus

授予获取WDR快照数据开关状态的权限。

read

instance

-

-

gaussdb:instance:switchWdrSnapshotStatus

授予切换WDR快照数据开关的权限。

write

instance

-

-

gaussdb:instance:listWdr

授予查询WDR报告列表的权限。

list

instance

-

-

gaussdb:instance:createWdrSnapshot

授予生成WDR快照的权限。

write

instance

-

-

gaussdb:instance:generateWdr

授予生成WDR报告的权限。

write

instance

-

-

gaussdb:instance:listProblematicSessions

授予查询异常会话列表的权限。

list

instance

-

-

gaussdb:pdb:create

授予创建PDB的权限。

write

instance

-

-

gaussdb:pdb:delete

授予删除PDB的权限。

write

instance

-

-

gaussdb:pdb:list

授予查询PDB列表的权限。

list

instance

-

-

gaussdb:pdb:modify

授予修改PDB的权限。

write

instance

-

-

gaussdb:instance:switchKmsTde

授予使用透明加密的权限。

write

instance

-

-

gaussdb:instance:listHbaInfo

授予查询客户端接入认证的权限。

list

instance

-

-

gaussdb:instance:addHbaInfo

授予添加客户端接入认证的权限。

write

instance

-

-

gaussdb:instance:updateHbaInfo

授予修改客户端接入认证的权限。

write

instance

-

-

gaussdb:instance:dropHbaInfo

授予删除客户端接入认证的权限。

write

instance

-

-

gaussdb:instance:listHbaInfoHistory

授予查询客户端接入认证修改历史的权限。

list

instance

-

-

gaussdb:instance:restoreHbaInfo

授予恢复客户端接入认证的权限。

write

instance

-

-

gaussdb:databaseUser:drop

授予删除用户的权限。

write

instance

-

-

gaussdb:metric:list

授予查询云数据库GaussDB的监控指标的权限。

list

-

-

-

gaussdb:alarm:list

授予查询告警历史记录的权限。

list

-

-

-

gaussdb:param:update

授予修改参数组的权限。

write

-

-
  • gaussdb:param:modify
  • gaussdb:instance:modify
  • gaussdb:instance:modifyParameter

gaussdb:param:check

授予校验参数组的权限。

read

-

-
  • gaussdb:param:list
  • gaussdb:instance:list

gaussdb:param:copy

授予复制参数模板的权限。

write

-

-

gaussdb:param:create

gaussdb:param:createParam

授予创建参数组的权限。

write

-

-
  • gaussdb:param:create
  • gaussdb:param:modify

gaussdb:param:deleteParam

授予删除参数组的权限。

write

-

-

gaussdb:param:delete

gaussdb:param:get

授予查询参数配置详情的权限。

read

-

-
  • gaussdb:param:list
  • gaussdb:instance:list

gaussdb:param:compare

授予比较两个参数模板之间差异的权限。

read

-

-

gaussdb:param:list

gaussdb:param:listAll

授予查询参数组列表的权限。

list

-

-
  • gaussdb:param:list
  • gaussdb:instance:list

gaussdb:param:reset

授予重置参数模板的权限。

write

-

-

gaussdb:param:modify

gaussdb:quota:update

授予修改配额的权限。

write

-

-

gaussdb:quota:modify

gaussdb:task:listAll

授予查询任务列表的权限。

list

-

-

gaussdb:instance:list

gaussdb:task:delete

授予删除任务记录的权限。

write

-

-

gaussdb:instance:deleteTaskRecord

gaussdb:task:get

授予查询任务详情的权限。

read

-

-

gaussdb:instance:list

gaussdb:disasterRecovery:create

授予搭建容灾关系的权限。

write

instance

-
  • gaussdb:instance:create
  • gaussdb:disasterRecovery:construct

gaussdb:disasterRecovery:delete

授予删除容灾记录的权限。

write

instance

-

gaussdb:instance:create

gaussdb:disasterRecovery:failover

授予手动故障切换的权限。

write

instance

-
  • gaussdb:instance:create
  • gaussdb:instance:modify

gaussdb:disasterRecovery:get

授予查看容灾信息的权限。

read

instance

-
  • gaussdb:instance:list
  • gaussdb:disasterRecovery:list

gaussdb:disasterRecovery:keeplog

授予操作容灾日志保持的权限。

write

instance

-

gaussdb:disasterRecovery:construct

gaussdb:disasterRecovery:listAll

授予查询容灾列表信息的权限。

list

-

-
  • gaussdb:instance:list
  • gaussdb:disasterRecovery:list

gaussdb:disasterRecovery:check

授予容灾检查的权限。

read

-

-
  • gaussdb:instance:list
  • gaussdb:disasterRecovery:list

gaussdb:disasterRecovery:release

授予解除容灾关系的权限。

write

instance

-
  • gaussdb:instance:create
  • gaussdb:instance:modify

gaussdb:disasterRecovery:simulation

授予进行容灾演练的权限。

write

instance

-

gaussdb:disasterRecovery:construct

gaussdb:disasterRecovery:switchover

授予容灾集群主备切换的权限。

write

instance

-
  • gaussdb:instance:create
  • gaussdb:instance:modify

gaussdb:disasterRecovery:update

授予修改容灾配置的权限。

write

instance

-

gaussdb:instance:modify

GaussDB的API通常对应着一个或多个授权项。如下表展示了API与授权项的关系，以及该API需要依赖的授权项。

表2 实例管理

权限

API

对应的授权项

依赖的授权项

绑定/解绑弹性公网IP

POST /v3/{project_id}/instances/{instance_id}/nodes/{node_id}/public-ip

gaussdb:instance:bindEIP

-

创建数据库实例

POST /v3.2/{project_id}/instances

gaussdb:instance:createInstance

如果使用KMS密钥创建磁盘加密实例，依赖以下权限：

kms:cmk:createGrant

创建只读节点

POST /v3/{project_id}/instances/{instance_id}/readonly-nodes

gaussdb:instance:expandReadonlyNode

-

扩容数据库实例的磁盘空间

POST /v3/{project_id}/instances/{instance_id}/action

gaussdb:instance:extend

-

删除数据库实例

DELETE /v3/{project_id}/instances/{instance_id}

gaussdb:instance:delete

-

删除只读节点

DELETE /v3/{project_id}/instances/{instance_id}/readonly-nodes

gaussdb:instance:reduceReadonlyNode

-

分片缩容

DELETE /v3/{project_id}/instances/{instance_id}/sharding

gaussdb:instance:reduceNode

-

查询数据库实例列表/查询实例详情

GET /v3.3/{project_id}/instances

gaussdb:instance:listAll

-

查询协调节点列表

GET /v3/{project_id}/instances/{instance_id}/coordinators

gaussdb:instance:listCoordinatorNodes

-

查询实例的组件列表

GET /v3/{project_id}/instances/{instance_id}/components

gaussdb:instance:listComponents

-

查询企业项目列表

GET /v3/{project_id}/enterprise-projects

gaussdb:instance:listAll

-

查询实例特性列表

GET /v3/{project_id}/instances/{instance_id}/advance-features

gaussdb:instance:listFeatures

-

查询数据库实例列表

GET /v3/{project_id}/instances

gaussdb:instance:listAll

-

重置数据库密码

POST /v3/{project_id}/instances/{instance_id}/password

gaussdb:instance:resetPassword

-

修改实例名称

PUT /v3/{project_id}/instances/{instance_id}/name

gaussdb:instance:rename

-

重启数据库实例

POST /v3/{project_id}/instances/{instance_id}/restart

gaussdb:instance:restart

-

分片节点主备切换

POST /v3/{project_id}/instances/{instance_id}/switch-shard

gaussdb:instance:switchShard

-

查询实例的组件列表

GET /v3/{project_id}/instances/{instance_id}/components

gaussdb:instance:listComponents

-

规格变更

PUT /v3/{project_id}/instance/{instance_id}/flavor

gaussdb:instance:resizeFlavor

-

查询实例主备平衡状态

GET /v3/{project_id}/instances/{instance_id}/balance

gaussdb:instance:getBalanceStatus

-

查询解决方案模板配置

GET /v3/{project_id}/deployment-form

gaussdb:instance:listAll

-

查询已绑定的EIP列表

GET /v3/{project_id}/instances/{instance_id}/public-ips?offset={offset}&limit={limit}

gaussdb:instance:listPublicIps

-

绑定/解绑弹性公网IP

POST /v3/{project_id}/instances/{instance_id}/nodes/{node_id}/public-ip

gaussdb:instance:bindEIP

-

查询实例SSL证书下载地址

GET /v3/{project_id}/instances/{instance_id}/ssl-cert/download-link

gaussdb:instance:downloadSslCert

-

查询租户的实例配额

GET /v3/{project_id}/project-quotas?type={type}

gaussdb:quota:listAll

-

设置下载策略

GET /v3/{project_id}/download/policy

gaussdb::updateDownloadPolicy

-

查询下载策略

POST /v3/{project_id}/update/download/policy

gaussdb::getDownloadPolicy

-

查询客户端接入认证配置修改历史

GET /v3/{project_id}/instances/{instance_id}/hba-info/history

gaussdb:instance:listHbaInfoHistory

-

查询KMS密钥列表

GET /v3/{project_id}/kms/list-keys/{kms_project_name}

gaussdb:instance:listAll

-

查询只读节点信息

GET /v3/{project_id}/instances/{instance_id}/readonly-nodes

gaussdb:instance:listReadonlyNodes

-

修改磁盘自动扩容策略

PUT /v3/{project_id}/instances/{instance_id}/auto-enlarge-policy

gaussdb:instance:autoEnlargePolicy

-

修改指定实例端口号

PUT /v3/{project_id}/instances/{instance_id}/port

gaussdb:instance:updatePort

-

CN横向扩容/DN分片扩容/磁盘扩容

POST /v3/{project_id}/instances/{instance_id}/action

gaussdb:instance:extend

-

查询磁盘自动扩容策略

GET /v3/{project_id}/instances/{instance_id}/auto-enlarge-policy

gaussdb:instance:listAll

-

查询实例主备平衡状态

GET /v3/{project_id}/instances/{instance_id}/balance

gaussdb:instance:getBalanceStatus

-

查询解决方案模板配置

GET /v3/{project_id}/deployment-form

gaussdb:instance:listAll

-

查询KMS密钥详情

GET /v3/{project_id}/kms/{kms_key_id}/describe-key/{kms_project_name}

gaussdb:instance:listAll

-

查询重分布参数设置模板

GET /v3/{project_id}/redistribution-parameters

gaussdb:instance:listAll

-

协调节点缩容

DELETE /v3/{project_id}/instances/{instance_id}/coordinators

gaussdb:instance:reduceNode

-

启动实例/节点

POST /v3/{project_id}/instances/{instance_id}/db-startup

gaussdb:instance:start

-

开启M兼容端口服务

POST /v3/{project_id}/instances/{instance_id}/mysql-compatibility

gaussdb:instance:startMySQLCompatibility

-

停止实例/节点

POST /v3/{project_id}/instances/{instance_id}/db-stop

gaussdb:instance:stop

-

开启透明加密

PUT /v3/{project_id}/instances/{instance_id}/kms-tde/switch

gaussdb:instance:switchKmsTde

-

分布式实例一主一备一日志形态切换到一主两备形态

POST /v3/{project_id}/instances/{instance_id}/switch-replica

gaussdb:instance:switchReplica

-

分片节点主备切换。

POST /v3/{project_id}/instances/{instance_id}/switch-shard

gaussdb:instance:switchShard

-

修改扩容优化参数

PUT /v3/{project_id}/instances/{instance_id}/expansion-parameters

gaussdb:param:update

-

开启特性

POST /v3/{project_id}/instances/{instance_id}/advance-features

gaussdb:instance:updateFeatures

-

修改实例别名

PUT /v3/{project_id}/instances/{instance_id}/alias

gaussdb:instance:updateDescription

-

实例内核版本升级

PUT /v3/{project_id}/instance/{instance_id}/db-upgrade

gaussdb:instance:upgradeDatabaseVersion

-

更新/关闭M兼容端口服务

PUT /v3/{project_id}/instances/{instance_id}/mysql-compatibility

gaussdb:instance:updateMySQLCompatibility

-

修改重分布参数

PUT /v3/{project_id}/instances/{instance_id}/redistribution-parameters

gaussdb:param:update

-
表3 参数配置

权限

API

对应的授权项

依赖的授权项

获取参数模板列表

GET /v3.2/{project_id}/configurations?offset={offset}&limit={limit}

gaussdb:param:listAll

-

获取指定实例的参数

GET /v3.2/{project_id}/instances/{instance_id}/configurations

gaussdb:instance:get

-

修改指定实例的参数

PUT /v3/{project_id}/instances/{instance_id}/configurations

gaussdb:param:update

-

创建参数模板

POST /v3/{project_id}/configurations

gaussdb:param:createParam

-

删除参数模板

DELETE /v3/{project_id}/configurations/{config_id}

gaussdb:param:delete

-

查询参数模板详情

GET /v3.1/{project_id}/configurations/{config_id}

gaussdb:param:get

-

复制参数模板

POST /v3/{project_id}/configurations/{config_id}/copy

gaussdb:param:copy

-

重置参数组

POST /v3/{project_id}/configurations/{config_id}/reset

gaussdb:param:reset

-

比较两个参数组模板之间的差异

POST /v3/{project_id}/configurations/comparison

gaussdb:param:compare

-

查询可应用实例列表

GET /v3/{project_id}/configurations/{config_id}/applicable-instances

gaussdb:instance:listAll

-

校验参数组名称是否存在

GET /v3/{project_id}/configurations/name-validation?name={name}

gaussdb:param:check

-

应用参数模板

PUT /v3/{project_id}/configurations/{config_id}/apply

gaussdb:param:apply

-

查询参数模板的应用记录

GET /v3/{project_id}/configurations/{config_id}/applied-histories

gaussdb:param:listAll

-

查询参数模板的修改历史

GET /v3/{project_id}/configurations/{config_id}/histories

gaussdb:param:listAll

-

查询扩容优化参数设置模板

GET /v3/{project_id}/expansion-parameters

gaussdb:instance:listAll

-
表4 备份管理

权限

API

对应的授权项

依赖的授权项

设置自动备份策略

PUT /v3.1/{project_id}/instances/{instance_id}/backups/policy

gaussdb:instance:updateBackupPolicy

-

查询自动备份策略

GET /v3/{project_id}/instances/{instance_id}/backups/policy

gaussdb:instance:getBackupPolicy

-

查询备份列表

GET /v3.2/{project_id}/backups?instance_id={instance_id}&backup_id={backup_id}&backup_type={backup_type}&offset={offset}&limit={limit}&begin_time={begin_time}&end_time={end_time}

gaussdb:backup:listAll

-

创建手动备份

POST /v3/{project_id}/backups

gaussdb:backup:create

-

删除手动备份

DELETE /v3/{project_id}/backups/{backup_id}

gaussdb:backup:delete

-

查询可恢复时间段

GET /v3/{project_id}/instances/{instance_id}/restore-time?date={date}

gaussdb:instance:listRecoverableTimes

-

恢复到新实例

POST /v3/{project_id}/instances

gaussdb:instance:createInstance

-

查询可用于备份恢复的实例列表

GET /v3.1/{project_id}/restorable-instances

gaussdb:instance:listAll

-

根据时间点或者备份文件查询原实例信息

GET /v3.1/{project_id}/instance-snapshot?instance_id={instance_id}&backup_id={backup_id}&restore_time={restore_time}

gaussdb:instance:get

-

授权备份文件下载

POST /v3/{project_id}/backups/{backup_id}/download/authorization

gaussdb:backup:authorizeDownload

-

批量设置自动备份策略

PUT /v3/{project_id}/backups/policy

gaussdb:instance:updateBackupPolicy

-

备份恢复到当前实例

POST /v3/{project_id}/instances/recovery

gaussdb:instance:restoreInstanceInPlace

-

停止备份

POST /v3/{project_id}/instances/{instance_id}/backups/stop

gaussdb:backup:stopBackup

-
表5 引擎版本和规格

权限

API

对应的授权项

依赖的授权项

查询数据库引擎的版本

GET /v3.2/{project_id}/datastore/versions

gaussdb:instance:listAll

-

查询数据库规格

GET /v3.2/{project_id}/flavors?limit={limit}&offset={offset}&ha_mode={ha_mode}&version={version}&spec_code={spec_code}

gaussdb:instance:listAll

-

查询引擎列表

GET /v3.1/{project_id}/datastores

gaussdb:instance:listAll

-

查询实例可变更规格

GET /v3/{project_id}/instances/{instance_id}/available-flavors

gaussdb:instance:listAll

-

查看实例引擎版本分布

GET /v3/{project_id}/datastore/instances

gaussdb::listEngineDetail

-
表6 数据库磁盘类型

权限

API

对应的授权项

依赖的授权项

查询数据库磁盘类型

GET /v3/{project_id}/storage-type

gaussdb:instance:listAll

-
表7 管理数据库和用户

权限

API

对应的授权项

依赖的授权项

创建数据库

POST /v3/{project_id}/instances/{instance_id}/database

gaussdb:instance:createDatabase

-

创建数据库用户

POST /v3/{project_id}/instances/{instance_id}/db-user

gaussdb:instance:createDatabaseUser

-

创建数据库SCHEMA

POST /v3/{project_id}/instances/{instance_id}/schema

gaussdb:instance:createDatabaseSchema

-

创建数据库角色

POST /v3.1/{project_id}/instances/{instance_id}/db-role

gaussdb:instance:createDatabaseRole

-

创建数据库用户

POST /v3/{project_id}/instances/{instance_id}/db-user

gaussdb:instance:createDatabaseUser

-

删除数据库

DELETE /v3/{project_id}/instances/{instance_id}/database

gaussdb:instance:dropDatabase

-

删除数据库SCHEMA

DELETE /v3/{project_id}/instances/{instance_id}/schema

gaussdb:instance:dropDatabaseSchema

-

授权数据库角色

POST /v3.1/{project_id}/instances/{instance_id}/db-privilege

gaussdb:instance:grantDatabasePrivilege

-

重置数据库账号密码

PUT /v3/{project_id}/instances/{instance_id}/db-user/password

gaussdb:instance:resetPassword

-

查询数据库列表

GET /v3/{project_id}/instances/{instance_id}/databases

gaussdb:instance:listDatabases

-

查询数据库用户列表

GET /v3/{project_id}/instances/{instance_id}/db-users

gaussdb:instance:listDatabaseUsers

-

查询数据库SCHEMA列表

GET /v3/{project_id}/instances/{instance_id}/schemas

gaussdb:instance:listSchemas

-

查询数据库角色列表

GET /v3.1/{project_id}/instances/{instance_id}/db-role

gaussdb:instance:listDatabaseRoles

-

查询数据库表列表

GET /v3/{project_id}/instances/{instance_id}/tables

gaussdb:instance:listTables

-

新增客户端接入认证配置

POST /v3/{project_id}/instances/{instance_id}/hba-info

gaussdb:instance:addHbaInfo

-

删除客户端接入认证配置

DELETE /v3/{project_id}/instances/{instance_id}/hba-info

gaussdb:instance:dropHbaInfo

-

查询客户端接入认证配置

GET /v3/{project_id}/instances/{instance_id}/hba-info

gaussdb:instance:listHbaInfo

-

修改客户端接入认证配置

PUT /v3/{project_id}/instances/{instance_id}/hba-info

gaussdb:instance:updateHbaInfo

-

恢复客户端接入认证配置信息

PUT /v3/{project_id}/instances/{instance_id}/restore-hba-info

gaussdb:instance:restoreHbaInfo

-
表8 日志管理

权限

API

对应的授权项

依赖的授权项

创建慢日志下载信息

POST /v3/{project_id}/instances/{instance_id}/slow-log/download

gaussdb:instance:operateSlowLog

-

查询错误日志下载链接

GET /v3/{project_id}/instances/{instance_id}/error-log

gaussdb:instance:listErrorLog

-

查询错误日志采集开关状态

GET /v3/{project_id}/instances/{instance_id}/error-log/switch/status

gaussdb:instance:getLogCollectionStatus

-

查询慢日志下载信息

GET /v3/{project_id}/instances/{instance_id}/slow-log/download

gaussdb:instance:downloadSlowLog

-

修改错误日志采集开关状态

POST /v3/{project_id}/instances/{instance_id}/error-log/switch/{status}

gaussdb:instance:operateRunningLog

-
表9 容灾管理

权限

API

对应的授权项

依赖的授权项

搭建容灾关系

POST /v3.5/{project_id}/instances/{instance_id}/disaster-recovery/construct

gaussdb:disasterRecovery:create

-

主实例结束容灾日志保持

POST /v3.5/{project_id}/instances/{instance_id}/disaster-recovery/keep-log-stop

gaussdb:disasterRecovery:keeplog

-

开始日志保持

POST /v3.5/{project_id}/instances/{instance_id}/disaster-recovery/keep-log-start

gaussdb:disasterRecovery:keeplog

-

结束容灾演练

POST /v3.5/{project_id}/instances/{instance_id}/disaster-recovery/simulation-stop

gaussdb:disasterRecovery:simulation

-

备实例容灾升主

POST /v3.5/{project_id}/instances/{instance_id}/disaster-recovery/failover

gaussdb:disasterRecovery:failover

-

重建容灾关系

POST /v3.5/{project_id}/instances/{instance_id}/disaster-recovery/restore

gaussdb:disasterRecovery:create

-

开始容灾演练

POST /v3.5/{project_id}/instances/{instance_id}/disaster-recovery/simulation-start

gaussdb:disasterRecovery:simulation

-

灾备实例主从切换

POST /v3.5/{project_id}/instances/{instance_id}/disaster-recovery/switchover

gaussdb:disasterRecovery:switchover

-

解除容灾关系

POST /v3.5/{project_id}/instances/{instance_id}/disaster-recovery/release

gaussdb:disasterRecovery:release

-

查询操作记录

GET /v3/{project_id}/instances/{instance_id}/disaster-recovery/records

gaussdb:instance:listRecord

-

重置容灾配置

POST /v3.5/{project_id}/instances/{instance_id}/reset-dr-config

gaussdb:disasterRecovery:create

-

查询实例容灾监控实时状态

GET /v3.5/{project_id}/instances/{instance_id}/disaster-recovery/monitor

gaussdb:disasterRecovery:listAll

-

查询容灾关系列表

GET /v3.5/{project_id}/disaster-recovery/relations

gaussdb:disasterRecovery:listAll

-
表10 任务管理

权限

API

对应的授权项

依赖的授权项

取消定时任务

PUT /v3/{project_id}/instances/schedule-task/{task_id}/cancel

gaussdb::cancelScheduleTask

-

删除任务记录

DELETE /v3/{project_id}/jobs/{job_id}

gaussdb:task:delete

-

删除定时任务信息

DELETE /v3/{project_id}/instances/schedule-task/{task_id}

gaussdb::deleteScheduleTask

-

查看定时任务列表

GET /v3/{project_id}/instances/schedule-tasks

gaussdb::listScheduleTask

-

查询任务列表

GET /v3/{project_id}/tasks

gaussdb:task:listAll

-

获取指定ID的任务信息。

GET /v3/{project_id}/jobs?id={id}

gaussdb:task:get

-
表11 回收站

权限

API

对应的授权项

依赖的授权项

查询回收站所有引擎实例列表。

GET /v3.1/{project_id}/recycle-instances

gaussdb:instance:listAll

-

设置回收站策略

PUT /v3/{project_id}/recycle-policy

gaussdb:instance:setRecyclePolicy

-

查看回收站策略

GET /v3/{project_id}/recycle-policy

gaussdb:instance:getRecyclePolicy

-
表12 指标管理

权限

API

对应的授权项

依赖的授权项

查询实例列表指标

GET /v3/{project_id}/instances/metric-data

gaussdb:metric:list

-

查询实例指标数据

GET /v3/{project_id}/instances/{instance_id}/metric-data

gaussdb:metric:list

-

查询指标分组的指标名称

GET /v3/{project_id}/instances/metric-name

gaussdb:metric:list

-
表13 标签管理

权限

API

对应的授权项

依赖的授权项

查询实例标签

GET /v3/{project_id}/instances/{instance_id}/tags

gaussdb:tag:listAll

-

查询项目标签

GET /v3/{project_id}/tags

gaussdb:tag:listAll

-

查询预定义标签

GET /v3/{project_id}/predefined-tags

gaussdb:tag:listAll

-

添加实例标签

POST /v3/{project_id}/instances/{instance_id}/tags

gaussdb:tag:create

-

删除实例标签

DELETE /v3/{project_id}/instances/{instance_id}/tags

gaussdb:tag:delete

-
表14 磁盘管理

权限

API

对应的授权项

依赖的授权项

查询实例存储空间使用信息

GET /v3/{project_id}/instances/{instance_id}/volume-usage

gaussdb:instance:getDiskUsage

-

获取分片的磁盘使用信息

GET /v3/{project_id}/instances/{instance_id}/shard-volume-usage

gaussdb:instance:getDiskUsage

-
表15 配额管理

权限

API

对应的授权项

依赖的授权项

修改企业项目配额

PUT /v3/{project_id}/enterprise-projects/quotas

gaussdb:quota:update

-

查询企业项目配额组

GET /v3/{project_id}/enterprise-projects/quotas

gaussdb:quota:listAll

-

获取企业项目剩余配额

POST /v3/{project_id}/enterprise-projects/remaining-quotas

gaussdb:quota:listAll

-
表16 插件管理

权限

API

对应的授权项

依赖的授权项

安装插件

POST /v3/{project_id}/instances/{instance_id}/kernel-plugin

gaussdb:instance:installKernelPlugin

-

查询实例已安装的插件列表

GET /v3/{project_id}/instances/{instance_id}/kernel-plugins

gaussdb:instance:getKernelPlugins

-

查询实例插件拓展信息

GET /v3/{project_id}/instances/{instance_id}/plugin-extensions

gaussdb:instance:getKernelPlugins

-

查询插件列表

GET /v3/{project_id}/instances/{instance_id}/plugins

gaussdb:instance:listPlugin

-

查询支持的插件列表

GET /v3/{project_id}/instances/kernel-plugins

gaussdb:instance:getKernelPlugins

-

配置插件拓展能力

POST /v3/{project_id}/instances/{instance_id}/config-plugin-extensions

gaussdb:instance:configKernelPlugin

-

配置插件license

PUT /v3/{project_id}/instances/{instance_id}/kernel-plugin-license

gaussdb:instance:configKernelPlugin

-
表17 版本升级

权限

API

对应的授权项

依赖的授权项

查询批量实例可升级的版本和升级类型

POST /v3.1/{project_id}/instances/db-upgrade/candidate-versions

gaussdb:instance:upgradeDatabaseVersion

-

POST /v3/{project_id}/instances/db-upgrade/candidate-versions

-

批量实例内核版本定时升级

POST /v3/{project_id}/instances/db-upgrade/schedule-task

gaussdb::createScheduleTask

-

查询实例可升级版本

GET /v3.1/{project_id}/instances/{instance_id}/db-upgrade/candidate-versions

gaussdb:instance:upgradeDatabaseVersion

-

批量实例内核版本升级

PUT /v3/{project_id}/instances/db-upgrade

gaussdb:instance:upgradeDatabaseVersion

-

实例内核版本升级

PUT /v3.1/{project_id}/instances/{instance_id}/db-upgrade

gaussdb:instance:upgradeDatabaseVersion

-
表18 慢SQL

权限

API

对应的授权项

依赖的授权项

查询慢SQL详情

POST /v3/{project_id}/instances/{instance_id}/slow-sql-detail

gaussdb:instance:getSlowSqlDetail

-

查询慢SQL列表

POST /v3/{project_id}/instances/{instance_id}/slow-sql-list

gaussdb:instance:listSlowSql

-

查询慢SQL节点信息

POST /v3/{project_id}/instances/{instance_id}/slow-sql-execute-node

gaussdb:instance:listSlowSqlExecuteNode

-

查询全局慢SQL详情

POST /v3/{project_id}/instances/{instance_id}/global-slow-sql-detail

gaussdb:instance:getSlowSqlDetail

-
表19 全量SQL

权限

API

对应的授权项

依赖的授权项

查询全量单条SQL记录列表

POST /v3/{project_id}/instances/{instance_id}/list-full-sqls

gaussdb:instance:listFullSqls

-

查询实例全量SQL聚合统计列表

POST /v3/{project_id}/instances/{instance_id}/list-full-sql-statistics

gaussdb:instance:listFullSqlStatistics

-

查询全量SQL开关记录

GET /v3/{project_id}/instances/{instance_id}/full-sql-switches

gaussdb:instance:listFullSqlSwitches

-

查询SQL链路信息

GET /v3/{project_id}/instances/{instance_id}/full-sql/sql-trace

gaussdb:instance:listSqlLinks

-

查询单条SQL详情

GET /v3/{project_id}/instances/{instance_id}/full-sqls/{sql_exec_id}

gaussdb:instance:getFullSql

-

开启全量SQL或修改默认配置

POST /v3/{project_id}/instances/{instance_id}/full-sqls/start

gaussdb:instance:enableFullSql

-

关闭全量SQL功能

POST /v3/{project_id}/instances/{instance_id}/full-sqls/stop

gaussdb:instance:disableFullSql

-
表20 Top SQL

权限

API

对应的授权项

依赖的授权项

查询TopSQL列表

POST /v3/{project_id}/instances/{instance_id}/top-sql-list

gaussdb:instance:listTopSql

-
表21 诊断优化

权限

API

对应的授权项

依赖的授权项

识别SQL文本中的表信息

POST /v3/{project_id}/instances/{instance_id}/parse/schema-table

gaussdb:instance:listDatabases

-

查询指定表的表定义信息列表

GET /v3/{project_id}/instances/{instance_id}/list-table-definition

gaussdb:spaceAnalytics:list

-
表22 SQL限流

权限

API

对应的授权项

依赖的授权项

创建SQL限流任务

POST /v3.1/{project_id}/instances/{instance_id}/limit-task

gaussdb:instance:createSQLLimitRule

-

删除SQL限流任务

DELETE /v3.1/{project_id}/instances/{instance_id}/limit-task/{task_id}

gaussdb:instance:deleteSQLLimitRule

-

查询节点的sql模板列表

GET /v3/{project_id}/instances/{instance_id}/list-node-limit-sql-model

gaussdb:instance:getSQLLimitRuleTemplate

-

根据指定条件查询SQL限流任务列表

POST /v3.1/{project_id}/instances/{instance_id}/limit-task-list

gaussdb:instance:getSQLLimitRules

-

查询SQL限流任务详情

GET /v3.1/{project_id}/instances/{instance_id}/limit-task/{task_id}

gaussdb:instance:getSQLLimitRule

-

同步内核侧sql限流数据至管控侧

POST /v3/{project_id}/instances/{instance_id}/sync-limit-task

gaussdb:instance:synchronizeSQLLimitRule

-

修改SQL限流任务

PUT /v3.1/{project_id}/instances/{instance_id}/limit-task/{task_id}

gaussdb:instance:updateSQLLimitRule

-
表23 空间分析

权限

API

对应的授权项

依赖的授权项

导出表信息

POST /v3/{project_id}/instances/{instance_id}/table-volume/export

gaussdb:spaceAnalytics:list

-

查询数据盘空间概况

GET /v3/{project_id}/instances/{instance_id}/database-volume-summary

gaussdb:spaceAnalytics:list

-

查询表定义信息

GET /v3/{project_id}/instances/{instance_id}/table-definition

gaussdb:spaceAnalytics:list

-
表24 会话管理

权限

API

对应的授权项

依赖的授权项

查询关键视图下发节点信息

POST /v3/{project_id}/instances/{instance_id}/key-view-execute-node

gaussdb:instance:listKeyViewExecuteNode

-

查询实时会话

POST /v3/{project_id}/instances/{instance_id}/real-time-session

gaussdb:instance:listRealTimeSession

-

查询会话内存上下文列表

GET /v3/{project_id}/instances/{instance_id}/session/memory-context

gaussdb:instance:listSessionMemory

-

查询实时会话统计

GET /v3/{project_id}/instances/{instance_id}/session-statistics

gaussdb:instance:listSessionStatistics

-

查询实时会话Top SQL统计

GET /v3/{project_id}/instances/{instance_id}/session/statistic/top-sql

gaussdb:instance:listRealTimeTopSqlStatisticInfo

-

查询实时会话Top等待事件统计

GET /v3/{project_id}/instances/{instance_id}/session/statistic/wait-event

gaussdb:instance:listRealTimeWaitEventStatisticInfo

-

查询事务列表

POST /v3/{project_id}/instances/{instance_id}/transactions/list

gaussdb:instance:listTransaction

-

查询等待事件列表

POST /v3/{project_id}/instances/{instance_id}/wait-event-list

gaussdb:instance:listSessionWaitEvents

-

获取自动中止事务配置

GET /v3/{project_id}/instances/{instance_id}/transactions/get-auto-kill-config

gaussdb:instance:getAutoKillTransactionConfig

-

查询实时会话概览

GET /v3/{project_id}/instances/{instance_id}/session-overview

gaussdb:instance:getSessionOverview

-

查询SQL执行计划信息

GET /v3/{project_id}/instances/{instance_id}/slow-sql/optimization/plan

gaussdb:instance:getSlowSqlPlan

-

查询SQL堆栈信息

GET /v3/{project_id}/instances/{instance_id}/slow-sql/optimization/stack

gaussdb:instance:getSlowSqlStack

-

结束空闲会话

POST /v3/{project_id}/instances/{instance_id}/kill-free-session

gaussdb:instance:killFreeSession

-

结束会话

POST /v3/{project_id}/instances/{instance_id}/kill-session

gaussdb:instance:killSession

-

手动结束事务

POST /v3/{project_id}/instances/{instance_id}/transactions/kill

gaussdb:instance:killTransaction

-
表25 WDR报告

权限

API

对应的授权项

依赖的授权项

采集WDR快照报告

POST /v3/{project_id}/instances/{instance_id}/wdr-snapshots/collect

gaussdb:instance:generateWdr

-

生成WDR快照

POST /v3/{project_id}/instances/{instance_id}/wdr-snapshots

gaussdb:instance:createWdrSnapshot

-

查询WDR快照开关状态

GET /v3/{project_id}/instances/{instance_id}/wdr-snapshot/status

gaussdb:instance:getWdrSnapshotStatus

-

打开或关闭WDR快照开关

PUT /v3/{project_id}/instances/{instance_id}/wdr-snapshot/status

gaussdb:instance:switchWdrSnapshotStatus

-
表26 LTS日志

权限

API

对应的授权项

依赖的授权项

关联LTS日志流

POST /v3/{project_id}/instances/logs/lts-config

gaussdb:instance:bindLtsConfig

-

查看LTS日志配置信息

GET /v3/{project_id}/instances/logs/lts-config

gaussdb:instance:listLtsConfigs

-

解除关联LTS日志流

DELETE /v3/{project_id}/instances/logs/lts-config

gaussdb:instance:unbindLtsConfig

-
表27 SQL PATCH

权限

API

对应的授权项

依赖的授权项

查询SQL PATCH

GET /v3/{project_id}/instances/{instance_id}/sql-patch

gaussdb:instance:getSqlPatch

-
表28 ASP报告

权限

API

对应的授权项

依赖的授权项

采集ASP报告

POST /v3/{project_id}/instances/{instance_id}/asp/collect

gaussdb:instance:operateAspReport

-

查询ASP采集结果

GET /v3/{project_id}/instances/{instance_id}/asp

gaussdb:instance:listAspReport

-

查询ASP开关状态

GET /v3/{project_id}/instances/{instance_id}/asp/status

gaussdb:instance:listAspReport

-

打开或者关闭ASP开关

PUT /v3/{project_id}/instances/{instance_id}/asp/status

gaussdb:instance:operateAspReport

-
表29 SQL执行计划

权限

API

对应的授权项

依赖的授权项

查询SQL执行计划绑定情况

POST /v3/{project_id}/instances/{instance_id}/sql/{node_id}/plans/query

gaussdb:instance:listSqlPlan

-
表30 首页总览

权限

API

对应的授权项

依赖的授权项

获取告警记录历史

GET /v3/{project_id}/alarm-history-record

gaussdb:alarm:list

-

实例告警信息汇总统计

GET /v3/{project_id}/instances/alarm-statistics

gaussdb:alarm:list

-

实例状态统计

GET /v3/instances-statistics

gaussdb:instance:listAll

-

资源类型（Resource）

资源类型（Resource）表示身份策略所作用的资源。如表3中的某些操作指定了可以在该操作指定的资源类型，则必须在具有该操作的身份策略语句中指定该资源的URN，身份策略仅作用于此资源；如未指定，Resource默认为“*”，则身份策略将应用到所有资源。您也可以在身份策略中设置条件，从而指定资源类型。

GaussDB定义了以下可以在身份策略的Resource元素中使用的资源类型。

表31 GaussDB支持的资源类型

资源类型

URN

instance

gaussdb:<region>:<account-id>:instance:<instance-id>

条件（Condition）

条件（Condition）是身份策略生效的特定条件，包括条件键和运算符。

  • 条件键表示身份策略语句的Condition元素中的键值。根据适用范围，分为全局级条件键和服务级条件键。
    • 全局级条件键（前缀为g:）适用于所有操作，在鉴权过程中，云服务不需要提供用户身份信息，系统将自动获取并鉴权。详情请参见：全局条件键。
    • 服务级条件键（前缀通常为服务缩写，如gaussdb:）仅适用于对应服务的操作，详情请参见表4。
    • 单值/多值表示API调用时请求中与条件关联的值数。单值条件键在API调用时的请求中最多包含一个值，多值条件键在API调用时请求可以包含多个值。例如：g:SourceVpce是单值条件键，表示仅允许通过某个VPC终端节点发起请求访问某资源，一个请求最多包含一个VPC终端节点ID值。g:TagKeys是多值条件键，表示请求中携带的所有标签的key组成的列表，当用户在调用API请求时传入标签可以传入多个值。
  • 运算符与条件键、条件值一起构成完整的条件判断语句，当请求信息满足该条件时，身份策略才能生效。支持的运算符请参见：运算符。

GaussDB定义了以下可以在身份策略的Condition元素中使用的条件键，您可以使用这些条件键进一步细化身份策略语句应用的条件。

表32 GaussDB支持的服务级条件键

服务级条件键

类型

单值/多值

说明

gaussdb:BackupEnabled

boolean

单值

按照请求参数中传递的是否开启备份策略标签键筛选访问权限。限定词选择“默认”。

gaussdb:Encrypted

boolean

单值

按照请求参数中传递的是否开启磁盘加密标签键筛选访问权限。限定词选择“默认”。

gaussdb:DownloadCategory

string

单值

按照请求参数中传递的下载策略类别名称筛选访问权限。

限定词选择“默认”。

gaussdb:AvailabilityZone

string

多值

按照请求参数中传递的可用区筛选访问权限。

限定词选择“请求中的任何值”或“请求中的所有值”。

gaussdb:VpcId

string

单值

按照请求参数中传递的虚拟私有云主键筛选访问权限。

限定词选择“默认”。

gaussdb:Subnet

string

单值

按照请求参数中传递的子网筛选访问权限。

限定词选择“默认”。

gaussdb:KmsId

string

单值

按照请求参数中传递的磁盘加密ID筛选访问权限。

限定词选择“默认”。

gaussdb:FlavorType

string

单值

按照请求参数中传递的性能规格类型筛选访问权限。

限定词选择“默认”。
父主题： 权限和授权项

相关文档