Подключиться
Yandex Cloud Functions

Cloud Functions Service, REST: Function.list

Статья создана

Retrieves the list of functions in the specified folder.

HTTP request

GET https://serverless-functions.api.cloud.yandex.net/functions/v1/functions

Query parameters

Parameter Description
folderId

Required. ID of the folder to list functions in.

To get a folder ID make a list request.
pageSize

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

Default value: 100.
pageToken

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

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".

Response

HTTP Code: 200 - OK

{
  "functions": [
    {
      "id": "string",
      "folderId": "string",
      "createdAt": "string",
      "name": "string",
      "description": "string",
      "labels": "object",
      "logGroupId": "string",
      "httpInvokeUrl": "string",
      "status": "string"
    }
  ],
  "nextPageToken": "string"
}
Field Description
functions[] object

List of functions in the specified folder.
functions[].
id		 string

ID of the function. Generated at creation time.
functions[].
folderId		 string

ID of the folder that the function belongs to.
functions[].
createdAt		 string (date-time)

Creation timestamp for the function.

String in RFC3339 text format. The range of possible values is from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z, i.e. from 0 to 9 digits for fractions of a second.

To work with values in this field, use the APIs described in the Protocol Buffers reference. In some languages, built-in datetime utilities do not support nanosecond precision (9 digits).
functions[].
name		 string

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

The string length in characters must be 3-63.
functions[].
description		 string

Description of the function.

The string length in characters must be 0-256.
functions[].
labels		 object

Function labels as key:value pairs.

No more than 64 per resource.
functions[].
logGroupId		 string

ID of the log group for the function.
functions[].
httpInvokeUrl		 string

URL that needs to be requested to invoke the function.
functions[].
status		 string

Status of the function.

  • CREATING: Function is being created.
  • ACTIVE: Function is ready to be invoked.
  • DELETING: Function is being deleted.
  • ERROR: Function failed.
nextPageToken string

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

Each subsequent page will have its own nextPageToken to continue paging through the results.
В этой статье: