Help Center/ GaussDB/ API Reference/ Permissions and Supported Actions/ Actions Supported by Identity Policy-based Authorization
Updated on 2025-12-30 GMT+08:00

Actions Supported by Identity Policy-based Authorization

IAM provides system-defined policies to define common actions supported by cloud services. You can also create custom identity policies using the actions supported by cloud services for more refined access control.

In addition to IAM, the Organizations service also provides Service Control Policies (SCPs) to set access control policies.

SCPs do not actually grant any permissions to an entity. They only set the permissions boundary for the entity. When SCPs are attached to an organizational unit (OU) or a member account, the SCPs do not directly grant permissions to that OU or member account. Instead, the SCPs only determine what permissions are available for that member account or those member accounts under that OU. The granted permissions can be applied only if they are allowed by the SCPs.

To learn more about how IAM is different from Organizations for access control, see What Are the Differences in Access Control Between IAM and Organizations?

This section describes the elements used by IAM custom identity policies and Organizations SCPs. The elements include actions, resources, and conditions.

Actions

Actions are specific operations that are allowed or denied in an identity policy.

  • The Access Level column describes how the action is classified (List, Read, or Write). This classification helps you understand the level of access that an action grants when you use it in an identity policy.
  • The Resource Type column indicates whether the action supports resource-level permissions.
    • You can use a wildcard (*) to indicate all resource types. If this column is empty (-), the action does not support resource-level permissions and you must specify all resources ("*") in your identity policy statements.
    • If this column includes a resource type, you must specify the URN in the Resource element of your policy statements.
    • Required resources are marked with asterisks (*) in the table. If you specify a resource in a statement using this action, then it must be of this type.

    For details about the resource types defined by GaussDB, see Resources.

  • The Condition Key column contains keys that you can specify in the Condition element of an identity policy statement. If this column is empty (-), the action does not support any condition keys.

    For details about the condition keys defined by GaussDB, see Conditions.

  • The Alias column lists the policy actions that can be configured in identity policies. With these actions, you can use APIs for policy-based authorization. For details, see Policies and Identity Policies.

The following table lists the actions that you can define in identity policy statements for GaussDB.

Table 1 Actions supported by GaussDB

Action

Description

Access Level

Resource Type (*: required)

Condition Key

Alias

gaussdb::updateDownloadPolicy

Grants permission to edit a download policy.

Write

-

gaussdb:DownloadCategory

-

gaussdb::getDownloadPolicy

Grants permission to query a download policy.

Read

-

-

-

gaussdb::listComputeResourcePackage

Grants permission to query compute quotas.

List

-

-

gaussdb:instance:listComputeResourcePackage

gaussdb::purchaseResourcePackage

Grants permission to purchase compute quotas.

Write

-

-

gaussdb:instance:purchaseResourcePackage

gaussdb::modifyHotfix

Grants permission to modify hot patch attributes.

Write

-

-

gaussdb:hotfix:modify

gaussdb::listNetwork

Grants permission to query network details.

List

-

-

gaussdb:instance:listNetwork

gaussdb::purchaseSubscriptionCode

Grants permission to purchase subscription codes.

Write

-

-

gaussdb:instance:purchaseSubscriptionCode

gaussdb::listSubscriptionCode

Grants permission to view the subscription code list.

List

-

-

gaussdb:instance:listSubscriptionCode

gaussdb::activateSubscriptionCode

Grants permission to activate subscription codes.

Write

-

-

gaussdb:instance:activateSubscriptionCode

gaussdb::downloadSubscriptionCode

Grants permission to download subscription codes.

Read

-

-

gaussdb:instance:downloadSubscriptionCode

gaussdb::expireSubscriptionCode

Grants permission to invalidate subscription codes.

Write

-

-

gaussdb:instance:expireSubscriptionCode

gaussdb::applyApproval

Grants permission to request subscription codes.

Write

-

-

gaussdb:instance:applyApproval

gaussdb::updateApproval

Grants permission to modify subscription code requests.

Write

-

-

gaussdb:instance:updateApproval

gaussdb::listApproval

Grants permission to view subscription code requests.

List

-

-

gaussdb:instance:listApproval

gaussdb::getSubscriptionCodeStatistics

Grants permission to view subscription code statistics.

Read

-

-

gaussdb:instance:getSubscriptionCodeStatistics

gaussdb:backup:createBackup

Grants permission to create a manual backup for a DB instance.

Write

Instance

-

gaussdb:backup:create

gaussdb:backup:deleteBackup

Grants permission to delete a backup.

Write

Instance

-

gaussdb:backup:delete

gaussdb:backup:get

Grants permission to query backup information.

Read

-

-

gaussdb:instance:list

gaussdb:backup:listAll

Grants permission to query backups.

List

Instance

-

gaussdb:backup:list

gaussdb:backup:download

Grants permission to download backups.

Read

-

-

gaussdb:backup:list

gaussdb:backup:syncOffSiteBackupData

Grants permission to synchronize backup data across regions.

Write

-

-

gaussdb:instance:modifyBackupPolicy

gaussdb:backup:check

Grants permission to verify backup information.

Read

-

-

gaussdb:instance:list

gaussdb:backup:changeBackupMedia

Grants permission to change backup media.

Write

Instance

-

-

gaussdb:backup:stopBackup

Grants permission to stop ongoing backups.

Write

Instance

-

-

gaussdb:instance:updateBackupPolicy

Grants permission to configure a backup policy.

Write

Instance

gaussdb:BackupEnabled

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

gaussdb:param:applyParam

Grants permission to apply a parameter template.

Write

-

-

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

gaussdb:tag:create

Grants permission to add tags.

Tagging

Instance

-

gaussdb:instance:dealTag

gaussdb:tag:update

Grants permission to modify resource tags.

Tagging

Instance

-

gaussdb:instance:dealTag

gaussdb:tag:delete

