すべてのプロダクト
Search

このプロダクト

    :DescribeBackupPlanList

    ドキュメントセンター

    :DescribeBackupPlanList

    最終更新日:Dec 01, 2025

    1 つ以上の 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～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

    各ページのエントリ数。

    30
    Items

    object

    BackupPlanDetail

    array<object>

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

    object

    戻り値。

    CrossRoleName

    string

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

    test123
    SourceEndpointInstanceType

    string

    データベースの場所。 有効値：

    • rds

    • ecs

    • express：専用回線、VPN Gateway、または Smart Access Gateway を介して接続されたデータベース。

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

    • dds：MongoDB インスタンス。

    • other：IP アドレスとポート番号を使用してインターネット経由で接続されたデータベース。

    rds
    BackupSetDownloadDir

    string

    バックアップセットがダウンロードされるサーバー上のディレクトリ。

    */test/test123
    SourceEndpointIpPort

    string

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

    100.*.*.10:33204
    CrossAliyunId

    string

    クロスアカウントバックアップ用の Alibaba Cloud アカウントの UID。

    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

    バックアッププランが作成されたときのタイムスタンプ。

    1582527713000
    InstanceClass

    string

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

    • micro：マイクロ

    • small：スモール

    • medium：ミディアム

    • large：ラージ

    • xlarge：エクストララージ (トラフィック制限なし)

    micro
    BackupSetDownloadTargetType

    string

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

    説明

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

    agent
    DuplicationInfrequentAccessPeriod

    integer

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

    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

    データベースを復元できる期間の開始時刻。 これは 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

    バックアップセット内の完全データのダウンロードフォーマット：

    • ネイティブ

    • SQL

    • CSV

    • JSON

    SQL
    EnableBackupLog

    boolean

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

    • true：有効

    • false：無効

    true
    ResourceGroupId

    string

    リソースグループ ID。

    rg-aekzecovzti****
    DatabaseType

    string

    データベースタイプ。

    MySQL

    例

    成功レスポンス

    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"
      }
    ]
  }
}

    エラーコード

    HTTP ステータスコード

    エラーコード

    エラーメッセージ

    説明
    403 Request.Forbidden Have no Permissions

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

    変更履歴

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