すべてのプロダクト
Search

このプロダクト

    :DescribeBackupJobs2

    ドキュメントセンター

    :DescribeBackupJobs2

    最終更新日:Mar 24, 2026

    指定された条件に一致するバックアップジョブを照会します。

    今すぐお試しください

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

    get

    *All Resource

    *

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    PageNumber

    integer

    任意

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

    1
    PageSize

    integer

    任意

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

    10
    SourceType

    string

    任意

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

    • ECS_FILE：Elastic Compute Service (ECS) のファイルをバックアップします。

    • OSS：Alibaba Cloud Object Storage Service (OSS) のバケットをバックアップします。

    • NAS：Alibaba Cloud Apsara File Storage NAS (NAS) のファイルシステムをバックアップします。

    • OTS：Alibaba Cloud Tablestore のインスタンスをバックアップします。

    • UDM_ECS：ECS インスタンス全体をバックアップします。

    • UDM_ECS_DISK：ECS インスタンスのバックアップジョブにおけるディスクバックアップのサブタスク。

    • COMMON_NAS：汎用 NAS データソース。これには、アーカイブ NAS およびオンプレミス NAS データソースが含まれます。Filters の Values パラメーターを使用してデータソースタイプを指定します。

    • File：オンプレミスファイルをバックアップします。

    • SYNC：データ同期。

    ECS_FILE
    SortDirection

    string

    任意

    ソート順。有効な値：

    • ASCEND：昇順。

    • DESCEND (デフォルト)：降順。

    DESCEND
    Filters

    array<object>

    任意

    フィルターのキーと値のペア。

    object

    任意

    フィルター。

    Key

    string

    任意

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

    • RegionId：リージョン ID。

    • PlanId：バックアッププラン ID。

    • JobId：バックアップジョブ ID。

    • VaultId：リポジトリ ID。

    • InstanceId：ECS インスタンス ID。

    • Bucket：OSS バケットの名前。

    • FileSystemId：ファイルシステム ID。

    • Status：ジョブのステータス。

    • CreatedTime：ジョブの開始時刻。

    • CompleteTime：ジョブの終了時刻。

    • InstanceName：Tablestore インスタンスの名前。

    • BackupType：バックアップジョブ。このパラメーターは、SourceType が COMMON_NAS に設定されている場合にのみ必要です。

    • ParentId：親ジョブの ID。このパラメーターは、サブタスクを照会する場合に必要です。たとえば、SourceType を UDM_ECS_DISK に設定した場合、UDM_ECS ジョブの ID を指定する必要があります。

    VaultId
    Values

    array

    任意

    フィルターの値。

    string

    任意

    フィルターの値。

    COMPLETE：オンプレミス NAS バックアップ。

    0: ARCHIVE：アーカイブ NAS データソース。

    1: ARCHIVE_BY_SEARCH：アーカイブ NAS データソース。

    COMPLETE
    Operator

    string

    任意

    照合演算子。デフォルト値は IN です。このパラメーターは、Key と Value の照合に使用する演算子を指定します。有効な値：

    • EQUAL：等しい。

    • NOT_EQUAL：等しくない。

    • GREATER_THAN：より大きい。

    • GREATER_THAN_OR_EQUAL：以上。

    • LESS_THAN：より小さい。

    • LESS_THAN_OR_EQUAL：以下。

    • BETWEEN：値は [start,end] 形式の JSON 配列です。

    • IN：値は配列です。

    説明

    クエリのキーとして CompleteTime を使用する場合、IN 演算子はサポートされません。

    IN
    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
    BackupJobs

    object

    BackupJob

    array<object>

    指定された条件に一致するバックアップジョブのリスト。

    array<object>

    バックアップジョブの詳細。

    Status

    string

    バックアップジョブのステータス。有効な値：

    • COMPLETE：ジョブは成功しました。

    • PARTIAL_COMPLETE：ジョブは部分的に成功しました。

    • FAILED：ジョブは失敗しました。

    COMPLETE
    ErrorMessage

    string

    バックアップジョブのエラーメッセージ。

    PARTIAL_COMPLETE
    ActualItems

    integer

    このパラメーターは、SourceType が ECS_FILE に設定されている場合にのみ有効です。バックアップジョブ内の実際の項目数を示します。

    6
    VaultId

    string

    バックアップリポジトリの ID。

    v-0006******q
    ActualBytes

    integer

    重複排除後のバックアップジョブの実際のデータ量。単位：バイト。

    600
    CreateTime

    integer

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

    1607436917
    BackupType

    string

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

    COMPLETE
    Prefix

    string

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

    example/
    SourceType

    string

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

    • ECS_FILE：ECS ファイルをバックアップします。

    • OSS：Alibaba Cloud OSS バケットをバックアップします。

    • NAS：Alibaba Cloud NAS ファイルシステムをバックアップします。

    ECS_FILE
    Options

    string

    このパラメーターは、SourceType が ECS_FILE に設定されている場合にのみ必要です。ボリュームシャドウコピーサービス (VSS) を使用してバックアップパスを定義するかどうかを示します。

    • この機能は、Windows の ECS インスタンスでのみ利用可能です。

    • バックアップソース内のデータが変更された場合は、このパラメーターを {"UseVSS":true} に設定して、バックアップとソース間のデータ整合性を確保します。

    • VSS を有効にすると、複数のファイルディレクトリを同時にバックアップすることはできません。

    {"UseVSS":false}
    ClientId

    string

    このパラメーターは、SourceType が ECS_FILE に設定されている場合にのみ有効です。バックアップクライアントの ID を示します。

    c-*********************
    ItemsDone

    integer

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

    8
    BytesTotal

    integer

    データソースの総データ量。単位：バイト。

    1000
    Exclude

    string

    このパラメーターは、SourceType が ECS_FILE に設定されている場合にのみ必要です。バックアップする必要のないファイルへのパスを示します。このパス内のすべてのファイルは除外されます。パスの長さは最大 255 文字です。

    ["/var", "/proc"]
    JobName

    string

    バックアップジョブの名前。

    jobname
    CompleteTime

    integer

    バックアップジョブが完了した時刻。この値は UNIX タイムスタンプです。単位：秒。

    1554347313
    CreatedTime

    integer

    バックアップジョブが作成された時刻。この値は UNIX タイムスタンプです。単位：秒。

    1554347313
    Bucket

    string

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

    hbr-backup-oss
    Progress

    integer

    バックアップの進捗状況。値は 100% × 100 で計算されます。

    10000
    SpeedLimit

    string

    このパラメーターは、SourceType が ECS_FILE に設定されている場合にのみ必要です。バックアップのトラフィックシェーピング設定を示します。フォーマットは {start}|{end}|{bandwidth} です。複数のトラフィックシェーピング構成を区切るには | 文字を使用します。構成の時間範囲は重複できません。

    • start：開始時間。

    • end：終了時間。

    • bandwidth：制限速度。単位：KB/s。

    0:24:5120
    InstanceId

    string

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

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

    string

    バックアッププラン ID。

    plan-20********35
    FileSystemId

    string

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

    005494
    StartTime

    integer

    バックアップジョブが開始された時刻。この値は UNIX タイムスタンプです。単位：秒。

    1554347313
    UpdatedTime

    integer

    バックアップジョブが更新された時刻。この値は UNIX タイムスタンプです。単位：秒。

    1554347313
    JobId

    string

    バックアップジョブ ID。

    job-000g********w7
    ItemsTotal

    integer

    このパラメーターは、SourceType が ECS_FILE に設定されている場合にのみ有効です。データソース内の項目の総数を示します。

    10
    Include

    string

    バックアップジョブに含まれるソースパス。

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

    integer

    増分バックアップのデータ量。単位：バイト。

    800
    Paths

    object

    Path

    array

    バックアップのソースパス。

    string

    ソースパス。

    "/home"
    Detail

    object

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

    DoCopy

    boolean

    リモートレプリケーションが実行されるかどうかを示します。

    true
    DestinationNativeSnapshotId

    string

    リモートレプリケーションスナップショットの ID。

    s-******************
    DestinationNativeSnapshotProgress

    integer

    リモートレプリケーションの進捗状況。

    85
    DestinationNativeSnapshotStatus

    string

    リモートレプリケーションのステータス。

    COMPLETE
    DestinationRetention

    integer

    リモートレプリケーションバックアップの保持期間。

    30
    DestinationSnapshotId

    string

    リモートレプリケーションバックアップの ID。

    s-******************
    DestinationNativeSnapshotErrorMessage

    string

    失敗したリモートレプリケーションのエラーメッセージ。

    ECS.CreatingSnapshot
    NativeSnapshotId

    string

    スナップショット ID。

    s-******************
    DiskNativeSnapshotIdList

    object

    DiskNativeSnapshotId

    array

    スナップショットとディスク間のマッピング。

    string

    スナップショット ID。

    s-******************
    InstanceInfos

    object

    ECS インスタンスに関する情報。インスタンス名とインスタンスタイプが含まれます。

    { "i-xxxxxxxx": { "hostName": "test", "instanceName": "test", "instanceType": "ecs.c7.xlarge", "osType": "linux", "diskIds": [ "d-xxxxxxxx01", "d-xxxxxxxx02" ], "osNameEn": "Rocky Linux 8.8 64 bit", "osName": "Rocky Linux 8.8 64位", "platform": "Rocky Linux" } }
    InstanceName

    string

    Tablestore インスタンスの名前。

    instancename
    OtsDetail

    object

    Tablestore インスタンスの詳細。

    TableNames

    object

    TableName

    array

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

    string

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

    ["table1", "table2", "table3"]
    Speed

    integer

    実際の平均バックアップ速度。単位：KB/s。

    500
    TableName

    string

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

    table1
    CrossAccountType

    string

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

    • SELF_ACCOUNT：同じアカウント内でデータをバックアップします。

    • CROSS_ACCOUNT：アカウント間でデータをバックアップします。

    SELF_ACCOUNT
    CrossAccountUserId

    integer

    クロスアカウントバックアップのために現在のアカウントによって管理されるソースアカウントの ID。

    158975xxxxx4625
    CrossAccountRoleName

    string

    クロスアカウントバックアップのためにソースアカウントで作成され、現在のアカウントによって管理される RAM ロールの名前。

    BackupRole
    Report

    object

    ジョブレポート。

    TotalFiles

    string

    すべてのファイルのリスト。このパラメーターはデータ同期では返されません。

    /temp/report/158975xxxxxx4625/job-0001hfxxxxxymsspjjtl/job-0001hfxxxxxymsspjjtl_total.csv
    SuccessFiles

    string

    成功したファイルのリスト。

    /temp/report/158975xxxxxx4625/r-0001hfxxxxxymsspjjtl/job-0001hfxxxxxymsspjjtl_success.zip
    FailedFiles

    string

    失敗したファイルのリスト。

    /temp/report/158975xxxxxx4625/r-0001hfxxxxxymsspjjtl/job-0001hfxxxxxymsspjjtl_failed.zip
    SkippedFiles

    string

    スキップされたファイルのリスト。

    /temp/report/158975xxxxxx4625/r-0001hfxxxxxymsspjjtl/job-0001hfxxxxxymsspjjtl_skipped.zip
    ReportTaskStatus

    string

    レポート生成のステータス。

    COMPLETE
    Identifier

    string

    このパラメーターは、SourceType が CONTAINER に設定されている場合にのみ返されます。コンテナバックアップジョブによってバックアップされるクラスターの ID を示します。クラスターが Container Service for Kubernetes (ACK) クラスターである場合、このパラメーターは ACK クラスター ID を示します。

    c83**************************b76
    DestSourceType

    string

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

    OSS
    DestDataSourceId

    string

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

    ds-000cov4ufudxklj24zdk
    DestDataSourceDetail

    string

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

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

    string

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

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

    integer

    処理されるファイルの総数。

    10
    FilesDone

    integer

    処理されたファイルの数。

    9
    ActualFiles

    integer

    実際に処理されたファイルの数。

    8
    TriggerMode

    string

    例

    成功レスポンス

    JSONJSON

    {
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
  "Success": true,
  "Code": "200",
  "Message": "successful",
  "PageNumber": 1,
  "PageSize": 10,
  "TotalCount": 8,
  "BackupJobs": {
    "BackupJob": [
      {
        "Status": "COMPLETE",
        "ErrorMessage": "PARTIAL_COMPLETE",
        "ActualItems": 6,
        "VaultId": "v-0006******q",
        "ActualBytes": 600,
        "CreateTime": 1607436917,
        "BackupType": "COMPLETE",
        "Prefix": "example/",
        "SourceType": "ECS_FILE",
        "Options": "{\"UseVSS\":false}",
        "ClientId": "c-*********************",
        "ItemsDone": 8,
        "BytesTotal": 1000,
        "Exclude": "[\"/var\", \"/proc\"]",
        "JobName": "jobname",
        "CompleteTime": 1554347313,
        "CreatedTime": 1554347313,
        "Bucket": "hbr-backup-oss",
        "Progress": 10000,
        "SpeedLimit": "0:24:5120",
        "InstanceId": "i-*********************",
        "PlanId": "plan-20********35",
        "FileSystemId": "005494",
        "StartTime": 1554347313,
        "UpdatedTime": 1554347313,
        "JobId": "job-000g********w7",
        "ItemsTotal": 10,
        "Include": "[\"/home/alice/*.pdf\", \"/home/bob/*.txt\"]",
        "BytesDone": 800,
        "Paths": {
          "Path": [
            "\"/home\""
          ]
        },
        "Detail": {
          "DoCopy": true,
          "DestinationNativeSnapshotId": "s-******************",
          "DestinationNativeSnapshotProgress": 85,
          "DestinationNativeSnapshotStatus": "COMPLETE",
          "DestinationRetention": 30,
          "DestinationSnapshotId": "s-******************",
          "DestinationNativeSnapshotErrorMessage": "ECS.CreatingSnapshot",
          "NativeSnapshotId": "s-******************",
          "DiskNativeSnapshotIdList": {
            "DiskNativeSnapshotId": [
              "s-******************"
            ]
          },
          "InstanceInfos": {
            "i-xxxxxxxx": {
              "hostName": "test",
              "instanceName": "test",
              "instanceType": "ecs.c7.xlarge",
              "osType": "linux",
              "diskIds": [
                "d-xxxxxxxx01",
                "d-xxxxxxxx02"
              ],
              "osNameEn": "Rocky Linux 8.8 64 bit",
              "osName": "Rocky Linux 8.8 64位",
              "platform": "Rocky Linux"
            }
          }
        },
        "InstanceName": "instancename",
        "OtsDetail": {
          "TableNames": {
            "TableName": [
              "[\"table1\", \"table2\", \"table3\"]"
            ]
          }
        },
        "Speed": 500,
        "TableName": "table1",
        "CrossAccountType": "SELF_ACCOUNT",
        "CrossAccountUserId": 0,
        "CrossAccountRoleName": "BackupRole",
        "Report": {
          "TotalFiles": "/temp/report/158975xxxxxx4625/job-0001hfxxxxxymsspjjtl/job-0001hfxxxxxymsspjjtl_total.csv",
          "SuccessFiles": "/temp/report/158975xxxxxx4625/r-0001hfxxxxxymsspjjtl/job-0001hfxxxxxymsspjjtl_success.zip",
          "FailedFiles": "/temp/report/158975xxxxxx4625/r-0001hfxxxxxymsspjjtl/job-0001hfxxxxxymsspjjtl_failed.zip",
          "SkippedFiles": "/temp/report/158975xxxxxx4625/r-0001hfxxxxxymsspjjtl/job-0001hfxxxxxymsspjjtl_skipped.zip",
          "ReportTaskStatus": "COMPLETE"
        },
        "Identifier": "c83**************************b76",
        "DestSourceType": "OSS",
        "DestDataSourceId": "ds-000cov4ufudxklj24zdk",
        "DestDataSourceDetail": "{\\\"prefix\\\":\\\"/\\\"}",
        "ChangeListPath": "{\"dataSourceId\": \"ds-123456789\", \"path\": \"/changelist\"}",
        "FilesTotal": 10,
        "FilesDone": 9,
        "ActualFiles": 8,
        "TriggerMode": ""
      }
    ]
  }
}

    エラーコード

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

    変更履歴

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