All Products
Search

This Product

    Data Management:DescribeSandboxInstances

    Document Center

    Data Management:DescribeSandboxInstances

    Last Updated:Jan 19, 2026

    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.

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

    get

    *All Resource

    *

    		 None 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. This is the default value.

    • 50

    • 100

    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 elements

    Element

    Type

    Description

    Example

    object

    Data

    string

    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 }
    RequestId

    string

    The ID of the request.

    4F1888AC-1138-4995-B9FE-D2734F61C058
    ErrCode

    string

    The error code returned if the request fails.

    Param.NotFound
    Success

    string

    Indicates whether the request was successful.

    true
    ErrMessage

    string

    The error message returned if the request fails.

    The specified parameter %s value is not valid.
    Code

    string

    The error code returned if the request fails.

    Param.NotFound
    Message

    string

    The error message returned if the request fails.

    The specified parameter %s value is not valid.

    Examples

    Success response

    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

    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.