Updated on 2023-11-21 GMT+08:00

GeminiDB Actions

Table 1 Instance management actions

Permission

API

Action

IAM Project

Enterprise Project

Creating an Instance

POST /v3/{project_id}/instances

nosql:instance:create

Deleting an instance

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

nosql:instance:delete

Querying instances

GET /v3/{project_id}/instances?id={id}&name={name}&mode={mode}&datastore_type={datastore_type}&vpc_id={vpc_id}&subnet_id={subnet_id}&offset={offset}&limit={limit}

nosql:instance:list

Scaling up storage space of an instance

POST /v3/{project_id}/instances/{instance_id}/extend-volume

nosql:instance:modifyStorageSize

Adding nodes for a cluster instance

POST /v3/{project_id}/instances/{instance_id}/enlarge-node

nosql:instance:extendNode

Deleting nodes from a cluster instance

POST /v3/{project_id}/instances/{instance_id}/reduce-node

nosql:instance:reduceNode

Changing specifications of an instance

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

nosql:instance:modifySpecification

Changing the administrator password

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

nosql:instance:modifyPasswd

Editing the name of an instance

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

nosql:instance:rename

Changing the security group of an instance

PUT /v3/{project_id}/instances/{instance_id}/security-group

nosql:instance:modifySecurityGroup

Upgrading minor version

POST

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

nosql:instance:upgradeDatabaseVersion

Creating cold storage

POST /v3/{project_id}/instances/{instance_id}/cold-volume

nosql:instance:modifyStorageSize

Scaling up cold storage

PUT /v3/{project_id}/instances/{instance_id}/cold-volume

nosql:instance:modifyStorageSize

Binding or unbinding an EIP

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

nosql:instance:bindPublicIp

Enabling or disabling SSL

POST /v3/{project_id}/instances/{instance_id}/ssl-option

nosql:instance:switchSSL

Restarting an instance

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

nosql:instance:restart

Configuring autoscaling policies for storage space

PUT /v3/{project_id}/instances/disk-auto-expansion

nosql:instance:modifyStorageSize

Table 2 Actions for backups and restorations

Permission

API

Action

IAM Project

Enterprise Project

Querying an automated backup policy

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

nosql:backup:list

Configuring an automated backup policy

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

nosql:instance:modifyBackupPolicy

Querying instances that can be restored

GET /v3/{project_id}/backups/{backup_id}/restorable-instances

nosql:instance:list

Querying the time window when a backup can be restored

GET /v3/{project_id}/instances/{instance_id}/backups/restorable-time-periods

nosql:backup:list

Creating a manual backup

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

nosql:backup:create

Deleting a manual backup

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

nosql:backup:delete

Restoring data to an existing instance

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

nosql:backup:refreshInstanceFromBacku

Table 3 Parameter template management actions

Permission

API

Action

IAM Project

Enterprise Project

Obtaining parameter templates

GET /v3/{project_id}/configurations

nosql:param:list

Creating a parameter template

POST

/v3/{project_id}/configurations

nosql:param:create

Modifying parameters in a parameter template

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

nosql:param:modify

Applying a parameter template

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

nosql:instance:modifyParameter

Modifying parameters of a specified instance

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

nosql:instance:modifyParameter

Obtaining parameters of a specified instance

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

nosql:param:list

Obtaining parameters of a specified parameter template

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

nosql:param:list

Deleting a parameter template

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

nosql:param:delete

Table 4 Tag management actions

Permission

API

Action

IAM Project

Enterprise Project

Querying an instance by tag

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

  • nosql:instance:list
  • nosql:tag:list

Adding or deleting resource tags in batches

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

nosql:instance:tag

Querying tags of an instance

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

  • nosql:instance:list
  • nosql:tag:list

Table 5 Quota management actions

Permission

API

Action

IAM Project

Enterprise Project

Querying resource quotas

GET /v3/{project_id}/quotas

nosql:instance:list

Table 6 Actions for disaster recovery management

Permission

API

Action

IAM Project

Enterprise Project

Performing a pre-check for DR

POST /v3/{projectId}/instance/{instanceId}/disaster-recovery/precheck

nosql:dr:precheck

Creating a DR relationship

POST /v3/{projectId}/instance/{instanceId}/disaster-recovery/construction

nosql:dr:construct

Deleting a DR relationship

POST /v3/{projectId}/instance/{instanceId}/disaster-recovery/deconstruction

nosql:dr:deconstruct

Obtaining role information of a DR instance

POST

/v3/{project_id}/instances/{instance_id}/instance-role

nosql:instance:switchoverDisaterRecovery

Promoting a DR instance from standby to primary

POST

/v3/{project_id}/instances/{instance_id}/switchover-master

nosql:instance:switchoverFromDisaterToMaster

Demoting a DR instance from primary to standby

POST

/v3/{project_id}/instances/{instance_id}/switchover-slave

nosql:instance:switchoverFromMasterToDisater

Pausing/Resuming data synchronization between two instances with a DR relationship

POST /v3/{project_id}/instances/{instance_id}/disaster-recovery/data-synchronization

nosql:dr:operateDataSync

The check mark (√) indicates that the action takes effect. The cross mark (x) indicates that the action does not take effect.