Grants permission to delete resource tags.

Tagging

Instance

-

gaussdb:instance:dealTag

gaussdb:instance:bindLtsConfig

Grants permission to associate instances with LTS log streams.

Write

-

-

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

gaussdb:instance:bindEIP

Grants permission to bind an EIP.

Write

Instance

-

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

gaussdb:instance:operateNodeGroup

Grants permission to operate node groups.

Write

Instance

-

gaussdb:instance:modify

gaussdb:instance:changeVolumeType

Grants permission to change disk types.

Write

Instance

-

-

gaussdb:instance:check

Grants permission to query instance information.

Read

-

-

gaussdb:instance:list

gaussdb:instance:createInstance

Grants permission to create a DB instance.

Write

Instance

gaussdb:instance:create

gaussdb:instance:createDatabase

Grants permission to create a database.

Write

Instance

-

gaussdb:instance:modify

gaussdb:instance:createDatabaseSchema

Grants permission to create a database schema.

Write

Instance

-

gaussdb:instance:modify

gaussdb:instance:createDatabaseUser

Grants permission to create a database account.

Write

Instance

-

gaussdb:instance:modify

gaussdb:instance:deleteInstance

Grants permission to delete a DB instance.

Write

Instance

-

gaussdb:instance:delete

gaussdb:instance:downloadSlowLog

Grants permission to download slow query logs.

Read

Instance

-

gaussdb:instance:list

gaussdb:instance:expandReadonlyNode

Grants permission to create read replicas.

Write

Instance

-

-

gaussdb:instance:forceSwitch

Grants permission to enable or disable forcible switchover.

Write

Instance

-

gaussdb:instance:modify

gaussdb:instance:get

Grants permission to query DB instance information.

Read

Instance

-

gaussdb:instance:list

gaussdb:instance:getBackupPolicy

Grants permission to query an automated backup policy.

Read

Instance

-

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

gaussdb:instance:getBalanceStatus

Grants permission to check whether host load is unbalanced due to a primary/standby switchover.

Read

Instance

-

gaussdb:instance:list

gaussdb:instance:getLogCollectionStatus

Grants permission to query the status of the error log collection function.

Read

Instance

-

gaussdb:instance:list

gaussdb:instance:getMetricDataCollectionPeriod

Grants permission to query the collection period of instance metrics.

Read

Instance

-

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

gaussdb:instance:getDiskUsage

Grants permission to query disk usage.

Read

-

-

gaussdb:instance:list

gaussdb:instance:getRetrieveXLogStatus

Grants permission to query the status of the instance Xlog recycling function.

Read

Instance

-

gaussdb:instance:list

gaussdb:instance:getRecyclePolicy

Grants permission to query the recycling policy.

Read

Instance

-

gaussdb:instance:list

gaussdb:instance:downloadSslCert

Grants permission to download the SSL certificate of a DB instance.

Read

Instance

-

gaussdb:instance:list

gaussdb:instance:grantDatabasePrivilege

Grants permission to configure permissions of database accounts.

Write

Instance

-

gaussdb:instance:modify

gaussdb:instance:listAll

Grants permission to query DB instances.

List

-

-

gaussdb:instance:list

gaussdb:instance:listAvailabilityZones

Grants permission to query AZs.

List

-

-

gaussdb:instance:list

gaussdb:instance:listTopIoInfo

Grants permission to query I/O traffic.

List

Instance

-

-

gaussdb:instance:listPublicIps

Grants permission to query EIPs bound to DB instances.

List

Instance

-

gaussdb:instance:list

gaussdb:instance:listCoordinatorNodes

Grants permission to query CNs.

List

Instance

-

gaussdb:instance:list

gaussdb:instance:listComponents

Grants permission to query instance components.

List

Instance

-

gaussdb:instance:list

gaussdb:instance:listDatabases

Grants permission to query DB instances.

List

Instance

-

gaussdb:instance:list

gaussdb:instance:listDatabaseUsers

Grants permission to query database users.

List

Instance

-

gaussdb:instance:list

gaussdb:instance:downloadRetrieveXLog

Grants permission to download instance Xlogs.

Read

Instance

-

gaussdb:instance:list

gaussdb:instance:listLtsConfigs

Grants permission to view LTS log configurations.

List

-

-

gaussdb:instance:list

gaussdb:tag:listAll

Grants permission to query resource tags.

List

-

-

gaussdb:instance:list

gaussdb:instance:listTagsForResource

Grants permission to query tags of a resource.

List

Instance

-

gaussdb:instance:list

gaussdb:tag:listResourceByTag

Grants permission to query resources by tag.

List

-

-

gaussdb:instance:list

gaussdb:quota:listAll

Grants permission to query quotas.

List

-

-

gaussdb:instance:list

gaussdb:instance:listReadonlyNodes

Grants permission to query read replicas.

List

Instance

-

gaussdb:instance:list

gaussdb:instance:listRecoverableTimes

Grants permission to query the restoration time range.

List

Instance

-

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

gaussdb:instance:listSchemas

Grants permission to query database schemas.

List

Instance

-

gaussdb:instance:list

gaussdb:instance:listTables

Grants permission to query database tables.

List

Instance

-

gaussdb:instance:list

gaussdb:instance:listTableBackupStatus

Grants permission to query table backup status.

List

-

-

gaussdb:instance:list

gaussdb:instance:listRecord

Grants permission to query operation records.

Read

Instance

-

-

gaussdb:instance:updateRetrieveXLogStatus

Grants permission to enable or disable the instance Xlog recycling function.

Write

Instance

-

gaussdb:instance:modifyRetrieveXLogStatus

gaussdb:instance:operateAuditLog

Grants permission to operate audit logs.

Write

Instance

-

gaussdb:instance:modify

gaussdb:instance:operateRunningLog

Grants permission to operate run logs.

Write

Instance

-

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

