すべてのプロダクト
Search

このプロダクト

    Data Management:DescribeSandboxBackupSets

    ドキュメントセンター

    Data Management:DescribeSandboxBackupSets

    最終更新日:Jan 19, 2026

    サンドボックスバックアップセットを照会します。

    操作説明

    この操作を実行する前に、データベースインスタンスのサンドボックス機能を有効にする必要があります。 詳細については、「RDS for MySQL インスタンスの緊急時リカバリ」または「自己管理 MySQL データベース（サンドボックスインスタンス）の緊急時リカバリ」をご参照ください。 この操作は、DBS API バージョン 2021-01-01 でのみサポートされています。

    今すぐお試しください

    この 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:DescribeSandboxBackupSets

    get

    *All Resource

    *

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    BackupPlanId

    string

    必須

    バックアッププラン ID。

    説明

    インスタンスが RDS for MySQL インスタンスの場合は、RDS インスタンスを DBS に自動的に追加して、バックアッププラン ID を取得します。 詳細については、「データソースを自動的に追加する」をご参照ください。

    1hxxxx8xxxxxa
    BackupSetId

    string

    任意

    バックアップセット ID。 このパラメータを指定すると、この操作は、このバックアップセットのスナップショットに関する情報のみを返します。 このパラメータを指定しない場合、この操作は、バックアッププランに対して作成されたすべてのバックアップセットのスナップショットに関する情報を返します。

    1xxxx2xxxxx1e
    PageSize

    string

    任意

    1 ページあたりのエントリ数。 有効な値：

    • 30 (デフォルト)

    • 50

    • 100

    30
    PageNumber

    string

    任意

    ページ番号。 値は 0 より大きく、整数データ型の最大値を超えることはできません。 デフォルト値：1。

    1

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    Data

    string

    返されるデータ。 このパラメータの値は JSON 文字列です。 JSON 文字列には、次のフィールドが含まれています。

    • backupSetTime: スナップショットの時点。 時刻は yyyy-MM-ddTHH:mm:ssZ 形式で、協定世界時 (UTC) で表示されます。

    • backupSetId: バックアップセット ID。

    • backupSetType: スナップショットのタイプ。 有効な値：Full (完全バックアップ) および Inc (増分バックアップ)。

    • backupPlanId: バックアッププラン ID。

    "Data": { "number": 2, "size": 2, "content": [ { "backupSetTime": "2021-08-28T23:12:31Z", "backupSetId": "Inc_1hxxxx8xxxxxa_20210801064200_mysql-bin.000134", "backupSetType": "Inc", "backupPlanId": "1hxxxx8xxxxxa" }, { "backupSetTime": "2021-08-28T22:42:28Z", "backupSetId": "1hxxxx8xxxxxa_20210829064228", "backupSetType": "FULL", "backupPlanId": "1hxxxx8xxxxxa" } ], "totalElements": 2 },
    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": "  \"Data\": {     \"number\": 2,     \"size\": 2,     \"content\": [       {         \"backupSetTime\": \"2021-08-28T23:12:31Z\",         \"backupSetId\": \"Inc_1hxxxx8xxxxxa_20210801064200_mysql-bin.000134\",         \"backupSetType\": \"Inc\",         \"backupPlanId\": \"1hxxxx8xxxxxa\"       },       {         \"backupSetTime\": \"2021-08-28T22:42:28Z\",         \"backupSetId\": \"1hxxxx8xxxxxa_20210829064228\",         \"backupSetType\": \"FULL\",         \"backupPlanId\": \"1hxxxx8xxxxxa\"       }     ],     \"totalElements\": 2   },",
  "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

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

    変更履歴

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