新しく作成したデータ取得ジョブを照会します。

デバッグ

OpenAPI Explorer は署名値を自動的に計算します。 この操作は、OpenAPI Explorer で呼び出すことを推奨します。 OpenAPI Explorer は、さまざまな SDK に対して操作のサンプルコードを動的に生成します。

リクエストパラメーター

パラメーター データ型 必須／任意 例 説明
操作 String 必須 ListLifecycleRetrieveJobs

実行する操作です。

Set the value to ListLifecycleRetrieveJobs.
PageSize Integer 任意 10

各ページで返されるエントリ数。

有効値：1～100 。

Default value: 10.
PageNumber Integer 任意 1

返されるページ数。

ページ番号は 1 から始まります。 デフォルト値：1。
FileSystemId String 任意 31a8e4 ****

ファイルシステムの ID。

ステータス String 任意 完了

データ取得ジョブのステータス。

設定可能な値は以下のとおりです。

  • active: ジョブが実行中です。
  • canceled: ジョブがキャンセルされました。
  • completed: ジョブが完了しました。
  • failed: ジョブが失敗しました。

レスポンスパラメーター

パラメーター データ型 例 説明
LifecycleRetrieveJobs LifecycleRetrieveJobの配列

データ取得ジョブの詳細。

CreateTime String 2021-02-30T10:08:08Z

ジョブが作成された時刻。

時間はISO 8601標準のyyyy-MM-ddTHH:mm:ssZ形式に従います。

DiscoveredFileCount Long 100

データ取得ジョブで読み取られたファイルの総数。

FileSystemId String 31a8e4****

ファイルシステムの ID。

JobId String lrj-nfstest-ia-160 **** 853-hshvw

データ取得ジョブのID。

Paths List ["/pathway/to/folder","/pathway/to/folder","/pathway/to/folder"]

Indicates the directory or file whose data you want to retrieve.

パスの先頭にはスラッシュ (/) を付ける必要があります。 マウントターゲットに存在するパスである必要があります。

RetrievedFileCount Long 80

IAストレージメディアから取得されたファイルの数。

ステータス String complete

データ取得ジョブのステータス。

設定可能な値は以下のとおりです。

  • active: ジョブが実行中です。
  • canceled: The job is canceled.
  • completed: ジョブが完了しました。
  • failed: ジョブが失敗しました。
UpdateTime String 2021-02-30T11:08:08Z

The time when the job was updated.

時間はISO 8601標準のyyyy-MM-ddTHH:mm:ssZ形式に従います。

PageNumber Integer 1

返されたページの数です。

PageSize Integer 10

1 ページあたりで返されるエントリ数。

RequestId String BC7C825C-5F65-4B56-BEF6-98C56C7C ****

リクエストの ID です。

TotalCount Integer 10

データ取得ジョブの数。

例

リクエストの例

http(s):// [エンドポイント]/?Action=ListLifecycleRetrieveJobs
&<共通リクエストパラメータ>

正常に処理された場合のレスポンス例

XML 形式 

<RequestId>BC7C825C-5F65-4B56-BEF6-98C56C7C ****</RequestId>
<TotalCount>1</TotalCount>
<PageNumber>1</PageNumber>
<PageSize>10</PageSize>
<LifecycleRetrieveJobs>
    <CreateTime>2020-10-30T10:08:08Z</CreateTime>
    <UpdateTime>2021-01-30T10:08:08Z</UpdateTime>
    <JobId>lrj-nfstest-ia-160****375-clrrt</JobId>
    <Paths>/pathway/to/folder</Paths>
    <パス>/pathway/to/folder</パス>
    <Paths>/pathway/to/folder</Paths>
    <FileSystemId>434 **** 123</FileSystemId>
    <Status>active</Status>
    <RetrievedFileCount>50</RetrievedFileCount>
    <DiscoveredFileCount>100</DiscoveredFileCount>
</LifecycleRetrieveJobs>

JSON 形式 

{
    "RequestId": "BC7C825C-5F65-4B56-BEF6-98C56C7C ****" 、
    "TotalCount": 1,
    "PageNumber": 1,
    "PageSize": 10,
    "LifecycleRetrieveJobs": [
      {
        "CreateTime": "2020-10-30T10:08:08Z",
        "UpdateTime":"2021-01-30T10:08:08Z" 、
        "JobId": "lrj-nfstest-ia-160 **** 375-clrrt" 、
        "パス": [
          "/pathway/to/folder" 、
          "/pathway/to/folder",
          "/pathway/to/folder"
        ],
        "FileSystemId": "434****123",
        "Status": "active",
        "RetrievedFileCount": 50、
        "DiscoveredFileCount": 100
      }
    ]
  }

エラーコード

HttpCode エラーコード エラーメッセージ 説明
404 InvalidFileSystem.NotFound 指定されたファイルシステムが存在しません。 指定されたファイルシステムが存在しない場合に返されるエラーメッセージ。

エラーコードリストについては、「API エラーセンター」をご参照ください。