Releases a sandbox instance.
Operation description
This operation is available only for the Database Backup (DBS) API of the 2021-01-01 version.
Debugging
Authorization information
There is currently no authorization information disclosed in the API.
Request parameters
Parameter | Type | Required | Description | Example |
---|---|---|---|---|
BackupPlanId | string | Yes | The ID of the backup schedule. You can call the DescribeBackupPlanList operation to query the ID of the backup schedule. Note
If your instance is an ApsaraDB RDS for MySQL instance, you can configure automatic access to a data source to automatically add the instance to DBS and obtain the ID of the backup schedule.
| 1hxxxx8xxxxxa |
InstanceId | string | Yes | The ID of the sandbox instance. You can call the DescribeSandboxInstances operation to query the ID of the sandbox instance. | 1jxxxxnxxx1xc |
Response parameters
Examples
Sample success responses
JSON
format
{
"Data": "operation forbidden due to sandbox is creating.",
"RequestId": "4F1888AC-1138-4995-B9FE-D2734F61C058",
"ErrCode": "Param.NotFound",
"Success": "true",
"ErrMessage": "The specified parameter %s value is not valid.",
"Code": "Param.NotFound",
"Message": "The specified parameter %s value is not valid."
}
Error codes
For a list of error codes, visit the Service error codes.
Change history
Change time | Summary of changes | Operation | ||||
---|---|---|---|---|---|---|
2023-08-18 | The request parameters of the API has changed | see changesets | ||||
|
Error code | Error message | Description |
---|---|---|
Operation.DeniedByJobStatus | operation forbidden due to sandbox is creating | The error message returned because the sandbox instance is being created and cannot be released. Release the sandbox instance when it is running. |