Method: transferJobs.list

転送ジョブを一覧表示します。

HTTP リクエスト

GET https://storagetransfer.googleapis.com/v1/transferJobs

この URL は gRPC Transcoding 構文を使用します。

クエリ パラメータ

パラメータ
filter

string

必須。次の形式の JSON テキストとして指定されたクエリ パラメータのリスト。

{
  "projectId":"my_project_id",
  "jobNames":["jobid1","jobid2",...],
  "jobStatuses":["status1","status2",...],
  "dataBackend":"QUERY_REPLICATION_CONFIGS",
  "sourceBucket":"source-bucket-name",
  "sinkBucket":"sink-bucket-name",
}

サンプルの JSON 形式は表示専用です。クエリ パラメータにはスペースや改行を入れないでください。

  • projectId は必須です。
  • jobNames と jobStatuses は複数の値をサポートしているため、値は配列表記で指定する必要があります。jobNames と jobStatuses は省略可能です。有効な値では大文字と小文字が区別されません。
  • "dataBackend":"QUERY_REPLICATION_CONFIGS" を指定して、バケット間レプリケーション ジョブのリストを返します。
  • sourceBucket を使用して特定のバケットのジョブに結果を制限するか、sinkBucket を使用して特定のバケットに結果を制限します。

認可には、指定されたリソース filter に対する次の IAM の権限が必要です。

  • storagetransfer.jobs.list
pageSize

integer

リストのページサイズ。許容される最大値は 256 です。
pageToken

string

リストのページトークン。

リクエストの本文

リクエストの本文は空にする必要があります。

レスポンスの本文

transferJobs.list からのレスポンス。

成功した場合、レスポンスの本文には次の構造のデータが含まれます。

JSON 表現 
{
  "transferJobs": [
    {
      object (TransferJob)
    }
  ],
  "nextPageToken": string
}
フィールド
transferJobs[]

object (TransferJob)

転送ジョブのリスト。
nextPageToken

string

リストの次ページのトークン。

認可スコープ

次の OAuth スコープが必要です。

  • https://www.googleapis.com/auth/cloud-platform

詳細については、Authentication Overview をご覧ください。