Queries sandbox instances that are created within an account.
Operation description
This operation is available only in Database Backup (DBS) API of the 2021-01-01 version.
Debugging
Authorization information
The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action
policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:
- Operation: the value that you can use in the Action element to specify the operation on a resource.
- Access level: the access level of each operation. The levels are read, write, and list.
- Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level,
All Resources
is used in the Resource type column of the operation.
- Condition Key: the condition key that is defined by the cloud service.
- Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
Operation | Access level | Resource type | Condition key | Associated operation |
---|---|---|---|---|
dbs:DescribeSandboxInstances | Read |
|
| none |
Request parameters
Parameter | Type | Required | Description | Example |
---|---|---|---|---|
BackupPlanId | string | Yes | The ID of the backup schedule. You can call the DescribeBackupPlanList operation to obtain 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 | No | The ID of the sandbox instance. You can call the CreateSandboxInstance operation to obtain the ID of the sandbox instance. | 1jxxxxnxxx1xc |
PageSize | string | No | The number of entries to return on each page. Valid values:
| 30 |
PageNumber | string | No | The number of the page to return. The value must be an integer that is greater than 0. Default value: 1. | 1 |
Response parameters
Examples
Sample success responses
JSON
format
{
"Data": " { \"number\": 1, \"size\": 1, \"content\": [ { \"connectionString\": \"172.26.178.229:3306\", \"restoreSeconds\": 15, \"restoreTime\": \"2021-08-11T07:26:24Z\", \"instanceId\": \"1jxxxxx9xxxms\", \"backupSetId\": \"1hxxxx8xxxxxa_20210811152624\", \"createTime\": \"2021-08-12T07:40:29Z\", \"backupPlanId\": \"1hxxxx8xxxxxa\", \"vpcId\": \"vpc-bp1dxxxxxjy0xxxxx1xxp\", \"sandboxSpecification\": \"MYSQL_1C_1M_SD\", \"status\": \"running\", \"vpcSwitchId\": \"vsw-bp1bxxxxxumxxxxxwxx2w\" } ], \"totalElements\": 1 }",
"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 |
---|
Error code | Error message | Description |
---|---|---|
DBS.NotExisted | no valid job exist with id | The error message returned because no backup schedule exists for the instance specified by the InstanceId parameter. |