Method: projects.locations.collections.dataConnector.connectorRuns.list

DataConnector の ConnectorRun をリストします。

HTTP リクエスト

GET https://discoveryengine.googleapis.com/v1alpha/{parent=projects/*/locations/*/collections/*/dataConnector}/connectorRuns

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

パスパラメータ

パラメータ
parent

string

必須。親 DataConnector リソース名（projects/{project}/locations/{location}/collections/{collectionId}/dataConnector など）。

呼び出し元にこの DataConnector の ConnectorRun を一覧表示する権限がない場合、この DataConnector が存在するかどうかにかかわらず、PERMISSION_DENIED エラーが返されます。

クエリ パラメータ

パラメータ
pageSize

integer

リクエストされたページサイズ。サーバーはリクエストされた数よりも少ない項目を返す場合があります。指定しない場合、デフォルトは 10 です。最大値は 50 です。50 を超える値は 50 に強制変換されます。

このフィールドが負の数の場合、INVALID_ARGUMENT エラーが返されます。
pageToken

string

前回の connectorRuns.list 呼び出しから受け取ったページトークン。後続のページを取得するにはこれを指定します。

ページ分割を行う場合、connectorRuns.list に指定する他のすべてのパラメータは、ページトークンを提供した呼び出しと一致する必要があります。

リクエストの本文

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

レスポンスの本文

DataConnectorService.ListConnectorRuns メソッドに対するレスポンス。

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

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

object (ConnectorRun)

ConnectorRun のリスト。
nextPageToken

string

次のページを取得するために pageToken として送信できるトークン。このフィールドを省略すると、後続のページはなくなります。

認可スコープ

次の OAuth スコープのいずれかが必要です。

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

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

IAM 権限

parent リソースに対する次の IAM 権限が必要です。

  • discoveryengine.connectorRuns.list

詳細については、IAM のドキュメントをご覧ください。