API Overview

You can use GaussDB APIs to create and delete DB instances, query DB instances, obtain and modify DB instance parameters, and configure and query automated backup policies. For details, see the following table.

Type	Subtype	Description
GaussDB APIs	DB Engine versions and specifications	Query DB engine versions, query instance specifications, query DB engines, and query specifications that a DB instance can be changed to.
GaussDB APIs	Storage management	Query the disk type of a DB instance.
GaussDB APIs	Instance Management	Manage DB instances, including creating a DB instance, scaling up storage, deleting a DB instance, querying DB instances, obtaining specified DB instances, adding CNs, adding DN shards, resetting a database password, changing a DB instance name, querying the components of a DB instance, changing vCPUs and memory of a DB instance, switching roles of primary and standby DNs in shards, rebooting a DB instance, checking whether host load is unbalanced due to a primary/standby switchover, querying solution template settings, querying EIPs bound to DB instances, validating password strength, binding and unbinding an EIP, querying the SSL certificate download address of a DB instance, and querying instance quotas of a tenant.
GaussDB APIs	Parameter Configuration	Modify parameters of a specified DB instance, obtain parameter templates, obtain the parameters of a specified DB instance, create a parameter template, delete a parameter template, query details about a parameter template, replicate a parameter template, reset a parameter template, obtain the differences of two parameter templates, query instances that a parameter template can be applied to, check whether a parameter template name is unique, apply a parameter template, query application records of a parameter template, and query change history of a parameter template.
GaussDB APIs	Backup and Restoration	Configure an automated backup policy, query an automated backup policy, query backups, create a manual backup, delete a manual backup, query the restoration time range, restore data to a new DB instance, query instances that can be used for backups and restorations, and query information about the original instance based on a specific point of time or a backup file.
GaussDB APIs	Database and Account Management	Create a database, create a database account, create a database schema, configure permissions of database accounts, reset a password for a database account, query databases, query database users, and query database schemas.
GaussDB APIs	Tag Management	Query instance tags, query project tags, query predefined tags, and add tags for instances.
GaussDB APIs	Quota Management	Modify enterprise project quotas and query enterprise project quotas
GaussDB APIs	Task Management	Obtain task information, query tasks, and delete a task record.
GaussDB APIs	Recycle Bin	Set the recycle bin policy, query the recycling policy, and query all DB engine instances in the recycle bin.