gaussdb:instance:operateSlowLog

Grants permission to operate slow query logs.

Write

Instance

-

gaussdb:instance:modify

gaussdb:instance:rebalancedShard

Grants permission to rebalance instances.

Write

Instance

-

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

gaussdb:instance:reduceNode

Grants permission to scale in nodes.

Write

Instance

-

-

gaussdb:instance:reduceReadonlyNode

Grants permission to delete read replicas.

Write

Instance

-

-

gaussdb:instance:reduceReplica

Grants permission to scale in replicas.

Write

Instance

-

gaussdb:instance:modify

gaussdb:instance:renameInstance

Grants permission to change a DB instance name.

Write

Instance

-

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

gaussdb:instance:resetPassword

Grants permission to reset a database password.

Write

Instance

-

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

gaussdb:instance:resizeFlavor

Grants permission to change vCPUs and memory of a DB instance.

Write

Instance

-

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

gaussdb:instance:restartInstance

Grants permission to reboot a DB instance.

Write

Instance

-

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

gaussdb:instance:stop

Grants permission to stop a DB instance.

Write

Instance

-

-

gaussdb:instance:start

Grants permission to start a DB instance.

Write

Instance

-

-

gaussdb:instance:restoreInstanceInPlace

Grants permission to restore the original instance from a backup.

Write

-

-

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

gaussdb:instance:setRecyclePolicy

Grants permission to modify the recycling policy.

Write

-

-

gaussdb:instance:modifyBackupPolicy

gaussdb:instance:switchShard

Grants permission to switch roles of the primary and standby DNs in shards.

Write

Instance

-

gaussdb:instance:modify

gaussdb:instance:unbindLtsConfig

Grants permission to disassociate instances from LTS log streams.

Write

-

-

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

gaussdb:instance:setInstanceExtendInfo

Grants permission to set extended information for instances.

Write

-

-

-

gaussdb:instance:switchConsistencyProtocol

Grants permission to change the consistency protocol.

Write

Instance

-

-

gaussdb:instance:switchReplica

Grants permission to change replica roles.

Write

Instance

-

gaussdb:instance:swichReplica

gaussdb:instance:migration

Grants permission to migrate data between GaussDB instances.

Write

Instance

-

-

gaussdb:instance:extend

Grants permission to perform scale-out operations.

Write

Instance

-

gaussdb:instance:modifySpec

gaussdb:instance:unbindEIP

Grants permission to unbind an EIP from a DB instance.

Write

Instance

-

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

gaussdb:instance:updateMetricDataCollectionPeriod

Grants permission to modify the collection period of instance metrics.

Write

Instance

-

gaussdb:instance:secondLevelMonitoring

gaussdb:instance:updatePort

Grants permission to change a database port.

Write

Instance

-

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

gaussdb:instance:updateDescription

Grants permission to modify an instance description.

Write

Instance

-

gaussdb:instance:modify

gaussdb:instance:upgradeDatabaseVersion

Grants permission to upgrade the database version.

Write

Instance

-

gaussdb:instance:modify

gaussdb:instance:listErrorLog

Grants permission to query database error logs.

List

Instance

-

gaussdb:instance:list

gaussdb:instance:autoEnlargePolicy

Grants permission to modify storage autoscaling policies.

Write

Instance

-

-

gaussdb:instance:dropDatabase

Grants permission to delete a database.

Write

Instance

-

gaussdb:instance:modify

gaussdb:instance:deleteTaskRecord

Grants permission to delete a task record.

Write

-

-

gaussdb:instance:modify

gaussdb:instance:switchHaStrategy

Grants permission to modify instance HA policies.

Write

Instance

-

-

gaussdb:instance:changeDeploymentSolution

Grants permission to change the database instance deployment model.

Write

Instance

-

-

gaussdb:instance:getWorkloadManager

Grants permission to query control groups (Cgroups).

Read

Instance

-

-

gaussdb:instance:deleteCgroup

Grants permission to delete Cgroups.

Write

Instance

-

-

gaussdb:instance:createCgroup

Grants permission to create Cgroups.

Write

Instance

-

-

gaussdb:instance:modifyCgroup

Grants permission to modify Cgroups.

Write

Instance

-

-

gaussdb:instance:createResourcePool

Grants permission to create resource pools.

Write

Instance

-

-

gaussdb:instance:modifyResourcePool

Grants permission to modify resource pools.

Write

Instance

-

-

gaussdb:instance:deleteResourcePool

Grants permission to delete resource pools.

Write

Instance

-

-

gaussdb:instance:listFeatures

Grants permission to query advanced features.

Write

Instance

-

-

gaussdb:instance:updateFeatures

Grants permission to modify advanced features.

Write

Instance

-

-

gaussdb:user:addOrUpdate

Grants permission to add a user or modify user information.

Write

Instance

-

-

gaussdb:instance:bindDNS

Grants permission to purchase and bind a private domain name.

Write

Instance

-

-

gaussdb:instance:createDataRecovery

Grants permission to retrieve data.

Write

Instance

-

-

gaussdb:instance:reduceVolume

Grants permission to scale down storage.

Write

Instance

-

gaussdb:instance:modifySpec

gaussdb:instance:createSQLLimitRule

Grants permission to create SQL throttling tasks.

Write

Instance

-

-

gaussdb:instance:updateSQLLimitRule

Grants permission to modify SQL throttling tasks.

Write

Instance

-

-

gaussdb:instance:deleteSQLLimitRule

Grants permission to delete SQL throttling tasks.

Write

Instance

-

-

gaussdb:instance:getSQLLimitRule

Grants permission to query SQL throttling task details.

Read

Instance

-

-

gaussdb:instance:getSQLLimitRuleTemplate

Grants permission to query SQL templates.

List

Instance

-

-

gaussdb:instance:getSQLLimitRules

Grants permission to query SQL throttling tasks.

