Methode: Cursor.projects.locations.subscriptions.cursors.list

Gibt alle Commit-Cursor-Informationen für ein Abo zurück.

HTTP-Anfrage

GET https://{endpoint}/v1/cursor/{parent=projects/*/locations/*/subscriptions/*}/cursors

Dabei ist {endpoint} einer der unterstützten Dienstendpunkte.

Die URLs verwenden die Syntax der gRPC-Transcodierung.

Pfadparameter

Parameter
parent

string

Erforderlich Das Abo, für das Cursors abgerufen werden sollen. Strukturiert wie projects/{project_number}/locations/{location}/subscriptions/{subscriptionId}.

Suchparameter

Parameter
pageSize

integer

Die maximale Anzahl der zurückzugebenden Cursor. Der Dienst gibt möglicherweise weniger als diesen Wert zurück. Wenn nicht festgelegt oder null, werden alle Cursor für das übergeordnete Element zurückgegeben.

pageToken

string

Ein Seitentoken, das von einem vorherigen cursors.list-Aufruf empfangen wurde. Geben Sie diese an, um die nachfolgende Seite abzurufen.

Beim Paginieren müssen alle anderen für cursors.list bereitgestellten Parameter mit dem Aufruf übereinstimmen, der das Seitentoken bereitgestellt hat.

Anfragetext

Der Anfragetext muss leer sein.

Antworttext

Bei Erfolg enthält der Antworttext Daten mit der folgenden Struktur:

Antwort für cursors.list

JSON-Darstellung

{
  "partitionCursors": [
    {
      object (PartitionCursor)
    }
  ],
  "nextPageToken": string
}
Felder
partitionCursors[]

object (PartitionCursor)

Die Partitions-Cursors dieser Anfrage.

nextPageToken

string

Ein Token, das als pageToken gesendet werden kann, um die nächste Seite abzurufen. Wenn dieses Feld weggelassen wird, gibt es keine nachfolgenden Seiten.

Autorisierungsbereiche

Erfordert den folgenden OAuth-Bereich:

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

Weitere Informationen finden Sie unter Authentifizierung.

PartitionCursor

Ein Paar aus einem Cursor und der Partition, für die er vorgesehen ist.

JSON-Darstellung

{
  "partition": string,
  "cursor": {
    object (Cursor)
  }
}
Felder
partition

string (int64 format)

Die Partition, für die dies vorgesehen ist.

cursor

object (Cursor)

Der Wert des Cursors.

Cursor

Ein Cursor, der die Position einer Nachricht innerhalb einer Themenpartition beschreibt.

JSON-Darstellung

{
  "offset": string
}
Felder
offset

string (int64 format)

Der Offset einer Nachricht innerhalb einer Themenpartition. Muss größer oder gleich 0 sein.