Querying Automatic Transfer Policies (RDS for MySQL)

Function

This API is used to query automatic backup transfer policies of a DB instance.

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

Authorization Information

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

If you are using role/policy-based authorization, see Permissions and Supported Actions for details on the required permissions.
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
rds:instance:getBackupPolicy	read	-	-	rds:instance:list	-

URI

URI format
GET /v3/{project_id}/instances/{instance_id}/transfer/policy

Parameter description

**Table 1** Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Definition Project ID of a tenant in a region. To obtain the value, see Obtaining a Project ID. Constraints N/A Range N/A Default Value N/A
instance_id	Yes	String	Definition Instance ID. Constraints N/A Range N/A Default Value N/A

Request

None

Example Request

Query automatic backup transfer policies of a DB instance.

GET https://{Endpoint}/v3/0483b6b16e954cb88930a360d2c4e663/instances/e38d120bb5a640519fb2a1613140afd9in01/transfer/policy

Response

Normal response

**Table 2** Parameters
Parameter	Type	Description
policies	Array of objects	Definition List of transfer policies. For details, see Table 3.

**Table 3** policies field description
Parameter	Type	Description
setting_id	String	Definition Policy ID. Range N/A
instance_id	String	Definition Instance ID. Range N/A
period	String	Definition Transfer period. Range The value is a list of digits separated by commas (,). Each digit indicates a day of the week. For example, the value 1,2,3,4 indicates that the transfer period is every Monday, Tuesday, Wednesday, and Thursday. If you set this parameter to 1 (Monday), the backups generated on Monday will be automatically transferred to the destination OBS bucket on Tuesday.
backup_type	String	Definition Type of backups to be transferred. Range Db: automated backup Log: incremental backup Snapshot: manual backup
destination	String	Definition Storage destination. Range 0 to 128 characters
prefix	String	Definition Prefix of the transfer destination. Range The value can contain 0 to 128 characters and must end with a slash (/).

Example normal response

{ 
    "policies":[ 
        { 
         "setting_id":"7c781e6a-d215-4482-bf15-cfe04cc7eb96", 
         "instance_id":"e4e2ee2f2c7943f1a9f9c817b993dc0ein01", 
         "period":"* * 1,2,3,4,5,6,7", 
         "backup_type":"Db", 
         "destination":"xxxbucket", 
         "prefix":"aaa/auto/" 
        } 
    ] 
}