Updated on 2026-09-22 GMT+08:00

Querying an Automated Backup Policy

This API is used to query an automated backup policy, including GeminiDB Cassandra databases and tables.

This API will be unavailable. You are advised to switch workloads to the new API described in Querying an Automated Backup Policy.

This API supports the following instances:

Each account has permissions to call all APIs, but IAM users must have the required permissions specifically assigned.

If you are using role/policy-based authorization, see the required permissions in Permissions and Supported Actions.

If you are using identity policy-based authorization, the following identity policy-based permissions are required.

Action	Access Level	Resource Type (*: required)	Condition Key	Alias	Dependencies
gaussdbfornosql:instance:getBackupPolicy	Read	instance *	g:ResourceTag/<tag-key> g:EnterpriseProjectId	nosql:backup:modifyBackupPolicy	-

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

**Table 1** URI parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Definition Project ID of a tenant in a region. To obtain this value, see Obtaining a Project ID. Constraints N/A Range The value contains 32 characters. Only letters and digits are allowed. Default Value N/A
instance_id	Yes	String	Definition Instance ID. To obtain the value, call the Querying Instances and Details API. If no instance is available, call the Creating an Instance API to create one. Constraints N/A Range N/A Default Value N/A

**Table 2** Query parameters
Parameter	Mandatory	Type	Description
type	No	String	Definition Backup policy type. This parameter is available only to GeminiDB Cassandra API. Constraints N/A Range Instance: An instance backup is queried. DatabaseTable: A database or table backup is queried. Default Value Instance

**Table 3** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	Definition User token You can obtain the token by calling the IAM API by following Obtaining a User Token Through Password Authentication. Constraints N/A Range N/A Default Value N/A

Status code: 202

**Table 4** Response body parameters
Parameter	Type	Description
backup_policy	Table 5 object	Definition Backup policy objects, including the backup retention period (days) and start time.

**Table 5** ShowBackupPolicyResult
Parameter	Type	Description
keep_days	Integer	Definition Backup retention days Range N/A
start_time	String	Definition Backup time window. Automated backups will be created during the backup time window. Range N/A
period	String	Definition Backup cycle. Automated backups will be created on the specified days every week. Range N/A

URI example

GET https://{Endpoint}/v3/054b61972980d4552f0bc00ac8d3f5cd/instances/764b8a2763d34414ad3f2d5495416cb5in06/backups/policy?type=DatabaseTable

Status code: 202

Success

Enabling automated backup

{
   "backup_policy" : { 
     "keep_days" : 7, 
     "start_time" : "19:00-20:00", 
     "period" : "1,2,4,5,6" 
   }
 }

Disabling automated backup

{
  "backup_policy" : {
    "keep_days" : 0
  }
}

For details, see Status Codes.

For details, see Error Codes.

Parent topic: Backup and Restoration