List

Instance

-

-

gaussdb:instance:synchronizeSQLLimitRule

Grants permission to synchronize SQL throttling tasks.

Write

Instance

-

-

gaussdb:instance:listSlowSqlExecuteNode

Grants permission to query nodes executing slow SQL statements.

List

Instance

-

-

gaussdb:instance:listTopSql

Grants permission to query top SQL statements.

List

Instance

-

-

gaussdb:instance:listSlowSql

Grants permission to query slow SQL statements.

List

Instance

-

-

gaussdb:instance:getSlowSqlDetail

Grants permission to query details about slow SQL statements.

Read

Instance

-

-

gaussdb:instance:enableFullSql

Grants permission to enable or re-enable SQL Explorer.

Write

Instance

-

-

gaussdb:instance:disableFullSql

Grants permission to disable SQL Explorer.

Write

Instance

-

-

gaussdb:instance:listFullSqls

Grants permission to query full SQL execution logs.

List

Instance

-

-

gaussdb:instance:listFullSqlStatistics

Grants permission to query full SQL statistics.

List

Instance

-

-

gaussdb:instance:listFullSqlSwitches

Grants permission to query SQL Explorer status records.

List

Instance

-

-

gaussdb:instance:getFullSql

Grants permission to query full SQL execution details.

List

Instance

-

-

gaussdb:instance:listSqlLinks

Grants permission to query SQL links.

List

Instance

-

-

gaussdb:instance:listKeyViewExecuteNode

Grants permission to query nodes executing key database views.

List

Instance

-

-

gaussdb:instance:listRealTimeSession

Grants permission to query real-time sessions of a database.

List

Instance

-

-

gaussdb:instance:killSession

Grants permission to terminate database sessions.

Write

Instance

-

-

gaussdb:instance:killFreeSession

Grants permission to terminate idle database sessions.

Write

Instance

-

-

gaussdb:instance:startMySQLCompatibility

Grants permission to enable M-compatible ports.

Write

Instance

-

-

gaussdb:instance:updateMySQLCompatibility

Grants permission to modify or disable M-compatible ports.

Write

Instance

-

-

gaussdb:instance:listDatabaseRoles

Grants permission to query database roles.

List

Instance

-

-

gaussdb:instance:createDatabaseRole

Grants permission to create database roles.

Write

Instance

-

-

gaussdb:instance:dropDatabaseRole

Grants permission to delete database roles.

Write

Instance

-

-

gaussdb:instance:dropDatabaseSchema

Grants permission to delete database schemas.

Write

Instance

-

-

gaussdb:instance:killTransaction

Grants permission to kill database transactions.

Write

Instance

-

-

gaussdb:instance:listTransaction

Grants permission to query database transactions.

List

Instance

-

-

gaussdb:instance:getAutoKillTransactionConfig

Grants permission to obtain auto transaction killing configurations.

Read

Instance

-

-

gaussdb:instance:configAutoKillTransaction

Grants permission to configure automatic transaction killing.

Write

Instance

-

-

gaussdb:instance:listSessionWaitEvents

Grants permission to query wait events.

List

Instance

-

-

gaussdb:instance:getSlowSqlStack

Grants permission to query SQL stack information.

Read

Instance

-

-

gaussdb:instance:getSlowSqlPlan

Grants permission to query SQL execution plans.

Read

Instance

-

-

gaussdb:instance:listAspReport

Grants permission to query the ASP collection status and result list.

List

Instance

-

-

gaussdb:instance:operateAspReport

Grants permission to perform ASP collection operations.

Write

Instance

-

-

gaussdb:instance:getWdrSnapshotStatus

Grants permission to check the enabling status of WDR snapshot generation.

Read

Instance

-

-

gaussdb:instance:switchWdrSnapshotStatus

Grants permission to enable or disable WDR snapshot generation.

Write

Instance

-

-

gaussdb:instance:listWdr

Grants permission to query WDRs.

List

Instance

-

-

gaussdb:instance:createWdrSnapshot

Grants permission to generate WDR snapshots.

Write

Instance

-

-

gaussdb:instance:generateWdr

Grants permission to generate WDRs.

Write

Instance

-

-

gaussdb:instance:listProblematicSessions

Grants permission to query problematic sessions.

List

Instance

-

-

gaussdb:pdb:create

Grants permission to create PDBs.

Write

Instance

-

-

gaussdb:pdb:delete

Grants permission to delete PDBs.

Write

Instance

-

-

gaussdb:pdb:list

Grants permission to query PDBs.

List

Instance

-

-

gaussdb:pdb:modify

Grants permission to modify PDBs.

Write

Instance

-

-

gaussdb:instance:switchKmsTde

Grants permission to use Transparent Data Encryption (TDE).

Write

Instance

-

-

gaussdb:instance:listHbaInfo

Grants permission to query client authentication configurations.

List

Instance

-

-

gaussdb:instance:addHbaInfo

Grants permission to add client authentication configurations.

Write

Instance

-

-

gaussdb:instance:updateHbaInfo

Grants permission to modify client authentication configurations.

Write

Instance

-

-

gaussdb:instance:dropHbaInfo

Grants permission to delete client authentication configurations.

Write

Instance

-

-

gaussdb:instance:listHbaInfoHistory

Grants permission to query client authentication change history.

List

Instance

-

-

gaussdb:instance:restoreHbaInfo

Grants permission to restore client authentication configurations.

Write

Instance

-

-

gaussdb:databaseUser:drop

Grants permission to delete a user.

Write

Instance

-

-

gaussdb:metric:list

Grants permission to query GaussDB monitoring metrics.

List

-

-

-

gaussdb:alarm:list

Grants permission to query historical alarms.

List

-

-

-

gaussdb:param:update

Grants permission to modify a parameter template.

Write

-

-

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

gaussdb:param:check

Grants permission to check a parameter template.

Read

