API Introduction

Renew a VBS repository. This process may involve billing items.

API Restrictions

None

<span lang="EN-US">POST /v4/ebs-backup/repo/renew</span>

Path Parameter

None

Query Parameter

None

Request Header Parameter

None

Request Body Parameter

Parameter	Required or Not	Parameter Type	Description	Example
clientToken	Yes	String	Ensure order idempotence. This value must be unique within the whole cloud account. Requests with the same ClientToken value and having the same other parameters are considered as the same request.	4cf2962d-e92c-4c00-9181-cfbb2218636c
regionID	Yes	String	Resource Pool ID	81f7728662dd11ec810800155d307d5b
repositoryID	Yes	String	Repository ID.	3df0974e-bbf7-43fa-acc1-af2b69cc184d
cycleType	Yes	String	Subscription type. Value range: MONTH and YEAR. The maximum subscription duration is three years.	MONTH
cycleCount	Yes	Integer	Subscription duration. This parameter is used with the cycleType parameter. When cycleType is set to MONTH, the parameter unit is in month. When cycleType is set to YEAR, the parameter unit is in year.	1

Parameter	Required or Not	Type	Description	Example	Lower-level Object
statusCode	Yes	Integer	Return status code (800 indicates success, 900 indicates failure).	800
message	Yes	String	Error descripting in English.	SUCCESS
description	Yes	String	Error description in Chinese.	Successful
errorCode	No	String	Business code, returned upon failures.	Refer to error codes
returnObj	No	Object	Data returned upon success. Refer to returnObj object structures.		returnObj

Table returnObj

Parameter	Required or Not	Parameter Type	Description	Example
masterOrderID	Yes	String	Order ID. The caller can check status of the order and resources among multiple errors based on the masterOrderID parameter.	235145e4489811eda8330242ac110002
masterOrderNO	Yes	String	Order Number	20221010142913884246
regionID	Yes	String	Resource pool ID.	81f7728662dd11ec810800155d307d5b

Request Header

None

Request Body

    "clientToken": "4cf2962d-e92c-4c00-9181-cfbb2218636c",

    "regionID": "81f7728662dd11ec810800155d307d5b",

    "repositoryID": "3df0974e-bbf7-43fa-acc1-af2b69cc184d",

    'cycleType': 'YEAR',

    'cycleCount': 1,

    "returnObj": {

        "masterOrderNO": "20230117110917176751",

        "regionID": "81f7728662dd11ec810800155d307d5b",

        "masterOrderID": "538c8f60961411edb50d0242ac110010"

},

    "message": "SUCCESS",

    "description": "Successful",

    "statusCode": 800

errorCode	Description
EbsBackup.RegionInfo.Empty	The resource pool information is empty or does not exist. Check whether the resource pool ID is valid.
EbsBackup.RegionInfo.AccessFailed	Failed to query the resource pool. Please try again. If the failure keeps happening, please submit a ticket.
EbsBackup.RegionInfo.DataDamaged	The resource pool information is incorrect. Please try again. If the failure keeps happening, please submit a ticket.
EbsBackup.RepositoryInfo.NotFound	The VBS repository is not found.
EbsBackup.Parameter.InvalidRepositoryID	Invalid request parameter: {Reason}.
EbsBackup.Parameter.InvalidRegionID	Invalid request parameter: {Reason}.
EbsBackup.Parameter.InvalidCycle	Invalid request parameter: {Reason}.
EbsBackup.Parameter.InvalidCycleCount	Invalid request parameter: {Reason}.
EbsBackup.Parameter.InvalidCycleType	Invalid request parameter: {Reason}.
EbsBackup.Parameter.InvalidClientToken	Invalid request parameter: {Reason}.
EbsBackup.Order.ProcFailed	Order processing failed: {Reason}.