Setting a Cross-Region Backup Policy

Function

This API is used to set a cross-region backup policy in the source backup region.

• Before calling this API, learn how to authenticate it.
• Before calling this API, learn about the request header parameters.

Authorization Information

Constraints

• If the cross-region backup policy has been enabled, call the API to set the cross-region backup policy. Only the retention period can be changed.
• For RDS for PostgreSQL DB instances, the retention period of automated full backups must be the same as that for automated incremental backups.
• For RDS for PostgreSQL DB instances, automated incremental backup cannot be enabled unless automated full backup is enabled first.
• For RDS for PostgreSQL DB instances, if you want to disable automated full backup and automated incremental backup, disable automated incremental backup first.
• Cross-region backup is not supported for RDS for PostgreSQL instances with volume snapshot backup enabled.

URI

• URI format

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

• Parameter description

  Table 1 Parameters

  Parameter	Mandatory	Description
  project_id	Yes	Definition Project ID of a tenant in a region. Constraints The value cannot be empty. Range To obtain the value, see Obtaining a Project ID. Default Value N/A
  instance_id	Yes	Definition Instance ID. Constraints The value cannot be empty. Range You can obtain the value of this parameter from id in Table 4 by calling the API for querying DB instances. Default Value N/A

Request

Example Request

• Configure a cross-region automated full backup policy for an RDS for MySQL or RDS for PostgreSQL DB instance.

  PUT https://{Endpoint}/v3/0483b6b16e954cb88930a360d2c4e663/instances/dsfae23fsfdsae3435in01/backups/offsite-policy
  
  {
  	"policy_para": {
                  "backup_type": "auto",
  		"keep_days": 7,
  		"destination_region": "aaa",
  		"destination_project_id": "ba1f7fc8-3307-42a7-aa6f-42c8b9b8f85c"
  	}
  }

• Disable the cross-region automated full backup policy for an RDS for MySQL or RDS for PostgreSQL DB instance.

  {
  	"policy_para": {
                  "backup_type": "auto",
  		"keep_days": 0,
  		"destination_region": "aaa",
  		"destination_project_id": "ba1f7fc8-3307-42a7-aa6f-42c8b9b8f85c"
  	}
  }

• Configure a cross-region backup policy for an RDS for SQL Server DB instance.

  {
  	"policy_para": {
                  "backup_type": "all",
  		"keep_days": 7,
  		"destination_region": "aaa",
  		"destination_project_id": "ba1f7fc8-3307-42a7-aa6f-42c8b9b8f85c"
  	}
  }

• Disable the cross-region backup policy for an RDS for SQL Server DB instance.

  {
  	"policy_para": {
                  "backup_type": "all",
  		"keep_days": 0,
  		"destination_region": "aaa",
  		"destination_project_id": "ba1f7fc8-3307-42a7-aa6f-42c8b9b8f85c"
  	}
  }

Response

• Normal response

  Table 4 Parameters

  Parameter	Type	Description
  resp	String	Definition Calling result. Range Returns successful if the calling is successful.

• Example normal response

  {
       "resp": "successful"
  }

• Abnormal Response

  For details, see Abnormal Request Results.

Status Code

• Normal

  200

• Abnormal

  For details, see Status Codes.

Error Code

For details, see Error Codes.