DescribeSandboxBackupSets - Data Management - Alibaba Cloud Documentation Center

Operation description

You must enable the sandbox feature for the database instance before you perform this operation. For more information, see Emergency recovery for an RDS for MySQL instance or Emergency recovery for a self-managed MySQL database (sandbox instance). This operation is supported only in DBS API version 2021-01-01.

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:DescribeSandboxBackupSets

get

*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 RDS for MySQL instance, automatically add the RDS instance to DBS to obtain the backup plan ID. For more information, see Automatically add a data source.	1hxxxx8xxxxxa
BackupSetId	string	No	The ID of the backup set. If you specify this parameter, the operation returns information about the snapshots of only this backup set. If you do not specify this parameter, the operation returns information about the snapshots of all backup sets that are created for the backup plan.	1xxxx2xxxxx1e
PageSize	string	No	The number of entries per page. Valid values: 30 (default) 50 100	30
PageNumber	string	No	The page number. The value must be greater than 0 and cannot exceed the maximum value of the integer data type. Default value: 1.	1

Response parameters

Parameter	Type	Description	Example
	object
Data	string	The data returned. The value of this parameter is a JSON string. The JSON string contains the following fields: backupSetTime: The point in time of the snapshot. The time is in the yyyy-MM-ddTHH:mm:ssZ format and is displayed in Coordinated Universal Time (UTC). backupSetId: The ID of the backup set. backupSetType: The type of the snapshot. Valid values: Full (full backup) and Inc (incremental backup). backupPlanId: The ID of the backup plan.	"Data": { "number": 2, "size": 2, "content": [ { "backupSetTime": "2021-08-28T23:12:31Z", "backupSetId": "Inc_1hxxxx8xxxxxa_20210801064200_mysql-bin.000134", "backupSetType": "Inc", "backupPlanId": "1hxxxx8xxxxxa" }, { "backupSetTime": "2021-08-28T22:42:28Z", "backupSetId": "1hxxxx8xxxxxa_20210829064228", "backupSetType": "FULL", "backupPlanId": "1hxxxx8xxxxxa" } ], "totalElements": 2 },
RequestId	string	The ID of the request.	4F1888AC-1138-4995-B9FE-D2734F61C058
ErrCode	string	The error code.	Param.NotFound
Success	string	Indicates whether the request was 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": "  \"Data\": {     \"number\": 2,     \"size\": 2,     \"content\": [       {         \"backupSetTime\": \"2021-08-28T23:12:31Z\",         \"backupSetId\": \"Inc_1hxxxx8xxxxxa_20210801064200_mysql-bin.000134\",         \"backupSetType\": \"Inc\",         \"backupPlanId\": \"1hxxxx8xxxxxa\"       },       {         \"backupSetTime\": \"2021-08-28T22:42:28Z\",         \"backupSetId\": \"1hxxxx8xxxxxa_20210829064228\",         \"backupSetType\": \"FULL\",         \"backupPlanId\": \"1hxxxx8xxxxxa\"       }     ],     \"totalElements\": 2   },",
  "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.