すべてのプロダクト
Search

このプロダクト

    Data Management:DescribeBackupPlanList

    ドキュメントセンター

    Data Management:DescribeBackupPlanList

    最終更新日:Apr 24, 2026

    DBS のバックアッププランを照会します。

    操作説明

    この操作を使用する前に、Object Storage Service (OSS) が有効になっていることを確認してください。 詳細については、「Object Storage Service」をご参照ください。

    今すぐお試しください

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

    get

    *BackupPlan

    acs:dbs:{#regionId}:{#accountId}:backupplan/{#BackupPlanId}

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    BackupPlanId

    string

    任意

    バックアッププランの ID。複数のバックアッププラン ID をコンマ (,) で区切って指定できます。

    dbstooi01exXXXX
    Region

    string

    任意

    バックアッププランが配置されているリージョンの ID。 DescribeRegions 操作を呼び出して、サポートされているリージョンのリストを照会できます。

    cn-hangzhou
    PageSize

    integer

    任意

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

    説明

    デフォルト値は 30 です。

    30
    PageNum

    integer

    任意

    返すページ番号。値は 0 以上の整数である必要があります。デフォルト値は 0 です。

    1
    BackupPlanName

    string

    任意

    バックアッププランの名前。

    test123
    BackupPlanStatus

    string

    任意

    バックアッププランのステータス。有効な値：

    • wait：バックアッププランが設定されていません。

    • init：事前チェックに失敗したため、バックアッププランは開始されていません。

    • running：バックアッププランは実行中です。

    • stop：バックアッププランは失敗しました。

    • pause：バックアッププランは一時停止しています。

    • locked：バックアッププランはロックされています。

    • check_pass：事前チェックに合格しました。

    wait
    ClientToken

    string

    任意

    リクエストのべき等性を保証するためにクライアントが生成したトークン。

    ASDASDASDSADASFCZXVZ
    ResourceGroupId

    string

    任意

    リソースグループの ID。

    rg-aekzecovzti****
    ShowStorageStrategyInfo

    boolean

    任意

    ストレージ戦略に関する情報を返すかどうかを指定します。デフォルト値：false。

    false
    ShowBackupStrategyInfo

    boolean

    任意

    バックアップ戦略に関する情報を返すかどうかを指定します。デフォルト値：false。

    false
    ShowRecoverTimeRange

    boolean

    任意

    リカバリ時間範囲を返すかどうかを指定します。デフォルト値：false。

    false
    BackupMethod

    string

    任意

    バックアップ方法。

    logical

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

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

    HttpStatusCode

    integer

    HTTP ステータスコード。

    200
    PageNum

    integer

    ページ番号。

    1
    RequestId

    string

    リクエスト ID。

    4F1888AC-1138-4995-B9FE-D2734F61C058
    ErrCode

    string

    エラーコード。

    InvalidParameterValid
    Success

    boolean

    リクエストが成功したかどうかを示します。

    true
    ErrMessage

    string

    エラーメッセージ。

    The specified parameter %s value is not valid.

    TotalPages

    integer

    総ページ数。

    4
    TotalElements

    integer

    バックアッププランの総数。

    100
    PageSize

    integer

    1ページあたりのエントリ数。

    30
    Items

    object

    レスポンス項目。

    BackupPlanDetail

    array<object>

    バックアッププランのリスト。

    object

    バックアッププランの詳細。

    CrossRoleName

    string

    クロスアカウントバックアップ用の RAM ロールの名前。

    test123
    SourceEndpointInstanceType

    string

    ソースエンドポイントのタイプ。有効な値：

    • rds

    • ecs

    • express：Express Connect 回線、VPN ゲートウェイ、または Smart Access Gateway インスタンス経由で接続されたデータベース。

    • agent：バックアップゲートウェイによって接続されたデータベース。

    • dds：ApsaraDB for MongoDB インスタンス。

    • other：IP アドレスとポート番号で接続されたデータベース。

    rds
    BackupSetDownloadDir

    string

    ダウンロードしたバックアップセットのサーバーディレクトリ。

    */test/test123
    SourceEndpointIpPort

    string

    ソースデータベースのエンドポイント。

    100.*.*.10:33204
    CrossAliyunId

    string

    クロスアカウントバックアップのユーザー ID。

    2xxx7778xxxxxxxxxx
    DuplicationArchivePeriod

    integer

    複製バックアップがアーカイブストレージに変換されるまでの日数。

    365
    BackupPlanId

    string

    バックアッププランの ID。

    dbstooi01eXXXX
    EndTimestampForRestore

    integer

    リストア可能な期間の終了時刻。この値はミリ秒単位の UNIX タイムスタンプです。

    1554560477000
    BackupPlanStatus

    string

    バックアッププランのステータス。有効な値：

    • wait：プランが設定されていません。

    • init：事前チェックに失敗したため、プランは開始されていません。

    • running：プランは実行中です。

    • stop：プランは失敗しました。

    • pause：プランは一時停止しています。

    • locked：プランはロックされています。

    • check_pass：事前チェックに合格しました。

    init
    BackupSetDownloadFullDataFormat

    string

    完全バックアップセットをダウンロードするためのデータ形式。有効な値：

    • Native

    • SQL

    • CSV

    • JSON

    SQL
    BackupRetentionPeriod

    integer

    バックアップ保持期間 (日数)。有効値：0～1825。

    365
    OSSBucketRegion

    string

    OSS バケットのリージョン。

    cn-hangzhou
    SourceEndpointOracleSID

    string

    Oracle システム ID (SID)。

    test
    BackupStorageType

    string

    バックアップデータのストレージタイプ。有効な値：

    • 空の文字列 (デフォルト)：バックアップデータはご利用の OSS バケットに保存されます。

    • system：バックアップデータは DBS の組み込み OSS バケットに保存されます。

    system
    BackupMethod

    string

    バックアップ方法。有効な値：

    • logical：論理バックアップ

    • physical：物理バックアップ

    • duplication：複製バックアップ

    logical
    SourceEndpointRegion

    string

    ソースデータベースのリージョン。

    cn-hangzhou
    BackupPeriod

    string

    完全バックアップの曜日。有効な値：

    • Monday

    • Tuesday

    • Wednesday

    • Thursday

    • Friday

    • Saturday

    • Sunday

    Monday
    SourceEndpointDatabaseName

    string

    ソースデータベースの名前。

    test
    BackupSetDownloadGatewayId

    integer

    バックアップセットのダウンロードに使用されるバックアップゲートウェイの ID。

    123123
    BackupPlanCreateTime

    integer

    バックアッププランの作成時刻。この値はミリ秒単位の UNIX タイムスタンプです。

    1582527713000
    InstanceClass

    string

    インスタンスクラス。有効な値：

    • micro：エントリレベル

    • small：低スペック

    • medium：中スペック

    • large：高スペック

    • xlarge：高スペック (トラフィック制限なし)

    micro
    BackupSetDownloadTargetType

    string

    バックアップセットダウンロードのターゲットタイプ。

    説明

    唯一の有効な値は agent で、バックアップゲートウェイがインストールされていることを示します。

    agent
    DuplicationInfrequentAccessPeriod

    integer

    バックアップデータが低頻度アクセスストレージに変換されるまでの日数。

    180
    BackupStartTime

    string

    完全バックアップの開始時刻。時刻は HH:mm 形式です。

    14:22
    ErrMessage

    string

    事前チェックタスクによって返されたエラーメッセージ。

    can not connect to oracle instance orcl with user dbs
    BackupObjects

    string

    バックアップオブジェクト。JSON 文字列で指定されます。

    [ { \"DBName\":\"待备份库名\", \"SchemaName\":\"待备份 Schema 名\", \"TableIncludes\":[{ \"TableName\":\"待备份表表名\" }], \"TableExcludes\":[{ \"TableName\":\"待备份库名不需要备份表的表名\" }] } ]
    BeginTimestampForRestore

    integer

    リストア可能な期間の開始時刻。この値はミリ秒単位の UNIX タイムスタンプです。

    1554560477000
    SourceEndpointInstanceID

    string

    ソースデータベースインスタンスの ID。

    test
    OpenBackupSetAutoDownload

    boolean

    バックアップセットの自動ダウンロードが有効になっているかどうかを示します。

    true
    BackupPlanName

    string

    バックアッププランの名前。

    dbstooi01e****
    OSSBucketName

    string

    OSS バケットの名前。

    dbs-backup-1857XXXXX489
    BackupGatewayId

    integer

    バックアップゲートウェイの ID。

    827362187368736
    SourceEndpointUserName

    string

    ソースデータベースアカウントのユーザー名。

    test
    BackupSetDownloadIncrementDataFormat

    string

    増分バックアップセットをダウンロードするためのデータ形式。有効な値：

    • Native

    • SQL

    • CSV

    • JSON

    SQL
    EnableBackupLog

    boolean

    ログバックアップが有効になっているかどうかを示します。有効な値：

    • true：有効

    • false：無効

    true
    ResourceGroupId

    string

    リソースグループの ID。

    rg-aekzecovzti****
    DatabaseType

    string

    ソースデータベースのタイプ。

    MySQL
    BackupPlanRegion

    string

    バックアッププランのリージョン。

    cn-beijing
    SourceEndpointHost

    string

    ソースエンドポイントアドレス。

    127.0.0.1
    InstanceChargeType

    string

    バックアッププランインスタンスの課金方法。

    PREPAY
    InstanceExpiredTimestamp

    integer

    バックアッププランインスタンスの有効期限。この値はミリ秒単位の UNIX タイムスタンプです。

    1764051253000
    SourceEndpointEnableSsl

    string

    ソースデータベースで SSL 暗号化が有効になっているかどうかを示します。

    true
    StorageEncryptMethod

    string

    バックアップストレージの暗号化方式。

    encrypted
    SourceEndpointPort

    string

    ソースデータベースのポート番号。

    3306
    IncrementBackupRetentionPeriod

    string

    増分バックアップの保持期間 (日数)。

    365
    IncrementDuplicationInfrequentAccessPeriod

    string

    増分バックアップが低頻度アクセスストレージに変換されるまでの日数。

    365
    IncrementDuplicationArchivePeriod

    string

    増分バックアップがアーカイブストレージに変換されるまでの日数。

    365
    LogBackupRetentionPeriod

    string

    ログバックアップの保持期間 (日数)。

    365
    LogDuplicationInfrequentAccessPeriod

    string

    ログバックアップが低頻度アクセスストレージに変換されるまでの日数。

    365
    LogDuplicationArchivePeriod

    string

    ログバックアップがアーカイブストレージに変換されるまでの日数。

    365
    BackupGatewayIdentifier

    string

    バックアップゲートウェイの一意の ID。

    TESTGATEWAY
    EnableMysqlPhysicalBackupBinLog

    boolean

    MySQL 物理バックアップでログバックアップが有効になっているかどうかを示します。

    false

    例

    成功レスポンス

    JSONJSON

    {
  "HttpStatusCode": 200,
  "PageNum": 1,
  "RequestId": "4F1888AC-1138-4995-B9FE-D2734F61C058",
  "ErrCode": "InvalidParameterValid",
  "Success": true,
  "ErrMessage": "The specified parameter %s value is not valid.     ",
  "TotalPages": 4,
  "TotalElements": 100,
  "PageSize": 30,
  "Items": {
    "BackupPlanDetail": [
      {
        "CrossRoleName": "test123",
        "SourceEndpointInstanceType": "rds",
        "BackupSetDownloadDir": "*/test/test123",
        "SourceEndpointIpPort": "100.*.*.10:33204",
        "CrossAliyunId": "2xxx7778xxxxxxxxxx",
        "DuplicationArchivePeriod": 365,
        "BackupPlanId": "dbstooi01eXXXX",
        "EndTimestampForRestore": 1554560477000,
        "BackupPlanStatus": "init",
        "BackupSetDownloadFullDataFormat": "SQL",
        "BackupRetentionPeriod": 365,
        "OSSBucketRegion": "cn-hangzhou",
        "SourceEndpointOracleSID": "test",
        "BackupStorageType": "system",
        "BackupMethod": "logical",
        "SourceEndpointRegion": "cn-hangzhou",
        "BackupPeriod": "Monday",
        "SourceEndpointDatabaseName": "test",
        "BackupSetDownloadGatewayId": 123123,
        "BackupPlanCreateTime": 1582527713000,
        "InstanceClass": "micro",
        "BackupSetDownloadTargetType": "agent",
        "DuplicationInfrequentAccessPeriod": 180,
        "BackupStartTime": "14:22",
        "ErrMessage": "  can not connect to oracle instance orcl with user dbs",
        "BackupObjects": "[     {         \\\"DBName\\\":\\\"待备份库名\\\",         \\\"SchemaName\\\":\\\"待备份 Schema 名\\\",         \\\"TableIncludes\\\":[{             \\\"TableName\\\":\\\"待备份表表名\\\"         }],         \\\"TableExcludes\\\":[{             \\\"TableName\\\":\\\"待备份库名不需要备份表的表名\\\"         }]     } ]",
        "BeginTimestampForRestore": 1554560477000,
        "SourceEndpointInstanceID": "test",
        "OpenBackupSetAutoDownload": true,
        "BackupPlanName": "dbstooi01e****",
        "OSSBucketName": "dbs-backup-1857XXXXX489",
        "BackupGatewayId": 827362187368736,
        "SourceEndpointUserName": "test",
        "BackupSetDownloadIncrementDataFormat": "SQL",
        "EnableBackupLog": true,
        "ResourceGroupId": "rg-aekzecovzti****",
        "DatabaseType": "MySQL",
        "BackupPlanRegion": "cn-beijing",
        "SourceEndpointHost": "127.0.0.1",
        "InstanceChargeType": "PREPAY",
        "InstanceExpiredTimestamp": 1764051253000,
        "SourceEndpointEnableSsl": "true",
        "StorageEncryptMethod": "encrypted",
        "SourceEndpointPort": "3306",
        "IncrementBackupRetentionPeriod": "365",
        "IncrementDuplicationInfrequentAccessPeriod": "365",
        "IncrementDuplicationArchivePeriod": "365",
        "LogBackupRetentionPeriod": "365",
        "LogDuplicationInfrequentAccessPeriod": "365",
        "LogDuplicationArchivePeriod": "365",
        "BackupGatewayIdentifier": "TESTGATEWAY",
        "EnableMysqlPhysicalBackupBinLog": false
      }
    ]
  }
}

    エラーコード

    HTTP ステータスコード

    エラーコード

    エラーメッセージ

    説明
    403 Request.Forbidden Have no Permissions

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

    変更履歴

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