Restore an instance from a backup
Operation description
This is an asynchronous API. The instance does not restart immediately. After you call this API successfully, the instance enters the restarting state. When the instance status changes to running, the restore is complete.
Try it now
Test
RAM authorization
Request syntax
POST /webapi/restore/restoreInstance HTTP/1.1Request parameters
|
Parameter |
Type |
Required |
Description |
Example |
| body |
object |
No |
Request struct. |
|
| AdminPassword |
string |
No |
Cluster administrator password. |
password_example |
| AutoRenew |
boolean |
No |
Enable auto-renewal. This parameter applies only when PayType is prePaid. Default: false. |
true |
| RegionId |
string |
No |
Region ID. |
cn-hangzhou |
| PayType |
string |
No |
Payment type: prePaid for subscription postPaid for pay-as-you-go |
prePaid |
| VpcId |
string |
No |
VPC ID. |
vpc-bp1fll2mci6d7pw8m**** |
| PricingCycle |
string |
No |
Billing cycle unit. This parameter applies only when PayType is prePaid. Month for monthly billing Year for yearly billing |
Month |
| VSwitches |
array<object> |
No |
VSwitch and zone information. |
|
|
object |
No |
VSwitch information. |
||
| ZoneId |
string |
No |
Zone ID of the VSwitch. |
cn-hangzhou-i |
| VswId |
string |
No |
VSwitch ID. |
vsw-bp19mlh98tm9teyyd**** |
| Duration |
integer |
No |
Subscription duration. This parameter applies only when PayType is prePaid. |
1 |
| BackupTaskId |
string |
No |
Backup job ID. |
bk-adskj23hd9s |
| InstanceName |
string |
No |
Instance name. |
c1 |
| ResourceGroupId |
string |
No |
Resource group ID. |
rg-aekzllkih7jqxxx |
| Tags |
array<object> |
No |
Tag struct. |
|
|
object |
No |
Tag struct. |
||
| key |
string |
No |
Tag key. |
dukang-chengdu-sgueg |
| value |
string |
No |
Tag value. |
{'reasons': [], 'patterns': [], 'aggregates': [], 'event_statistic': {'statistic': {}}} |
Response elements
|
Element |
Type |
Description |
Example |
|
object |
|||
| HttpStatusCode |
integer |
HTTP status code. |
200 |
| RequestId |
string |
Request ID. |
32A44F0D-BFF6-5664-999A-218BBDE74XXX |
| Success |
boolean |
Indicates whether the request succeeded. |
true |
| ErrCode |
string |
Error code. |
InvalidParams |
| ErrMessage |
string |
Error message. |
null |
| Data |
object |
Response data. |
|
| OrderId |
integer |
Order ID. |
241526000650XXX |
| InstanceId |
string |
Instance ID. |
c-b25e21e243889XXX |
| AccessDeniedDetail |
string |
AccessDeniedDetail |
{ "PolicyType": "AccountLevelIdentityBasedPolicy", "AuthPrincipalOwnerId": "xxx", "EncodedDiagnosticMessage": "xxx", "AuthPrincipalType": "xxx", "AuthPrincipalDisplayName": "xxx", "NoPermissionType": "ImplicitDeny", "AuthAction": "sr:xxx" } |
Examples
Success response
JSON format
{
"HttpStatusCode": 200,
"RequestId": "32A44F0D-BFF6-5664-999A-218BBDE74XXX\n",
"Success": true,
"ErrCode": "InvalidParams\n",
"ErrMessage": "null",
"Data": {
"OrderId": 0,
"InstanceId": "c-b25e21e243889XXX"
},
"AccessDeniedDetail": "{ \"PolicyType\": \"AccountLevelIdentityBasedPolicy\", \"AuthPrincipalOwnerId\": \"xxx\", \"EncodedDiagnosticMessage\": \"xxx\", \"AuthPrincipalType\": \"xxx\", \"AuthPrincipalDisplayName\": \"xxx\", \"NoPermissionType\": \"ImplicitDeny\", \"AuthAction\": \"sr:xxx\" }"
}Error codes
See Error Codes for a complete list.
Release notes
See Release Notes for a complete list.