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

מציג רשימה של ConnectorRun של DataConnector.

בקשת 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.

אם למבצע הקריאה אין הרשאה להציג רשימה של ConnectorRuns במסגרת DataConnector הזה, בלי קשר לשאלה אם DataConnector הזה קיים או לא, מוחזרת שגיאת PERMISSION_DENIED.

פרמטרים של שאילתה

פרמטרים
pageSize

integer

גודל הדף המבוקש. יכול להיות שהשרת יחזיר פחות פריטים ממה שביקשתם. אם לא מציינים ערך, ברירת המחדל היא 10. הערך המקסימלי הוא 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.assist.readwrite
  • https://www.googleapis.com/auth/discoveryengine.readwrite
  • https://www.googleapis.com/auth/discoveryengine.serving.readwrite

ניתן למצוא מידע נוסף כאן: Authentication Overview.

הרשאות IAM

נדרשת הרשאת IAM הבאה במשאב parent:

  • discoveryengine.connectorRuns.list

מידע נוסף מופיע במאמרי העזרה בנושא IAM.