Help Center/ GaussDB/ API Reference/ Permissions Policies and Supported Actions/ GaussDB Actions

Updated on 2025-10-20 GMT+08:00

View PDF

GaussDB Actions

**Table 1** DB instance management
Permission	Action	Authorization Scope	API
Creating a DB instance	gaussdb:instance:create gaussdb:param:list	Supported: IAM projects Supported: Enterprise projects	POST /v3/{project_id}/instances
Deleting a DB instance	gaussdb:instance:delete	Supported: IAM projects Supported: Enterprise projects	DELETE /v3/{project_id}/instances/{instance_id}
Querying DB instances	gaussdb:instance:list	Supported: IAM projects Supported: Enterprise projects	GET /v3/{project_id}/instances
Resetting a database password	gaussdb:instance:modifyPasswd	Supported: IAM projects Supported: Enterprise projects	POST /v3/{project_id}/instances/{instance_id}/password
Changing a DB instance name	gaussdb:instance:rename	Supported: IAM projects Supported: Enterprise projects	PUT /v3/{project_id}/instances/{instance_id}/name
Rebooting a DB instance	gaussdb:instance:restart	Supported: IAM projects Supported: Enterprise projects	POST /v3/{project_id}/instances/{instance_id}/restart
Switching roles of the primary and standby DNs in shards	gaussdb:instance:switchShard	Supported: IAM projects Supported: Enterprise projects	POST /v3/{project_id}/instances/{instance_id}/switch-shard
Querying the components of a DB instance	gaussdb:instance:list	Supported: IAM projects Supported: Enterprise projects	GET /v3/{project_id}/instances/{instance_id}/components
Changing vCPUs and memory of a DB instance	gaussdb:instance:modifySpec	Supported: IAM projects Supported: Enterprise projects	PUT /v3/{project_id}/instance/{instance_id}/flavor
Checking whether host load is unbalanced due to a primary/standby switchover	gaussdb:instance:list	Supported: IAM projects Supported: Enterprise projects	GET /v3/{project_id}/instances/{instance_id}/balance
Querying solution template settings	gaussdb:instance:list	Supported: IAM projects Supported: Enterprise projects	GET /v3/{project_id}/deployment-form
Querying EIPs bound to a DB instance	gaussdb:instance:list	Supported: IAM projects Supported: Enterprise projects	GET /v3/{project_id}/instances/{instance_id}/public-ips?offset={offset}&limit={limit}
Binding or unbinding an EIP	gaussdb:instance:bindPublicIp	Supported: IAM projects Supported: Enterprise projects	POST /v3/{project_id}/instances/{instance_id}/nodes/{node_id}/public-ip
Querying the SSL certificate download address of a DB instance	gaussdb:instance:list	Supported: IAM projects Supported: Enterprise projects	GET /v3/{project_id}/instances/{instance_id}/ssl-cert/download-link
Querying the instance quotas of a tenant	gaussdb:instance:list	Supported: IAM projects Supported: Enterprise projects	GET /v3/{project_id}/project-quotas?type={type}

**Table 2** Parameter configuration
Permission	Action	Authorization Scope	API
Obtaining parameter templates	gaussdb:param:list	Supported: IAM projects Supported: Enterprise projects	GET /v3/{project_id}/configurations?offset={offset}&limit={limit}
Obtaining parameters of a specified DB instance	gaussdb:param:list	Supported: IAM projects Supported: Enterprise projects	GET /v3/{project_id}/instances/{instance_id}/configurations
Modifying parameters of a specified DB instance	gaussdb:param:modify	Supported: IAM projects Supported: Enterprise projects	PUT /v3/{project_id}/instances/{instance_id}/configurations
Creating a parameter template	gaussdb:param:create	Supported: IAM projects Supported: Enterprise projects	POST /v3/{project_id}/configurations
Deleting a parameter template	gaussdb:param:delete	Supported: IAM projects Supported: Enterprise projects	DELETE /v3/{project_id}/configurations/{config_id}
Querying details about a parameter template	gaussdb:instance:list	Supported: IAM projects Supported: Enterprise projects	GET /v3/{project_id}/configurations/{config_id}
Replicating a parameter template	gaussdb:param:create	Supported: IAM projects Supported: Enterprise projects	POST /v3/{project_id}/configurations/{config_id}/copy
Resetting a parameter template	gaussdb:param:modify	Supported: IAM projects Supported: Enterprise projects	POST /v3/{project_id}/configurations/{config_id}/reset
Obtaining the differences of two parameter templates	gaussdb:param:list	Supported: IAM projects Supported: Enterprise projects	POST /v3/{project_id}/configurations/comparison
Querying instances that a parameter template can be applied to	gaussdb:instance:list	Supported: IAM projects Supported: Enterprise projects	GET /v3/{project_id}/configurations/{config_id}/applicable-instances
Checking whether the parameter template name exists	gaussdb:instance:list	Supported: IAM projects Supported: Enterprise projects	GET /v3/{project_id}/configurations/name-validation?name={name}
Applying a parameter template	gaussdb:param:apply	Supported: IAM projects Supported: Enterprise projects	PUT /v3/{project_id}/configurations/{config_id}/apply
Querying application records of a parameter template	gaussdb:instance:list	Supported: IAM projects Supported: Enterprise projects	GET /v3/{project_id}/configurations/{config_id}/applied-histories
Querying the change history of a parameter template	gaussdb:param:list	Supported: IAM projects Supported: Enterprise projects	GET /v3/{project_id}/configurations/{config_id}/histories

