DeleteSandboxInstance - Data Management - Alibaba Cloud Documentation Center

Operation description

This operation is only available for the 2021-01-01 version of the DBS API.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

dbs:DeleteSandboxInstance

delete

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
BackupPlanId	string	Yes	The ID of the backup plan. Note If your instance is an ApsaraDB RDS for MySQL instance, use the auto-add data source feature to add the RDS instance to DBS and obtain the backup plan ID.	1hxxxx8xxxxxa
InstanceId	string	Yes	The ID of the sandbox instance.	1jxxxxnxxx1xc
ZoneId	string	No	The zone ID of the destination sandbox instance. The zone must be supported by PrivateLink. Call the DescribeZones operation to query the list of zones in a specific region. Note Before using the sandbox feature, enable PrivateLink. Call the OpenPrivateLinkService operation to enable PrivateLink.	cn-hangzhou-b

Response elements

Element	Type	Description	Example
	object
Data	string	The error message.	operation forbidden due to sandbox is creating.
RequestId	string	The request ID.	4F1888AC-1138-4995-B9FE-D2734F61C058
ErrCode	string	The error code.	Param.NotFound
Success	string	Indicates whether the request is successful.	true
ErrMessage	string	The error message.	The specified parameter %s value is not valid.
Code	string	The error code.	Param.NotFound
Message	string	The error message.	The specified parameter %s value is not valid.

Examples

Success response

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

HTTP status code	Error code	Error message	Description
403	Request.Forbidden	Have no Permissions

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.