[GET]/cloudbackup/jobs

Cloud Backup for Microsoft 365 のジョブ情報を取得します。

クエリ パラメーター

パラメーター

説明

タイプ

StartTime

期間の開始時間 (UTC 時間) を設定します。

long

FinishTime

期間の終了時間 (UTC 時間) を設定します。

long

JobType

取得するジョブ タイプを設定します。

components/schemas/BackupJobType 定義されています。

Enum

有効な値:

0 (すべて)

1 (バックアップ)

2 (リストア)

3 (エクスポート)

4 (削除)

5 (保持)

ObjectType

取得するジョブのサービス タイプを設定します。

components/schemas/CloudBackupJobObjectType によって定義されました。

Enum

有効な値: 

0 (すべて

1 (Exchange Online) 

2 (SharePoint Online) 

3 (OneDrive)

4 (Microsoft 365 グループ)

5 (Project Online)

6 (パブリック フォルダー)

7 (Teams)

8 (Viva Engage)

9 (Teams チャット)

10 (Power BI) 

11 (Power Automate)

12 (Power Apps)

JobState

ジョブ状態を設定します。

#/components/schemas/CloudBackupJobState によって定義されました。

Enum

有効な値:

0 (すべて)

1 (実行中)

2 (完了)

3 (失敗)

4 (完了 (実行中に例外あり))

5 (一部完了)

PageIndex

ジョブを取得するページの開始番号を設定します。既定の値は 0 です。

Int

PageSize

1 ページに表示されるジョブの数を設定します。既定の値は 10 です。

Int

レスポンス

リクエストが正常に処理された場合、200 OK レスポンスが返され、リクエストされた情報がレスポンス ボディに表示されます。

取得結果

レスポンス

説明

タイプ

TotalCount

取得したジョブの合計数です。

Int

Jobs

ジョブ一覧です。

List

NextLink

次のページへの結果の参照

String

ジョブ サマリー:

レスポンス

説明

タイプ

ID

ジョブ ID

String

State

ジョブ状態

String

StartTime

ジョブ開始時刻

long

FinishTime

ジョブ完了時刻

long

Duration

期間

long

BackupDetails

ジョブの詳細

Int

バックアップの詳細:

レスポンス

説明

タイプ

TotalCount

合計数

long

FailedCount

失敗したオブジェクト数

long

SuccessfulCount

成功したオブジェクト数

long

SkippedCount

スキップしたオブジェクト数

long

ジョブ エラー:

IsErrorCode

このエラーに関連するエラー コードが存在するかどうか

boolean

Value

エラー メッセージ

String

URL

エラー コード URL

String

Number

このジョブで発生したエラー

long

 

(application/json) の例:

リクエスト

{
  StartTime?: long
  FinishTime?: long.
  JobType?: #/components/schemas/BackupJobType
  ObjectType?: #/components/schemas/CloudBackupJobObjectType
  JobState?: #/components/schemas/CloudBackupJobState
  PageIndex?: int
  PageSize?: int
}

レスポンス

{
  TotalCount?: int
  Jobs:[
  { 
    Id?: string
    State?: string
    StartTime?: long
    FinishTime?: long
    Duration?: long
    BackupDetails?: 
    {
      TotalCount?: long
      FailedCount?: long
      SuccessfulCount?: long
      SkippedCount?: long
    }


    JobErrors: [

                {

                    IsErrorCode: boolean,

                    Value: string

                    Url: string

                    Number: long

                }

               ]

  }

  ]

}