すべてのプロダクト
Search

このプロダクト

    Data Management:DescribeSandboxInstances

    ドキュメントセンター

    Data Management:DescribeSandboxInstances

    最終更新日:Jan 19, 2026

    アカウント内に作成されたサンドボックスインスタンスを照会します。

    操作説明

    この操作は、2021-01-01 バージョンの Database Backup (DBS) API でのみ利用可能です。

    今すぐお試しください

    この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

    テスト

    RAM 認証

    下表に、この API を呼び出すために必要な認証情報を示します。認証情報は、RAM (Resource Access Management) ポリシーを使用して定義できます。以下で各列名について説明します。

    • アクション：特定のリソースに対して実行可能な操作。ポリシー構文ではAction要素として指定します。

    • API：アクションを具体的に実行するための API。

    • アクセスレベル：各 API に対して事前定義されているアクセスの種類。有効な値：create、list、get、update、delete。

    • リソースタイプ：アクションが作用するリソースの種類。リソースレベルでの権限をサポートするかどうかを示すことができます。ポリシーの有効性を確保するため、アクションの対象として適切なリソースを指定してください。

      • リソースレベルの権限を持つ API の場合、必要なリソースタイプはアスタリスク (*) でマークされます。ポリシーのResource要素で対応する ARN を指定してください。

      • リソースレベルの権限を持たない API の場合、「すべてのリソース」と表示され、ポリシーのResource要素でアスタリスク (*) でマークされます。

    • 条件キー：サービスによって定義された条件のキー。このキーにより、きめ細やかなアクセス制御が可能になります。この制御は、アクション単体に適用することも、特定のリソースに対するアクションに適用することもできます。Alibaba Cloud は、サービス固有の条件キーに加えて、すべての RAM 統合サービスに適用可能な一連の共通条件キーを提供しています。

    • 依存アクション：ある特定のアクションを実行するために、前提として実行が必要となる他のアクション。依存アクションの権限も RAM ユーザーまたは RAM ロールに付与する必要があります。

    アクション

    アクセスレベル

    リソースタイプ

    条件キー

    依存アクション

    dbs:DescribeSandboxInstances

    get

    *All Resource

    *

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    BackupPlanId

    string

    必須

    バックアップスケジュールの ID。 DescribeBackupPlanList 操作を呼び出して、バックアップスケジュールの ID を取得できます。

    説明

    ご利用のインスタンスが ApsaraDB RDS for MySQL インスタンスの場合は、データソースへの自動アクセスを設定して、インスタンスを自動的に DBS に追加し、バックアップスケジュールの ID を取得できます。

    1hxxxx8xxxxxa
    InstanceId

    string

    任意

    サンドボックスインスタンスの ID。 CreateSandboxInstance 操作を呼び出して、サンドボックスインスタンスの ID を取得できます。

    1jxxxxnxxx1xc
    PageSize

    string

    任意

    各ページに返すエントリ数。 有効値：

    • 30。 これはデフォルト値です。

    • 50

    • 100

    30
    PageNumber

    string

    任意

    返すページ番号。 値は 0 より大きい整数である必要があります。 デフォルト値：1。

    1

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    Data

    string

    レスポンスパラメーター。

    • connectionString：サンドボックスインスタンスの接続文字列。IP アドレス:ポート番号の形式です。 このパラメーターは、`SandboxType` パラメーターの値が Sandbox の場合はサンドボックスインスタンスのエンドポイントを示します。 このパラメーターは、`SandboxType` パラメーターの値が NFS の場合はネットワークファイルシステム (NFS) のマウントアドレスを示します。

    • restoreSeconds：サンドボックスインスタンスの作成にかかる時間。 単位：秒。

    • restoreTime：サンドボックスインスタンスが復元される特定時点。 時刻は、yyyy-MM-ddThh:mm:ssZ 形式の ISO 8601 規格に準拠しています。 時刻は UTC で表示されます。

    • instanceId：サンドボックスインスタンスの ID。

    • backupSetId：バックアップセットの ID。

    • createTime：サンドボックスインスタンスが作成された特定時点。 時刻は、yyyy-MM-ddThh:mm:ssZ 形式の ISO 8601 規格に準拠しています。 時刻は UTC で表示されます。

    • backupPlanId：バックアップスケジュールの ID。

    • vpcId：Virtual Private Cloud (VPC) の ID。

    • vpcSwitchId：VSwitch の 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.

    例

    成功レスポンス

    JSONJSON

    {
  "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 ステータスコード

    エラーコード

    エラーメッセージ

    説明
    403 Request.Forbidden Have no Permissions

    完全なリストについては、「エラーコード」をご参照ください。

    変更履歴

    完全なリストについては、「変更履歴」をご参照ください。