-

-

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

gaussdb:param:copy

Grants permission to replicate a parameter template.

Write

-

-

gaussdb:param:create

gaussdb:param:createParam

Grants permission to create a parameter template.

Write

-

-

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

gaussdb:param:deleteParam

Grants permission to delete a parameter template.

Write

-

-

gaussdb:param:delete

gaussdb:param:get

Grants permission to query details about a parameter template.

Read

-

-

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

gaussdb:param:compare

Grants permission to compare two parameter templates.

Read

-

-

gaussdb:param:list

gaussdb:param:listAll

Grants permission to query parameter templates.

List

-

-

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

gaussdb:param:reset

Grants permission to reset a parameter template.

Write

-

-

gaussdb:param:modify

gaussdb:quota:update

Grants permission to modify quotas.

Write

-

-

gaussdb:quota:modify

gaussdb:task:listAll

Grants permission to query tasks.

List

-

-

gaussdb:instance:list

gaussdb:task:delete

Grants permission to delete a task record.

Write

-

-

gaussdb:instance:deleteTaskRecord

gaussdb:task:get

Grants permission to query task details.

Read

-

-

gaussdb:instance:list

gaussdb:disasterRecovery:create

Grants permission to set up a DR relationship.

Write

Instance

-

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

gaussdb:disasterRecovery:delete

Grants permission to delete DR records.

Write

Instance

-

gaussdb:instance:create

gaussdb:disasterRecovery:failover

Grants permission to perform manual failover.

Write

Instance

-

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

gaussdb:disasterRecovery:get

Grants permission to view DR information.

Read

Instance

-

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

gaussdb:disasterRecovery:keeplog

Grants permission to enable or disable log cache for DR.

Write

Instance

-

gaussdb:disasterRecovery:construct

gaussdb:disasterRecovery:listAll

Grants permission to query established DR relationships.

List

-

-

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

gaussdb:disasterRecovery:check

Grants permission to perform DR prechecks.

Read

-

-

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

gaussdb:disasterRecovery:release

Grants permission to remove DR relationships.

Write

Instance

-

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

gaussdb:disasterRecovery:simulation

Grants permission to conduct DR drills.

Write

Instance

-

gaussdb:disasterRecovery:construct

gaussdb:disasterRecovery:switchover

Grants permission to switch roles of primary and standby instances.

Write

Instance

-

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

gaussdb:disasterRecovery:update

Grants permission to modify DR configurations.

Write

Instance

-

gaussdb:instance:modify

Each API of GaussDB usually supports one or more actions. The following table lists the supported actions and dependencies.

Table 2 Instance management

Permission

API

Action

Dependency

Binding or unbinding an EIP

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

gaussdb:instance:bindEIP

-

Creating a DB instance

POST /v3.2/{project_id}/instances

gaussdb:instance:createInstance

If you use a KMS key to create an instance with disk encryption enabled, the following permission is required:

kms:cmk:createGrant

Creating a read replica

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

gaussdb:instance:expandReadonlyNode

-

Scaling up storage space of a DB instance

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

gaussdb:instance:extend

-

Deleting a DB instance

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

gaussdb:instance:deleteInstance

-

Deleting a read replica

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

gaussdb:instance:reduceReadonlyNode

-

Deleting shards

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

gaussdb:instance:reduceNode

-

Querying instances or instance details

GET /v3.3/{project_id}/instances

gaussdb:instance:listAll

-

Querying CNs

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

gaussdb:instance:listCoordinatorNodes

-

Querying the components of a DB instance

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

gaussdb:instance:listComponents

-

Querying enterprise projects

GET /v3/{project_id}/enterprise-projects

gaussdb:instance:listAll

-

Querying instance features

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

gaussdb:instance:listFeatures

-

Querying DB instances

GET /v3/{project_id}/instances

gaussdb:instance:listAll

-

Resetting a database password

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

gaussdb:instance:resetPassword

-

Changing a DB instance name

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

gaussdb:instance:renameInstance

-

Rebooting a DB instance

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

gaussdb:instance:restartInstance

-

Switching roles of the primary and standby DNs in shards

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

gaussdb:instance:switchShard

-

Querying the components of a DB instance

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

gaussdb:instance:listComponents

-

Changing vCPUs and memory of a DB instance

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

gaussdb:instance:resizeFlavor

-

Checking whether host load is unbalanced due to a primary/standby switchover

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

gaussdb:instance:getBalanceStatus

-

Querying solution template settings

GET /v3/{project_id}/deployment-form

gaussdb:instance:listAll

-

Querying EIPs bound to DB instances

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

gaussdb:instance:listPublicIps

-

Binding or unbinding an EIP

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

gaussdb:instance:bindEIP

-

Querying the SSL certificate download address of a DB instance

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

gaussdb:instance:downloadSslCert

-

Querying the instance quotas of a tenant

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

gaussdb:quota:listAll

-

Configuring a download policy

GET /v3/{project_id}/download/policy

gaussdb::updateDownloadPolicy

-

Querying a download policy

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

gaussdb::getDownloadPolicy

-

Querying the modification history of a client access authentication configuration

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

gaussdb:instance:listHbaInfoHistory

-

Querying KMS keys

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

gaussdb:instance:listAll

-

Querying read replica information

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

gaussdb:instance:listReadonlyNodes

-

Modifying a storage autoscaling policy

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

gaussdb:instance:autoEnlargePolicy

-

Changing the port number of a specified DB instance

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

gaussdb:instance:updatePort

-

Adding CNs, adding shards, or scaling up storage

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

gaussdb:instance:extend

-

Querying storage autoscaling policies

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

gaussdb:instance:listAll

-

Checking whether host load is unbalanced due to a primary/standby switchover

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

gaussdb:instance:getBalanceStatus

-

Querying solution template settings

GET /v3/{project_id}/deployment-form

gaussdb:instance:listAll

