全部產品
Search

搜尋本產品

    Data Management：DescribeSandboxInstances - 查看沙箱執行個體列表

    文件中心

    Data Management：DescribeSandboxInstances - 查看沙箱執行個體列表

    更新時間：Apr 21, 2026

    查看當前帳號下的沙箱執行個體列表。

    介面說明

    當前介面僅支援 DBS API 服務 2021-01-01 版本。

    調試

    您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

    調試

    授權資訊

    下表是API對應的授權資訊，可以在RAM權限原則語句的Action元素中使用，用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下：

    • 操作：是指具體的許可權點。

    • 存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。

    • 資源類型：是指操作中支援授權的資源類型。具體說明如下：

      • 對於必選的資源類型，用前面加 * 表示。

      • 對於不支援資源級授權的操作，用全部資源表示。

    • 條件關鍵字：是指雲產品自身定義的條件關鍵字。

    • 關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

    操作

    存取層級

    資源類型

    條件關鍵字

    關聯操作

    dbs:DescribeSandboxInstances

    get

    *全部資源

    *

    		 無 無

    請求參數

    名稱

    類型

    必填

    描述

    樣本值
    BackupPlanId

    string

    是

    備份計劃 ID，您可以通過 DescribeBackupPlanList 介面擷取該參數。

    說明

    若您的執行個體為 RDS MySQL，請通過自動添加資料來源功能，將 RDS 自動添加至 DBS 中，即可擷取備份計劃 ID。

    1hxxxx8xxxxxa
    InstanceId

    string

    否

    沙箱執行個體 ID，您可以通過 CreateSandboxInstance 介面擷取該參數。

    1jxxxxnxxx1xc
    PageSize

    string

    否

    每頁的記錄數。取值：

    • 30（預設）

    • 50

    • 100

    30
    PageNumber

    string

    否

    頁碼，大於 0 且不超過 Integer 的最大值，預設值為 1。

    1

    返回參數

    名稱

    類型

    描述

    樣本值

    object

    Data

    string

    參數說明：

    • connectionString：沙箱執行個體的連接字串，格式為 IP:Port。當 SandboxType 為 Sandbox 時，該參數表示沙箱執行個體的串連地址；當 SandboxType 為 NFS 時，該參數表示 NFS 掛載地址。

    • restoreSeconds：建立沙箱執行個體所需的時間長度，單位為秒。

    • restoreTime：恢複的時間點，格式為 yyyy-MM-ddTHH:mm:ssZ（UTC 時間）。

    • instanceId：沙箱執行個體 ID。

    • backupSetId：備份組 ID。

    • createTime：沙箱執行個體的建立時間，格式為 yyyy-MM-ddTHH:mm:ssZ（UTC 時間）。

    • backupPlanId：備份計劃 ID。

    • vpcId：Virtual Private Cloud（Virtual Private Cloud） ID。

    • vpcSwitchId：VPC 交換器 ID。

    • sandboxSpecification：沙箱執行個體規格。

    • status：沙箱執行個體狀態，運行中（running）、預檢查通過（check_pass）、異常（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

    請求 ID。

    4F1888AC-1138-4995-B9FE-D2734F61C058
    ErrCode

    string

    錯誤碼。

    Param.NotFound
    Success

    string

    是否請求成功。

    true
    ErrMessage

    string

    錯誤資訊。

    The specified parameter %s value is not valid.
    Code

    string

    錯誤碼。

    Param.NotFound
    Message

    string

    錯誤資訊。

    The specified parameter %s value is not valid.

    樣本

    正常返回樣本

    JSON格式

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

    錯誤碼

    HTTP status code

    錯誤碼

    錯誤資訊

    描述
    403 Request.Forbidden Have no Permissions 當前操作未被授權，請聯絡主帳號在RAM控制台進行授權後再執行操作

    訪問錯誤中心查看更多錯誤碼。

    變更歷史

    更多資訊，參考變更詳情。