All Products
Search
Document Center

Database Backup:RenewBackupPlan

Last Updated:Nov 09, 2022

Renews a backup schedule.

Authorization information

The following table is the authorization information corresponding to the API, which can be found in the RAM permission policy statement.Action Used in the element to grant the RAM user or RAM role permission to call this API. The specific instructions are as follows:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All resources is used in the Resource type column of the operation.
  • Condition keyword: refers to the condition keyword defined by the cloud product itself.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
Operateaccess levelResource typeconditional keywordAssociation operation
dbs:RenewBackupPlanWrite
  • DBS
    acs:dbs:{#regionId}:{#accountId}:backupplan/{#BackupPlanId}
    without
without

Request parameters

ParameterTypeRequiredDescriptionExample
BackupPlanIdstringYes

The ID of the backup schedule.

dbstooi01exxx
PeriodstringYes

Specifies whether to use yearly subscription or monthly subscription for the instance. Valid values:

  • Year
  • Month
Month
UsedTimeintegerYes

The subscription duration of the instance. Valid values:

  • If the Period parameter is set to Year, the value of the UsedTime parameter ranges from 1 to 9.
  • If the Period parameter is set to Month, the value of the UsedTime parameter ranges from 1 to 11.
1
ClientTokenstringNo

The client token that is used to ensure the idempotence of the request.

HKAJHFIUEQWBFIJSNFOIWHN

Response parameters

ParameterTypeDescriptionExample
object
HttpStatusCodeinteger

The HTTP status code.

200
RequestIdstring

The ID of the request.

D6E068C3-25BC-455A-85FE-45F0B22ECB1F
ErrCodestring

The error code.

Param.NotFound
Successboolean

Indicates whether the request is successful.

true
ErrMessagestring

The error message.

The specified parameter %s value is not valid.
BackupPlanIdstring

The ID of the backup schedule.

dbstooi01exxx
OrderIdstring

The ID of the order.

202020202020

Example

Normal return example

JSONFormat

{
  "HttpStatusCode": 200,
  "RequestId": "D6E068C3-25BC-455A-85FE-45F0B22ECB1F",
  "ErrCode": "Param.NotFound",
  "Success": true,
  "ErrMessage": "The specified parameter %s value is not valid. ",
  "BackupPlanId": "dbstooi01exxx",
  "OrderId": "202020202020"
}

Error codes

For a list of error codes, visit the API error center.