zhangyue 2cbc3d7335 GaussDB_nosql API DOC

Reviewed-by: Boka, Ladislav <ladislav.boka@t-systems.com>
Co-authored-by: zhangyue <zhangyue164@huawei.com>
Co-committed-by: zhangyue <zhangyue164@huawei.com>

2023-10-13 12:54:25 +00:00

15 KiB

Raw Blame History

Querying an Automated Backup Policy

Function

This API is used to query an automated backup policy.

Constraints

This API supports GaussDB(for Cassandra) instances.

URI

GET https://{Endpoint}/v3/{project_id}/instances/{instance_id}/backups/policy

**Table 1** Path parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID of a tenant in a region. To obtain this value, see Obtaining a Project ID.
instance_id	Yes	String	Instance ID

**Table 2** Query parameters
Parameter	Mandatory	Type	Description
type	No	String	Backup policy type. This parameter is available only to GaussDB(for Cassandra). The value can be: Instance: indicates that an instance backup is queried. DatabaseTable: indicates that a database or table backup is queried.

Request Parameters

**Table 3** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	User token

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
backup_policy	object	Backup policy objects, including backup retention period (days) and start time For details, see Table 5.
database_tables	Array of objects	Database and table information in the backup. This parameter is available only to GaussDB(for Cassandra). For details, see Table 6. Keep this parameter empty or ignore it when you query an instance backup. Remember to specify this parameter when you query a database or table backup (if any).

**Table 5** ShowBackupPolicyResult
Parameter	Type	Description
keep_days	Integer	Backup retention days
start_time	String	Backup time window. Automated backup will be triggered during the backup time window.
period	String	Backup period. After a backup period is specified, data will be automatically backed up on the selected days every week.

**Table 6** QueryDatabaseTableInfo
Parameter	Type	Description
database_name	String	Database name
table_names	Array of strings	Table names. If this parameter is empty, database names are queried. If this parameter is not empty, table names are queried.

Example Requests

URI example

GET https://{Endpoint}/v3/375d8d8fad1f43039e23d3b6c0f60a19/instances/9136fd2a9fcd405ea4674276ce36dae8in02/backups/policy?type=Instance

Example Responses

Status code: 200

Success

Response when an automated backup policy is enabled

{
  "backup_policy" : {
    "keep_days" : 7,
    "start_time" : "19:00-20:00",
    "period" : "1,2,4,5,6"
  }, 
   "database_tables" : [ { 
     "database_name" : "databaseNameA", 
     "table_names" : [ "table_A", "table_B" ] 
   }, { 
     "database_name" : "databaseNameB", 
     "table_names" : null 
   } ] 
}

Response when an automated backup policy is disabled

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

Status Codes

For details, see Status Codes.

Error Codes

For details, see Error Codes.

Parent topic: Backups and Restorations

15 KiB Raw Blame History