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

Cloud Functions Service, gRPC: FunctionService.List

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

Retrieves the list of functions in the specified folder.

gRPC request

rpc List (ListFunctionsRequest) returns (ListFunctionsResponse)

ListFunctionsRequest

{
  "folderId": "string",
  "pageSize": "int64",
  "pageToken": "string",
  "filter": "string"
}

Field

Description

folderId

string

Required field. ID of the folder to list functions in.

To get a folder ID make a yandex.cloud.resourcemanager.v1.FolderService.List request.

pageSize

int64

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

Default value: 100.

pageToken

string

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

filter

string

A filter expression that filters functions listed in the response.

The expression must specify:

  1. The field name. Currently filtering can only be applied to the Function.name field.
  2. An = operator.
  3. The value in double quotes ("). Must be 3-63 characters long and match the regular expression [a-z][-a-z0-9]{1,61}[a-z0-9].
    Example of a filter: name="my-function".

ListFunctionsResponse

{
  "functions": [
    {
      "id": "string",
      "folderId": "string",
      "createdAt": "google.protobuf.Timestamp",
      "name": "string",
      "description": "string",
      "labels": "string",
      "httpInvokeUrl": "string",
      "status": "Status"
    }
  ],
  "nextPageToken": "string"
}

Field

Description

functions[]

Function

List of functions in the specified folder.

nextPageToken

string

Token for getting the next page of the list. If the number of results is greater than
the specified ListFunctionsRequest.pageSize, use nextPageToken as the value
for the ListFunctionsRequest.pageToken parameter in the next list request.

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

Function

A serverless function. For details about the concept, see Functions.

Field

Description

id

string

ID of the function. Generated at creation time.

folderId

string

ID of the folder that the function belongs to.

createdAt

google.protobuf.Timestamp

Creation timestamp for the function.

name

string

Name of the function. The name is unique within the folder.

description

string

Description of the function.

labels

string

Function labels as key:value pairs.

httpInvokeUrl

string

URL that needs to be requested to invoke the function.

status

enum Status

Status of the function.

  • STATUS_UNSPECIFIED
  • CREATING: Function is being created.
  • ACTIVE: Function is ready to be invoked.
  • DELETING: Function is being deleted.
  • ERROR: Function failed.
Предыдущая
Get
Следующая
Create