-

Querying details about a KMS key

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

gaussdb:instance:listAll

-

Querying the parameter setting template for data redistribution

GET /v3/{project_id}/redistribution-parameters

gaussdb:instance:listAll

-

Deleting coordinator nodes

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

gaussdb:instance:reduceNode

-

Starting an instance or node

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

gaussdb:instance:start

-

Enabling the M compatibility port

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

gaussdb:instance:startMySQLCompatibility

-

Stopping an instance or node

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

gaussdb:instance:stop

-

Enabling TDE

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

gaussdb:instance:switchKmsTde

-

Changing the deployment model of a distributed instance from 1 primary + 1 standby + 1 log to 1 primary + 2 standby

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

gaussdb:instance:switchReplica

-

Switching roles of the primary and standby nodes in shards

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

gaussdb:instance:switchShard

-

Modifying parameters for scale-out optimization

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

gaussdb:param:update

-

Enabling features

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

gaussdb:instance:updateFeatures

-

Changing the alias of a DB instance

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

gaussdb:instance:updateDescription

-

Upgrading the kernel version of an instance

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

gaussdb:instance:upgradeDatabaseVersion

-

Updating or disabling the M compatibility port

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

gaussdb:instance:updateMySQLCompatibility

-

Modifying parameters for data redistribution

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

gaussdb:param:update

-

Table 3 Parameter configuration

Permission

API

Action

Dependency

Obtaining parameter templates

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

gaussdb:param:listAll

-

Obtaining parameters of a specified DB instance

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

gaussdb:instance:get

-

Modifying parameters of a specified DB instance

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

gaussdb:param:update

-

Creating a parameter template

POST /v3/{project_id}/configurations

gaussdb:param:createParam

-

Deleting a parameter template

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

gaussdb:param:deleteParam

-

Querying details about a parameter template

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

gaussdb:param:get

-

Replicating a parameter template

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

gaussdb:param:copy

-

Resetting a parameter template

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

gaussdb:param:reset

-

Obtaining the differences of two parameter templates

POST /v3/{project_id}/configurations/comparison

gaussdb:param:compare

-

Querying instances that a parameter template can be applied to

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

gaussdb:instance:listAll

-

Checking whether a parameter template name is unique

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

gaussdb:param:check

-

Applying a parameter template

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

gaussdb:param:applyParam

-

Querying application records of a parameter template

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

gaussdb:param:listAll

-

Querying the change history of a parameter template

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

gaussdb:param:listAll

-

Querying the parameter setting template for scale-out optimization

GET /v3/{project_id}/expansion-parameters

gaussdb:instance:listAll

-

Table 4 Backup management

Permission

API

Action

Dependency

Configuring an automated backup policy

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

gaussdb:instance:updateBackupPolicy

-

Querying an automated backup policy

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

gaussdb:instance:getBackupPolicy

-

Querying backups

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

-

Creating a manual backup

POST /v3/{project_id}/backups

gaussdb:backup:createBackup

-

Deleting a manual backup

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

gaussdb:backup:deleteBackup

-

Querying the restoration time range

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

gaussdb:instance:listRecoverableTimes

-

Restoring data to a new DB instance

POST /v3/{project_id}/instances

gaussdb:instance:createInstance

-

Querying instances that can be used for backups and restorations

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

gaussdb:instance:listAll

-

Querying the information of the original instance based on a specific point of time or a backup file

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

gaussdb:instance:get

-

Configuring the automated backup policy for instances in batches

PUT /v3/{project_id}/backups/policy

gaussdb:instance:updateBackupPolicy

-

Restoring the current instance from a backup

POST /v3/{project_id}/instances/recovery

gaussdb:instance:restoreInstanceInPlace

-

Stopping a backup

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

gaussdb:backup:stopBackup

-

Table 5 DB engine versions and specifications

Permission

API

Action

Dependency

Querying DB engine versions

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

gaussdb:instance:listAll

-

Querying instance specifications

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

gaussdb:instance:listAll

-

Querying DB engines

GET /v3.1/{project_id}/datastores

gaussdb:instance:listAll

-

Querying specifications that a DB instance can be changed to

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

gaussdb:instance:listAll

-

Table 6 Database storage type

Permission

API

Action

Dependency

Querying the storage type of a DB instance

GET /v3/{project_id}/storage-type

gaussdb:instance:listAll

-

Table 7 Database and account management

Permission

API

Action

Dependency

Creating a database

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

gaussdb:instance:createDatabase

-

Creating a database account

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

gaussdb:instance:createDatabaseUser

-

Creating a database schema

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

gaussdb:instance:createDatabaseSchema

-

Creating a database role

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

gaussdb:instance:createDatabaseRole

-

Creating a database account

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

gaussdb:instance:createDatabaseUser

-

Deleting a database

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

gaussdb:instance:dropDatabase

-

Deleting a schema

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

gaussdb:instance:dropDatabaseSchema

-

Configuring permissions of a database role

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

gaussdb:instance:grantDatabasePrivilege

-

Resetting a password for a database account

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

gaussdb:instance:resetPassword

-

Querying databases

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

gaussdb:instance:listDatabases

-

Querying database users

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

gaussdb:instance:listDatabaseUsers

-

Querying database schemas

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

gaussdb:instance:listSchemas

-

Querying database roles

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

gaussdb:instance:listDatabaseRoles

-

Querying database tables

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

gaussdb:instance:listTables

-

Adding a client access authentication configuration

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

gaussdb:instance:addHbaInfo

-

Deleting a client access authentication configuration

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

gaussdb:instance:dropHbaInfo

-

Querying a client access authentication configuration

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

gaussdb:instance:listHbaInfo

-

Modifying a client access authentication configuration

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

gaussdb:instance:updateHbaInfo

-

Restoring a client access authentication configuration

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

gaussdb:instance:restoreHbaInfo