**Table 3** Backup management
Permission	Action	Authorization Scope	API
Configuring an automated backup policy	gaussdb:instance:modifyBackupPolicy	Supported: IAM projects Supported: Enterprise projects	PUT /v3/{project_id}/instances/{instance_id}/backups/policy
Querying an automated backup policy	gaussdb:backup:list	Supported: IAM projects Supported: Enterprise projects	GET /v3/{project_id}/instances/{instance_id}/backups/policy
Querying backups	gaussdb:backup:list	Supported: IAM projects Supported: Enterprise projects	GET /v3/{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}
Creating a manual backup	gaussdb:backup:create	Supported: IAM projects Supported: Enterprise projects	POST /v3/{project_id}/backups
Deleting a manual backup	gaussdb:backup:delete	Supported: IAM projects Supported: Enterprise projects	DELETE /v3/{project_id}/backups/{backup_id}
Querying the restoration time range	gaussdb:backup:list	Supported: IAM projects Supported: Enterprise projects	GET /v3/{project_id}/instances/{instance_id}/restore-time?date={date}
Restoring data to a new instance	gaussdb:instance:create	Supported: IAM projects Supported: Enterprise projects	POST /v3/{project_id}/instances
Querying instances that can be used for backups and restorations	gaussdb:instance:list	Supported: IAM projects Supported: Enterprise projects	GET /v3/{project_id}/restorable-instances
Querying information about the original DB instance based on a specific point of time or a backup file	gaussdb:instance:list	Supported: IAM projects Supported: Enterprise projects	GET /v3/{project_id}/instance-snapshot?instance_id={instance_id}&backup_id={backup_id}&restore_time={restore_time}

**Table 4** DB Engine versions and specifications
Permission	Action	Authorization Scope	API
Querying DB engine versions	gaussdb:instance:list	Supported: IAM projects Supported: Enterprise projects	GET /v3/{project_id}/datastore/versions
Querying database specifications	gaussdb:instance:list	Supported: IAM projects Supported: Enterprise projects	GET /v3/{project_id}/flavors?limit={limit}&offset={offset}&ha_mode={ha_mode}&version={version}&spec_code={spec_code}
Querying DB engines	gaussdb:instance:list	Supported: IAM projects Supported: Enterprise projects	GET /v3/{project_id}/datastores
Querying specifications that a DB instance can be changed to	gaussdb:instance:list	Supported: IAM projects Supported: Enterprise projects	GET /v3/{project_id}/instances/{instance_id}/available-flavors

