すべてのプロダクト
Search

このプロダクト

    :DescribeBackupPlans

    ドキュメントセンター

    :DescribeBackupPlans

    最終更新日:Nov 17, 2025

    指定された条件を満たす 1 つ以上のバックアッププランを取得します。

    今すぐお試しください

    この 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 ロールに付与する必要があります。

    アクション

    アクセスレベル

    リソースタイプ

    条件キー

    依存アクション

    hbr:DescribeBackupPlans

    get

    *All Resource

    *

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    PageNumber

    integer

    任意

    ページ番号。ページは 1 から始まります。デフォルト値: 1。

    1
    PageSize

    integer

    任意

    1 ページあたりのエントリ数。有効な値: 1～99。デフォルト値: 10。

    10
    SourceType

    string

    任意

    データソースのタイプ。有効な値:

    • ECS_FILE: Elastic Compute Service (ECS) インスタンスのファイル。

    • OSS: Object Storage Service (OSS) のオブジェクト。

    • NAS: Apsara File Storage NAS (NAS) のファイルシステム。

    • OTS: Tablestore インスタンス。

    • UDM_ECS: ECS インスタンス全体。

    • SYNC: データ同期。

    ECS_FILE
    Filters

    array<object>

    任意

    フィルター。

    object

    任意

    Key

    string

    任意

    フィルターのキー。有効な値:

    • regionId: リージョン ID。

    • planId: バックアッププランの ID。

    • sourceType: バックアップソースのタイプ。

    • vaultId: バックアップボールトの ID。

    • instanceName: インスタンスの名前。

    • instanceId: インスタンスの ID。

    • planName: バックアッププランの名前。

    vaultId
    Values

    array

    任意

    フィルターで照合する値。

    ["v-*********************"]

    string

    任意

    フィルターで照合する値。

    v-*********************
    Edition

    string

    任意

    バックアッププランのエディション。有効な値: BASIC および STANDARD。デフォルト値: STANDARD。

    STANDARD

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    RequestId

    string

    リクエスト ID。

    473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
    Success

    boolean

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

    • true: リクエストは成功しました。

    • false: リクエストは失敗しました。

    true
    Code

    string

    リターンコード。値が 200 の場合は、リクエストが成功したことを示します。

    200
    Message

    string

    返されたメッセージ。リクエストが成功した場合、「successful」が返されます。リクエストが失敗した場合、エラーメッセージが返されます。

    successful
    PageNumber

    integer

    ページ番号。ページは 1 から始まります。デフォルト値: 1。

    1
    PageSize

    integer

    1 ページあたりのエントリ数。有効な値: 1～99。デフォルト値: 10。

    10
    TotalCount

    integer

    指定された条件を満たすバックアッププランの総数。

    8
    BackupPlans

    object

    BackupPlan

    array<object>

    指定された条件を満たすバックアッププラン。

    array<object>

    VaultId

    string

    バックアップボールトの ID。

    v-*********************
    BackupType

    string

    バックアップタイプ。値 COMPLETE は完全バックアップを示します。

    COMPLETE
    CreateTime

    integer

    ファイルシステムが作成された時刻。このパラメーターは、SourceType が NAS に設定されている場合にのみ有効です。この値は UNIX タイムスタンプ (秒) です。

    1554347313
    DataSourceId

    string

    データソースの ID。

    ds-000ht6o9*****w61
    SourceType

    string

    データソースのタイプ。有効な値:

    • ECS_FILE: ECS インスタンスのファイル。

    • OSS: OSS のオブジェクト。

    • NAS: NAS のファイルシステム。

    • OTS: Tablestore インスタンス。

    • UDM_ECS: ECS インスタンス全体。

    • SYNC: データ同期。

    ECS_FILE
    Disabled

    boolean

    バックアッププランが一時停止されているかどうかを指定します。

    • true: バックアッププランは一時停止されています。

    • false: バックアッププランは一時停止されていません。

    false
    Prefix

    string

    バックアップするオブジェクトのプレフィックス。このパラメーターは、SourceType が OSS に設定されている場合にのみ有効です。

    oss-prefix
    Options

    string

    Windows ボリュームシャドウコピーサービス (VSS) を使用してシャドウコピーを作成するかどうかを指定します。このパラメーターは、SourceType が ECS_FILE に設定されている場合にのみ有効です。

    {"UseVSS":false}
    ClientId

    string

    クライアントの ID。

    c-000ge4w*****1qb
    Exclude

    string

    バックアップから除外するファイルへのパス。このパラメーターは、SourceType が ECS_FILE に設定されている場合にのみ有効です。指定されたパス内のファイルはバックアップされません。

    ["/var", "/proc"]

    Retention

    integer

    バックアップデータの保持期間 (日数)。

    7
    CreatedTime

    integer

    バックアッププランが作成された時刻。この値は UNIX タイムスタンプ (秒) です。

    1554347313
    ClusterId

    string

    クライアントグループの ID。

    cl-000ht6o9******h
    Bucket

    string

    OSS バケットの名前。このパラメーターは、SourceType が OSS に設定されている場合にのみ有効です。

    hbr-backup-oss
    Detail

    string

    ECS インスタンスバックアップの詳細。

    {\"doCopy\":true,\"doBackup\":false,\"instanceName\":\"instance example\",\"appConsistent\":false,\"destinationRegionId\":\"cn-shanghai\",\"enableFsFreeze\":true,\"osNameEn\":\"Windows Server 2019 Data Center Edition 64bit Chinese Edition\",\"osName\":\"Windows Server 2019 Data Center Edition 64bit Chinese Edition\",\"diskIdList\":[],\"backupVaultId\":\"\",\"snapshotGroup\":true,\"destinationRetention\":35,\"platform\":\"Windows Server 2012\",\"timeoutInSeconds\":60,\"backupRetention\":1,\"osType\":\"windows\",\"preScriptPath\":\"\",\"postScriptPath\":\"\",\"enableWriters\":true,\"ecsDeleted\":false}
    Schedule

    string

    バックアップポリシー。I|{startTime}|{interval} のフォーマットです。バックアップジョブは {startTime} から {interval} ごとに実行されます。期限切れのジョブはスキップされます。前のジョブがまだ実行中の場合、新しいジョブは開始されません。たとえば、I|1631685600|P1D は、2021-09-15 14:00:00 から毎日バックアップジョブが実行されることを意味します。

    • startTime: バックアップの開始時刻。これは UNIX タイムスタンプ (秒) です。

    • interval: ISO 8601 形式のバックアップ間隔。たとえば、PT1H は 1 時間を意味し、P1D は 1 日を意味します。

    I|1602673264|P1D
    SpeedLimit

    string

    バックアップのトラフィックシェーピングポリシー。このパラメーターは、SourceType が ECS_FILE に設定されている場合にのみ有効です。フォーマット: {start}|{end}|{bandwidth}。複数のポリシーはパイプ文字 (|) で区切ります。ポリシーの時間帯は重複できません。

    • start: 開始時間。

    • end: 終了時間。

    • bandwidth: 帯域幅制限。単位: KB。

    0:24:5120
    InstanceId

    string

    ECS インスタンスの ID。このパラメーターは、SourceType が ECS_FILE に設定されている場合にのみ有効です。

    i-*********************
    PlanId

    string

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

    plan-*********************
    BackupSourceGroupId

    string

    バックアップデータソースグループの ID。

    System-Database
    FileSystemId

    string

    ファイルシステムの ID。このパラメーターは、SourceType が NAS に設定されている場合にのみ有効です。

    00594
    OtsDetail

    object

    Tablestore インスタンスの詳細。

    TableNames

    object

    TableName

    array

    Tablestore インスタンス内のテーブル。

    string

    Tablestore インスタンス内のデータテーブルの名前。

    test2_HBR_RESTORED
    InstanceName

    string

    Tablestore インスタンスの名前。

    instancename
    UpdatedTime

    integer

    バックアッププランが更新された時刻。この値は UNIX タイムスタンプ (秒) です。

    1554347313
    PlanName

    string

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

    planname
    Include

    string

    バックアップするファイルへのパス。このパラメーターは、SourceType が ECS_FILE に設定されている場合にのみ有効です。指定されたパス内のすべてのファイルがバックアップされます。

    ["/home/alice/*.pdf", "/home/bob/*.txt"]
    Rules

    object

    Rule

    array<object>

    バックアップポリシー。このパラメーターはディスクバックアップにのみ有効です。

    object

    DestinationRetention

    integer

    geo 冗長バックアップの保持期間 (日数)。

    90
    Schedule

    string

    バックアップポリシー。I|{startTime}|{interval} のフォーマットです。バックアップジョブは {startTime} から {interval} ごとに実行されます。期限切れのジョブはスキップされます。前のジョブがまだ実行中の場合、新しいジョブは開始されません。たとえば、I|1631685600|P1D は、2021-09-15 14:00:00 から毎日バックアップジョブが実行されることを意味します。

    • startTime: バックアップの開始時刻。これは UNIX タイムスタンプ (秒) です。

    • interval: ISO 8601 形式のバックアップ間隔。たとえば、PT1H は 1 時間を意味し、P1D は 1 日を意味します。

    I|1631685600|P1D
    Retention

    integer

    バックアップデータの保持期間 (日数)。

    90
    Disabled

    boolean

    ポリシーが無効になっているかどうかを指定します。

    true
    DoCopy

    boolean

    バックアップスナップショットをバックアップボールトにコピーするかどうかを指定します。

    false
    DestinationRegionId

    string

    geo 冗長バックアップのターゲットリージョンの ID。

    cn-shanghai
    RuleId

    string

    ポリシーの ID。

    rule-0008i52rf0ulpni6kn6m
    RuleName

    string

    ポリシーの名前。

    Disk Golden Rule
    BackupType

    string

    バックアップタイプ。値 COMPLETE は完全バックアップを示します。

    COMPLETE
    Resources

    object

    Resource

    array<object>

    バックアップリソース。このパラメーターはディスクバックアップにのみ有効です。

    object

    SourceType

    string

    データソースのタイプ。有効な値: UDM_DISK。

    UDM_DISK
    ResourceId

    string

    データソースの ID。

    d-j6cgioir6m******lu4
    Extra

    string

    データソースに関する拡張情報。

    {\"doBackup\":false,\"diskName\":\"data_disk\",\"size\":100,\"type\":\"data\",\"category\":\"cloud_essd\",\"imageId\":\"\",\"device\":\"/dev/xvdb\",\"encrypted\":false}
    Paths

    object

    Path

    array

    バックアップパス。このパラメーターは、SourceType が ECS_FILE に設定されている場合にのみ有効です。

    string

    バックアップパス。

    ["/home"]
    TrialInfo

    object

    無料トライアル情報。

    TrialStartTime

    integer

    無料トライアルの開始時刻。

    1579413159
    TrialVaultReleaseTime

    integer

    無料トライアルボールトがリリースされる時刻。

    1594965600
    TrialExpireTime

    integer

    無料トライアルの有効期限が切れる時刻。

    1584597600
    KeepAfterTrialExpiration

    boolean

    無料トライアル終了後、プランを従量課金プランに変換するかどうかを指定します。

    true
    InstanceGroupId

    string

    インスタンスグループの ID。

    i-**
    CrossAccountType

    string

    クロスアカウントバックアップのタイプ。有効な値:

    • SELF_ACCOUNT

    • CROSS_ACCOUNT

    CROSS_ACCOUNT
    CrossAccountUserId

    integer

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

    1841642xxxxx9795
    CrossAccountRoleName

    string

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

    BackupRole
    KeepLatestSnapshots

    integer

    少なくとも 1 つのバックアップバージョンを保持するかどうかを指定します。

    • 0: 保持しません。

    • 1: 保持します。

    0
    DestSourceType

    string

    宛先データソースのタイプ。このパラメーターは、データ同期にのみ必要です。

    OSS
    DestDataSourceId

    string

    宛先データソースの ID。このパラメーターは、データ同期にのみ必要です。

    ds-*********************
    DestDataSourceDetail

    string

    宛先データソースの詳細。このパラメーターは、データ同期にのみ必要です。

    {\"prefix\":\"/\"}
    ChangeListPath

    string

    増分ファイル同期の構成。このパラメーターは、データ同期にのみ必要です。

    {"dataSourceId": "ds-123456789", "path": "/changelist"}
    LatestExecuteJobId

    string

    プランによって実行された最後のバックアップジョブの ID。

    job-12345678
    LatestFinishJobId

    string

    最後に完了したバックアップジョブの ID。

    job-00**************9khz
    CreatedByTag

    boolean

    バックアッププランがタグに基づいて自動的に作成されたかどうかを指定します。

    false
    HitTags

    object

    HitTag

    array<object>

    一致したタグルール。

    object

    一致したタグルール。

    Key

    string

    タグキー。

    type
    Value

    string

    タグ値。

    0
    Operator

    string

    タグ照合ルール。有効な値:

    • EQUAL: タグキーとタグ値に一致します。

    • NOT: タグキーには一致しますが、タグ値には一致しません。

    EQUAL
    BusinessStatus

    string

    ビジネスステータス。

    ACTIVE

    例

    成功レスポンス

    JSONJSON

    {
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
  "Success": true,
  "Code": "200",
  "Message": "successful",
  "PageNumber": 1,
  "PageSize": 10,
  "TotalCount": 8,
  "BackupPlans": {
    "BackupPlan": [
      {
        "VaultId": "v-*********************",
        "BackupType": "COMPLETE",
        "CreateTime": 1554347313,
        "DataSourceId": "ds-000ht6o9*****w61",
        "SourceType": "ECS_FILE",
        "Disabled": false,
        "Prefix": "oss-prefix",
        "Options": "{\"UseVSS\":false}",
        "ClientId": "c-000ge4w*****1qb",
        "Exclude": "[\"/var\", \"/proc\"]\t",
        "Retention": 7,
        "CreatedTime": 1554347313,
        "ClusterId": "cl-000ht6o9******h",
        "Bucket": "hbr-backup-oss",
        "Detail": "{\\\"doCopy\\\":true,\\\"doBackup\\\":false,\\\"instanceName\\\":\\\"instance example\\\",\\\"appConsistent\\\":false,\\\"destinationRegionId\\\":\\\"cn-shanghai\\\",\\\"enableFsFreeze\\\":true,\\\"osNameEn\\\":\\\"Windows Server  2019 Data Center Edition 64bit Chinese Edition\\\",\\\"osName\\\":\\\"Windows Server  2019 Data Center Edition 64bit Chinese Edition\\\",\\\"diskIdList\\\":[],\\\"backupVaultId\\\":\\\"\\\",\\\"snapshotGroup\\\":true,\\\"destinationRetention\\\":35,\\\"platform\\\":\\\"Windows Server 2012\\\",\\\"timeoutInSeconds\\\":60,\\\"backupRetention\\\":1,\\\"osType\\\":\\\"windows\\\",\\\"preScriptPath\\\":\\\"\\\",\\\"postScriptPath\\\":\\\"\\\",\\\"enableWriters\\\":true,\\\"ecsDeleted\\\":false}",
        "Schedule": "I|1602673264|P1D",
        "SpeedLimit": "0:24:5120",
        "InstanceId": "i-*********************",
        "PlanId": "plan-*********************",
        "BackupSourceGroupId": "System-Database",
        "FileSystemId": "00594",
        "OtsDetail": {
          "TableNames": {
            "TableName": [
              "test2_HBR_RESTORED"
            ]
          }
        },
        "InstanceName": "instancename",
        "UpdatedTime": 1554347313,
        "PlanName": "planname",
        "Include": "[\"/home/alice/*.pdf\", \"/home/bob/*.txt\"]",
        "Rules": {
          "Rule": [
            {
              "DestinationRetention": 90,
              "Schedule": "I|1631685600|P1D",
              "Retention": 90,
              "Disabled": true,
              "DoCopy": false,
              "DestinationRegionId": "cn-shanghai",
              "RuleId": "rule-0008i52rf0ulpni6kn6m",
              "RuleName": "Disk Golden Rule",
              "BackupType": "COMPLETE"
            }
          ]
        },
        "Resources": {
          "Resource": [
            {
              "SourceType": "UDM_DISK",
              "ResourceId": "d-j6cgioir6m******lu4",
              "Extra": "{\\\"doBackup\\\":false,\\\"diskName\\\":\\\"data_disk\\\",\\\"size\\\":100,\\\"type\\\":\\\"data\\\",\\\"category\\\":\\\"cloud_essd\\\",\\\"imageId\\\":\\\"\\\",\\\"device\\\":\\\"/dev/xvdb\\\",\\\"encrypted\\\":false}"
            }
          ]
        },
        "Paths": {
          "Path": [
            "[\"/home\"]"
          ]
        },
        "TrialInfo": {
          "TrialStartTime": 1579413159,
          "TrialVaultReleaseTime": 1594965600,
          "TrialExpireTime": 1584597600,
          "KeepAfterTrialExpiration": true
        },
        "InstanceGroupId": "i-**",
        "CrossAccountType": "CROSS_ACCOUNT",
        "CrossAccountUserId": 0,
        "CrossAccountRoleName": "BackupRole",
        "KeepLatestSnapshots": 0,
        "DestSourceType": "OSS",
        "DestDataSourceId": "ds-*********************",
        "DestDataSourceDetail": "{\\\"prefix\\\":\\\"/\\\"}",
        "ChangeListPath": "{\"dataSourceId\": \"ds-123456789\", \"path\": \"/changelist\"}",
        "LatestExecuteJobId": "job-12345678",
        "LatestFinishJobId": "job-00**************9khz",
        "CreatedByTag": false,
        "HitTags": {
          "HitTag": [
            {
              "Key": "type",
              "Value": "0",
              "Operator": "EQUAL"
            }
          ]
        },
        "BusinessStatus": "ACTIVE"
      }
    ]
  }
}

    エラーコード

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

    変更履歴

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