-

Table 8 Log management

Permission

API

Action

Dependency

Creating a slow query log download task

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

gaussdb:instance:operateSlowLog

-

Querying the link for downloading error logs

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

gaussdb:instance:listErrorLog

-

Querying whether error log collection is enabled

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

gaussdb:instance:getLogCollectionStatus

-

Querying downloaded slow query log information

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

gaussdb:instance:downloadSlowLog

-

Enabling or disabling error log collection

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

gaussdb:instance:operateRunningLog

-

Table 9 DR management

Permission

API

Action

Dependency

Establishing a DR relationship

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

gaussdb:disasterRecovery:create

-

Disabling DR log cache for the primary instance

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

gaussdb:disasterRecovery:keeplog

-

Enabling log cache

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

gaussdb:disasterRecovery:keeplog

-

Disabling a DR drill

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

gaussdb:disasterRecovery:simulation

-

Promoting the standby instance in a DR setup to primary

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

gaussdb:disasterRecovery:failover

-

Re-establishing a DR relationship

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

gaussdb:disasterRecovery:create

-

Enabling a DR drill

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

gaussdb:disasterRecovery:simulation

-

Switching roles of primary and standby instances in a DR setup

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

gaussdb:disasterRecovery:switchover

-

Removing a DR relationship

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

gaussdb:disasterRecovery:release

-

Querying operation records

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

gaussdb:instance:listRecord

-

Resetting DR configurations

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

gaussdb:disasterRecovery:create

-

Querying the real-time DR monitoring status of an instance

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

gaussdb:disasterRecovery:listAll

-

Querying established DR relationships

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

gaussdb:disasterRecovery:listAll

-

Table 10 Task management

Permission

API

Action

Dependency

Deleting a task record

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

gaussdb:task:delete

-

Querying tasks

GET /v3/{project_id}/tasks

gaussdb:task:listAll

-

Obtaining information about a task with a specified ID

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

gaussdb:task:get

-

Table 11 Recycle bin

Permission

API

Action

Dependency

Querying all DB engine instances in the recycle bin

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

gaussdb:instance:listAll

-

Configuring a recycling policy

PUT /v3/{project_id}/recycle-policy

gaussdb:instance:setRecyclePolicy

-

Querying the recycling policy

GET /v3/{project_id}/recycle-policy

gaussdb:instance:getRecyclePolicy

-

Table 12 Metric management

Permission

API

Action

Dependency

Querying metrics of all DB instances

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

gaussdb:metric:list

-

Querying metrics of a specific DB instance

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

gaussdb:metric:list

-

Querying metrics of a metric group

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

gaussdb:metric:list

-

Table 13 Tag management

Permission

API

Action

Dependency

Querying tags of a specific instance

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

gaussdb:tag:listAll

-

Querying tags of a project

GET /v3/{project_id}/tags

gaussdb:tag:listAll

-

Querying predefined tags

GET /v3/{project_id}/predefined-tags

gaussdb:tag:listAll

-

Adding tags for a DB instance

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

gaussdb:tag:create

-

Deleting tags of an instance

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

gaussdb:tag:delete

-

Table 14 Storage management

Permission

API

Action

Dependency

Querying the storage usage of a DB instance

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

gaussdb:instance:getDiskUsage

-

Obtaining the disk usage of a shard

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

gaussdb:instance:getDiskUsage

-

Table 15 Quota management

Permission

API

Action

Dependency

Modifying enterprise project quotas

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

gaussdb:quota:update

-

Querying enterprise project quotas

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

gaussdb:quota:listAll

-

Querying the remaining quota of enterprise projects

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

gaussdb:quota:listAll

-

Table 16 Version upgrade

Permission

API

Action

Dependency

Querying upgrade types and versions that instances can be upgraded to in batches

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

gaussdb:instance:upgradeDatabaseVersion

-

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

-

Querying versions that a DB instance can be upgraded to

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

gaussdb:instance:upgradeDatabaseVersion

-

Upgrading kernel versions of instances in batches

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

gaussdb:instance:upgradeDatabaseVersion

-

Upgrading the kernel version of an instance

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

gaussdb:instance:upgradeDatabaseVersion

-

Table 17 Slow SQL statements

Permission

API

Action

Dependency

Querying details of a slow SQL statement

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

gaussdb:instance:getSlowSqlDetail

-

Querying slow SQL statements

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

gaussdb:instance:listSlowSql

-

Querying nodes where there are slow SQL statements

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

gaussdb:instance:listSlowSqlExecuteNode

-

Querying details of slow SQL statements in the global table

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

gaussdb:instance:getSlowSqlDetail

-

Table 18 SQL Explorer

Permission

API

Action

Dependency

Querying full data of a single SQL statement

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

gaussdb:instance:listFullSqls

-

Querying full SQL statistics of an instance

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

gaussdb:instance:listFullSqlStatistics

-

Querying SQL Explorer status records

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

gaussdb:instance:listFullSqlSwitches

-

Querying SQL link information

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

gaussdb:instance:listSqlLinks

-

Querying details of a single SQL statement

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

gaussdb:instance:getFullSql

-

Enabling SQL Explorer or modifying default configurations

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

gaussdb:instance:enableFullSql

-

Disabling SQL Explorer

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

gaussdb:instance:disableFullSql

-

Table 19 Top SQL

Permission

API

Action

Dependency

Querying top SQL statements

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

gaussdb:instance:listTopSql

-

Table 20 Diagnostics and optimization

Permission

API

Action

Dependency

Identifying table information in SQL text

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

gaussdb:instance:listDatabases

-

Table 21 SQL throttling

Permission

API

Action

Dependency

Creating a SQL throttling task

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

gaussdb:instance:createSQLLimitRule

-

Deleting a SQL throttling task

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

gaussdb:instance:deleteSQLLimitRule

-

Querying SQL templates of a specified node

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

