All Products
Search
Document Center

Database Backup:DescribeSandboxInstances

Last Updated:Apr 04, 2023

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.

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.
OperationAccess levelResource typeCondition keyAssociation operation
dbs:DescribeSandboxInstancesRead
    All Resources
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
BackupPlanIdstringYes

The ID of the backup schedule. You can call the DescribeBackupPlanList operation to obtain the ID of the backup schedule.

NoteIf 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
InstanceIdstringNo

The ID of the sandbox instance. You can call the CreateSandboxInstance operation to obtain the ID of the sandbox instance.

1jxxxxnxxx1xc
PageSizestringNo

The number of entries to return on each page. Valid values:

  • 30. This is the default value.
  • 50
  • 100
30
PageNumberstringNo

The number of the page to return. The value must be an integer that is greater than 0. Default value: 1.

1

Response parameters

ParameterTypeDescriptionExample
object
Datastring

The response parameters.

  • connectionString: the connection string of the sandbox instance, in the format of IP address:Port number. This parameter indicates the endpoint of the sandbox instance if the value of the SandboxType parameter is Sandbox. This parameter indicates the Network File System (NFS) mount address if the value of the SandboxType parameter is NFS.
  • restoreSeconds: the time required to create the sandbox instance. Unit: seconds.
  • restoreTime: the point in time to which the sandbox instance is restored. The time follows the ISO 8601 standard in the yyyy-MM-ddThh:mm:ssZ format. The time is displayed in UTC.
  • instanceId: the ID of the sandbox instance.
  • backupSetId: the ID of the backup set.
  • createTime: the point in time when the sandbox instance was created. The time follows the ISO 8601 standard in the yyyy-MM-ddThh:mm:ssZ format. The time is displayed in UTC.
  • backupPlanId: the ID of the backup schedule.
  • vpcId: the ID of the virtual private cloud (VPC).
  • vpcSwitchId: the ID of the VSwitch.
  • sandboxSpecification: the specifications of the sandbox instance.
  • status: the status of the sandbox instance. Valid values: running, check_pass, and stop.
{ "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 }
RequestIdstring

The ID of the request.

4F1888AC-1138-4995-B9FE-D2734F61C058
ErrCodestring

The error code returned if the request fails.

Param.NotFound
Successstring

Indicates whether the request was successful.

true
ErrMessagestring

The error message returned if the request fails.

The specified parameter %s value is not valid.
Codestring

The error code returned if the request fails.

Param.NotFound
Messagestring

The error message returned if the request fails.

The specified parameter %s value is not valid.

Examples

Sample success responses

JSONformat

{
  "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.

Error codeError messageDescription
DBS.NotExistedno valid job exist with idThe error message returned because no backup schedule exists for the instance specified by the InstanceId parameter.