Help Center/ Relational Database Service/ API Reference/ API v3/ Backup and Restoration/ Modifying an Incremental Backup Policy (RDS for SQL Server)
Updated on 2026-09-20 GMT+08:00

Modifying an Incremental Backup Policy (RDS for SQL Server)

Function

This API is used to modify an incremental backup policy.

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:modifyBackupPolicy

write

instance

-

rds:instance:modifyBackupPolicy

-

URI

  • URI format

    PUT /v3/{project_id}/instances/{instance_id}/incre-backup/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.

    You can obtain the value of this parameter from id in Table 4 by calling the API for querying DB instances.

    Constraints

    N/A

    Range

    N/A

    Default Value

    N/A

Request

Table 2 Parameters

Parameter

Mandatory

Type

Description

incre_backup_policy

Yes

Object

Definition

Incremental backup policy.

For details, see Table 3.

Constraints

N/A

Table 3 incre_backup_policy field description

Parameter

Mandatory

Type

Description

interval

No

Integer

Definition

Incremental backup interval, in minutes.

Constraints

N/A

Range

  • 5
  • 10
  • 15
  • 20
  • 25
  • 30
  • 45
  • 60

Default Value

5

Example Request

Modify an incremental backup policy.

PUT https://{Endpoint}/v3/0483b6b16e954cb88930a360d2c4e663/instances/b086e7af46d94c34a02a516f6b404de2in04/incre-backup/policy
{
  "incre_backup_policy" : { 
    "interval" : 10 
  } 
}

Response

  • Normal response
    Table 4 Parameters

    Parameter

    Type

    Description

    job_id

    String

    Definition

    Workflow ID.

    Range

    N/A

  • Example normal response
    {
      "job_id" : "2217d6f8-a3ea-46af-8992-ce5df9d29384" 
    }

Status Code

Error Code

For details, see Error Codes.