すべてのプロダクト
Search

このプロダクト

    :DescribeBackupPlanList

    ドキュメントセンター

    :DescribeBackupPlanList

    最終更新日:Mar 19, 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

    任意

    DBS リージョン。 サポートされているリージョンを表示するには、DescribeRegions を呼び出します。

    cn-hangzhou
    PageSize

    integer

    任意

    1 ページあたりのレコード数。 有効値：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****

    レスポンスフィールド

    フィールド

    型

    説明

    例

    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：専用回線、VPN Gateway、または 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

    データベースを復元できる期間の終了タイムスタンプ。

    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

    バックアッププランの作成タイムスタンプ。

    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

    バックアップオブジェクト。

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

    integer

    データベースを復元できる期間の開始タイムスタンプ。

    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

    1764051253000
    SourceEndpointEnableSsl

    string

    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

    TESTGATEWAY
    EnableMysqlPhysicalBackupBinLog

    boolean

    例

    成功レスポンス

    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

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

    変更履歴

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