gaussdb:instance:getSQLLimitRuleTemplate

-

Querying SQL throttling tasks based on specified criteria

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

gaussdb:instance:getSQLLimitRules

-

Querying SQL throttling task details

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

gaussdb:instance:getSQLLimitRule

-

Synchronizing SQL throttling data from the kernel to the management plane

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

gaussdb:instance:synchronizeSQLLimitRule

-

Modifying a SQL throttling task

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

gaussdb:instance:updateSQLLimitRule

-

Table 22 Session management

Permission

API

Action

Dependency

Querying nodes for delivering key views

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

gaussdb:instance:listKeyViewExecuteNode

-

Querying real-time sessions

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

gaussdb:instance:listRealTimeSession

-

Querying transactions

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

gaussdb:instance:listTransaction

-

Querying wait events

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

gaussdb:instance:listSessionWaitEvents

-

Obtaining the automatic transaction termination configuration

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

gaussdb:instance:getAutoKillTransactionConfig

-

Querying SQL execution plan information

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

gaussdb:instance:getSlowSqlPlan

-

Querying SQL stack information

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

gaussdb:instance:getSlowSqlStack

-

Killing an idle session

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

gaussdb:instance:killFreeSession

-

Killing a session

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

gaussdb:instance:killSession

-

Manually terminating transactions

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

gaussdb:instance:killTransaction

-

Table 23 Workload diagnosis report (WDR)

Permission

API

Action

Dependency

Collecting a WDR snapshot report

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

gaussdb:instance:generateWdr

-

Generating a WDR snapshot

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

gaussdb:instance:createWdrSnapshot

-

Querying WDR snapshot status

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

gaussdb:instance:getWdrSnapshotStatus

-

Enabling or disabling WDR snapshots

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

gaussdb:instance:switchWdrSnapshotStatus

-

Table 24 LTS logs

Permission

API

Action

Dependency

Associating an instance with an LTS log stream

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

gaussdb:instance:bindLtsConfig

-

Viewing LTS log configurations

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

gaussdb:instance:listLtsConfigs

-

Disassociating an instance from an LTS log stream

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

gaussdb:instance:unbindLtsConfig

-

Table 25 Active session profile (ASP)

Permission

API

Action

Dependency

Collecting ASP reports

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

gaussdb:instance:operateAspReport

-

Querying ASP collection results

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

gaussdb:instance:listAspReport

-

Querying ASP generation status

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

gaussdb:instance:listAspReport

-

Enabling or disabling ASP generation

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

gaussdb:instance:operateAspReport

-

Table 26 Homepage overview

Permission

API

Action

Dependency

Obtaining historical alarms

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

gaussdb:alarm:list

-

Collecting instance alarm statistics

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

gaussdb:alarm:list

-

Collecting instance status statistics

GET /v3/instances-statistics

gaussdb:instance:listAll

-

Resources

A resource type indicates the resources that an identity policy applies to. If you specify a resource type for any action in Table 27, the resource URN must be specified in the identity policy statements using that action, and the identity policy applies only to resources of this type. If no resource type is specified, the Resource element is marked with an asterisk (*) and the identity policy applies to all resources. You can also set condition keys in an identity policy to define resource types.

The table below lists the resource types that you can define in identity policy statements for GaussDB.

Table 27 Resource type supported by GaussDB

Resource Type

URN

Instance

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

Conditions

A Condition element lets you specify conditions for when an identity policy is in effect. It contains condition keys and operators.

  • The condition key that you specify can be a global condition key or a service-specific condition key.
    • Global condition keys (with the g: prefix) apply to all actions. Cloud services do not need to provide user identity information. Instead, the system automatically obtains such information and authenticates users. For details, see Global Condition Keys.
    • Service-specific condition keys (with the abbreviation of a service name plus a colon as the prefix, for example, gaussdb:) apply only to operations of the GaussDB service. For details, see Table 28.
    • The number of values associated with a condition key in the request context of an API call makes the condition key single-valued or multivalued. Single-valued condition keys have at most one value in the request context of an API call. Multivalued condition keys can have multiple values in the request context of an API call. For example, a request can originate from at most one VPC endpoint, so g:SourceVpce is a single-valued condition key. You can tag resources and include multiple tag key-value pairs in a request, so g:TagKeys is a multivalued condition key.
  • A condition operator, condition key, and a condition value together constitute a complete condition statement. An identity policy can be applied only when its request conditions are met. For supported condition operators, see Condition operators.

The table below lists the condition keys that you can define in identity policies for GaussDB. You can include these condition keys to specify conditions for when your identity policy is in effect.

Table 28 Service-specific condition keys supported by GaussDB

Service-specific Condition Key

Type

Single-valued/Multivalued

Description

gaussdb:BackupEnabled

boolean

Single-valued

Filter access permissions based on the tag key of whether to enable the backup policy transferred in the request parameter. Select Default for Qualifier.

gaussdb:Encrypted

boolean

Single-valued

Filter access permissions based on the tag key of whether to enable disk encryption transferred in the request parameter. Select Default for Qualifier.

gaussdb:DownloadCategory

string

Single-valued

Filters access by the download policy type name that is passed in the request.

Select Default for Qualifier.

gaussdb:AvailabilityZone

string

Multivalued

Filters access by the AZs that are passed in the request.

Select For any value in the request or For all values in the request for Qualifier.

gaussdb:VpcId

string

Single-valued

Filters access by the VPC ID that is passed in the request.

Select Default for Qualifier.

gaussdb:Subnet

string

Single-valued

Filters access by the subnet ID that is passed in the request.

Select Default for Qualifier.

gaussdb:KmsId

string

Single-valued

Filters access by the disk encryption ID that is passed in the request.

Select Default for Qualifier.

gaussdb:FlavorType

string

Single-valued

Filters access by the specification type that is passed in the request.

Select Default for Qualifier.