メソッド: runs.list

完全名: projects.transferConfigs.runs.list

実行中のジョブと完了したジョブの情報を返します。

HTTP リクエスト

GET https://bigquerydatatransfer.googleapis.com/v1/{parent=projects/*/transferConfigs/*}/runs

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

パスパラメータ

パラメータ
parent

string

必須。取得する必要のある転送実行の転送構成の名前。転送構成リソース名の形式は projects/{projectId}/transferConfigs/{configId} または projects/{projectId}/locations/{locationId}/transferConfigs/{configId} です。

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

  • bigquery.transfers.get

クエリ パラメータ

パラメータ
states

enum (TransferState)

指定した場合は、リクエストされた状態の転送実行だけが返されます。

pageToken

string

ページ分割トークン。ListTransferRunsRequest リスト結果の特定のページをリクエストする場合に使用できます。複数ページの結果の場合は、ListTransferRunsResponsenext_page トークンを出力します。このトークンを pageToken 値として使用して、リスト結果の次のページをリクエストできます。

pageSize

integer

ページサイズ。デフォルトのページサイズは 1,000(最大値)です。

runAttempt

enum (RunAttempt)

実行を pull する方法を表します。

リクエストの本文

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

レスポンスの本文

成功した場合、レスポンスの本文には ListTransferRunsResponse のインスタンスが含まれます。

認証スコープ

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

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

詳細については、認証の概要をご覧ください。

試してみる