**Table 5** Database and account management
Permission	Action	Authorization Scope	API
Creating a database	gaussdb:instance:createDatabase	Supported: IAM projects Supported: Enterprise projects	POST /v3/{project_id}/instances/{instance_id}/database
Creating a database account	gaussdb:instance:createDatabaseUser	Supported: IAM projects Supported: Enterprise projects	POST /v3/{project_id}/instances/{instance_id}/db-user
Creating a database schema	gaussdb:instance:createDatabaseSchema	Supported: IAM projects Supported: Enterprise projects	POST /v3/{project_id}/instances/{instance_id}/schema
Configuring permissions of database accounts	gaussdb:instance:grantDatabasePrivilege	Supported: IAM projects Supported: Enterprise projects	POST /v3/{project_id}/instances/{instance_id}/db-privilege
Resetting a password for a database account	gaussdb:instance:modifyDatabasePasswd	Supported: IAM projects Supported: Enterprise projects	PUT /v3/{project_id}/instances/{instance_id}/db-user/password
Querying databases	gaussdb:instance:list	Supported: IAM projects Supported: Enterprise projects	GET /v3/{project_id}/instances/{instance_id}/databases
Querying database users	gaussdb:instance:list	Supported: IAM projects Supported: Enterprise projects	GET /v3/{project_id}/instances/{instance_id}/db-users
Querying database schemas	gaussdb:instance:list	Supported: IAM projects Supported: Enterprise projects	GET /v3/{project_id}/instances/{instance_id}/schemas

**Table 6** Tag management
Permission	Action	Authorization Scope	API
Querying tags of a specific instance	gaussdb:instance:list	Supported: IAM projects Supported: Enterprise projects	GET /v3/{project_id}/instances/{instance_id}/tags
Querying tags of a project	gaussdb:instance:list	Supported: IAM projects Supported: Enterprise projects	GET /v3/{project_id}/tags
Querying predefined tags	gaussdb:instance:list	Supported: IAM projects Supported: Enterprise projects	GET /v3/{project_id}/predefined-tags
Adding tags for a DB instance	gaussdb:instance:dealTag	Supported: IAM projects Supported: Enterprise projects	POST /v3/{project_id}/instances/{instance_id}/tags

**Table 7** Storage management
Permission	Action	Authorization Scope	API
Querying the storage usage of a DB instance	gaussdb:instance:list	Supported: IAM projects Supported: Enterprise projects	GET /v3/{project_id}/instances/{instance_id}/volume-usage
Querying the disk type of a DB instance	gaussdb:instance:list	Supported: IAM projects Supported: Enterprise projects	GET /v3/{project_id}/storage-type?version={version}&ha_mode={ha_mode}

**Table 8** Quota management
Permission	Action	Authorization Scope	API
Modifying enterprise project quotas	gaussdb:quota:modify	Supported: IAM projects Supported: Enterprise projects	PUT /v3/{project_id}/enterprise-projects/quotas
Querying enterprise project quotas	gaussdb:instance:list	Supported: IAM projects Supported: Enterprise projects	GET /v3/{project_id}/enterprise-projects/quotas

**Table 9** Task management
Permission	Action	Authorization Scope	API
Obtaining task information	gaussdb:instance:list	Supported: IAM projects Supported: Enterprise projects	GET /v3/{project_id}/jobs?id={id}
Querying tasks	gaussdb:instance:list	Supported: IAM projects Supported: Enterprise projects	GET /v3/{project_id}/tasks
Deleting a task record	gaussdb:instance:deleteTaskRecord	Supported: IAM projects Supported: Enterprise projects	DELETE /v3/{project_id}/jobs/{job_id}

**Table 10** Recycle bin
Permission	Action	Authorization Scope	API
Modifying the recycling policy	gaussdb:instance:setRecyclePolicy	Supported: IAM projects Supported: Enterprise projects	PUT /v3/{project_id}/recycle-policy
Querying the recycling policy	gaussdb:instance:list	Supported: IAM projects Supported: Enterprise projects	GET /v3/{project_id}/recycle-policy
Querying all DB engine instances in the recycle bin	gaussdb:instance:list	Supported: IAM projects Supported: Enterprise projects	GET /v3/{project_id}/recycle-instances

Parent topic: Permissions Policies and Supported Actions

Previous topic: Introduction

Next topic: Appendix

Feedback

Was this page helpful?

Helpful Not helpful

Provide feedback

Thank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.

The system is busy. Please try again later.

Which of the following issues have you encountered?

Content is inconsistent with the product UI

Unclear descriptions

Lack of examples or code

Incorrect steps

Can't find what I need

Lack of best practices

Feedback (optional)

0/500

Select at least one type of issue, and enter your comments or suggestions.

Enter a maximum of 500 characters.

Submit Cancel

For any further questions, feel free to contact us through the chatbot.