Связаться с намиПодключиться

Workflows Service, gRPC: ExecutionService.List

Статья создана
Обновлена 26 ноября 2024 г.

Retrieves list of Workflow executions.

gRPC request

rpc List (ListExecutionsRequest) returns (ListExecutionsResponse)

ListExecutionsRequest

{
  "workflow_id": "string",
  "page_size": "int64",
  "page_token": "string",
  "filter": "string"
}

Field

Description

workflow_id

string

Required field. ID of the Workflow.

page_size

int64

The maximum number of results per page that should be returned. If the number of available
results is larger than pageSize, the service returns a ListExecutionsResponse.next_page_token
that can be used to get the next page of results in subsequent list requests.

Default value: 100.

page_token

string

Page token. To get the next page of results, set pageToken to the
ListExecutionsResponse.next_page_token returned by a previous list request.

filter

string

A filter expression that filters resources listed in the response.

The expression must specify:

  1. The field name. Currently filtering can be applied to the following fields: status, started_at, finished_at.
  2. Operator: =, < or >.
  3. The value. Must be sting and match the regular expression [+:\.-a-z0-9].
    Examples of a filter: status=ERROR, created_by=John.Doe.

ListExecutionsResponse

{
  "executions": [
    {
      "id": "string",
      "workflow_id": "string",
      "status": "Status",
      "started_at": "google.protobuf.Timestamp",
      "duration": "google.protobuf.Duration"
    }
  ],
  "next_page_token": "string"
}

Field

Description

executions[]

ExecutionPreview

List of Workflow executions.

next_page_token

string

Token for getting the next page of the list. If the number of results is greater than
the specified ListExecutionsRequest.page_size, use next_page_token as the value
for the ListExecutionsRequest.page_token parameter in the next list request.

Each subsequent page will have its own next_page_token to continue paging through the results.

ExecutionPreview

Field

Description

id

string

ID of the Workflow execution. Generated at creation time.

workflow_id

string

ID of the Workflow.

status

enum Status

Status of the Workflow execution

  • STATUS_UNSPECIFIED
  • QUEUED: Workflow execution is being queued.
  • RUNNING: Workflow execution is running.
  • PAUSED: Workflow execution is being paused.
  • STOPPED: Workflow execution is stopped.
  • FAILED: Workflow execution is failed.
  • FINISHED: Workflow execution is finished.

started_at

google.protobuf.Timestamp

Start timestamp for the Workflow execution.

duration

google.protobuf.Duration

Duration of the Workflow execution.
Предыдущая
GetHistory
Следующая
Overview