Call RenewBackupPlan to renew a DBS backup schedule.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes RenewBackupPlan

The parameter specified by the system. Value: RenewBackupPlan.

BackupPlanId String Yes dbstooi01exxx

The ID of the backup plan.

Period String Yes Month

The billing cycle of the new instance. Valid values:

  • Year: subscription on a yearly basis
  • Month: subscription on a monthly basis
UsedTime Integer Yes 1

The duration of the new instance if the new instance uses subscription billing. Valid values:

  • If the value of the Period parameter is Year, the value of the UsedTime parameter ranges from 1 to 9.
  • If the value of the Period parameter is Month, the value of the UsedTime parameter ranges from 1 to 11.
RegionId String No cn-hangzhou

The region ID. You can call DescribeRegions query.

ClientToken String No HKAJHFIUEQWBFIJSNFOIWHN

The idempotence parameter.

Response parameters

Parameter Type Example Description
BackupPlanId String dbstooi01exxx

The ID of the backup plan.

ErrCode String Param.NotFound

The error code.

ErrMessage String The specified parameter %s value is not valid.

The error message.

HttpStatusCode Integer 200

HTTP status code.

OrderId String 202020202020

The ID of the order.

RequestId String D6E068C3-25BC-455A-85FE-45F0B22ECB1F

The ID of the request.

Success Boolean true

Indicates whether the request was successful.

Examples

Sample requests

http(s)://dbs-api.cn-hangzhou.aliyuncs.com/? Action=RenewBackupPlan
&BackupPlanId=dbstooi01ex7ltj
&Period=Month
&UsedTime=1
&<Common request parameters>

Sample success responses

XML format

<RenewBackupPlanReponse>
  <RequestId>D6E068C3-25BC-455A-85FE-45F0B22ECB1F</RequestId>
  <HttpStatusCode>200</HttpStatusCode>
  <BackupPlanId>dbs1h****usfa</BackupPlanId>
  <OrderId>2056157****</OrderId>
  <Success>true</Success>
</RenewBackupPlanReponse>

JSON format

{
	"RequestId": "D6E068C3-25BC-455A-85FE-45F0B22ECB1F",
	"HttpStatusCode": 200,
	"BackupPlanId": "dbs1h****usfa",
	"OrderId": "2056157****",
	"Success": true
}

Error codes

For a list of error codes, visit the API Error Center.