Yandex Cloud
  • Сервисы
  • Решения
  • Почему Yandex Cloud
  • Сообщество
  • Тарифы
  • Документация
  • Связаться с нами
Подключиться
Language / Region
Проект Яндекса
© 2023 ООО «Яндекс.Облако»
Yandex Cloud Functions
  • Сопоставление с другими сервисами Yandex Cloud
  • Начало работы
    • Обзор
    • Создание функции
      • Обзор
      • Node.js
      • Python
      • Go
      • PHP
      • Bash
      • Java
  • Пошаговые инструкции
    • Все инструкции
    • Получение IAM-токена сервисного аккаунта с помощью функции
    • Подключение к управляемым БД из функции
    • Получение информации о функции
      • Получить список функций
      • Получить список версий функции
      • Получить информацию о функции
      • Получить информацию о версии функции
    • Управление правами доступа к функции
      • Сделать функцию публичной
      • Сделать функцию приватной
      • Посмотреть роли, назначенные на функцию
      • Назначить роли на функцию
      • Отозвать роли, назначенные на функцию
    • Создание функции
      • Создать функцию
      • Создать версию функции
    • Вызов функции
      • Вызвать функцию
      • Аутентифицироваться при вызове приватной функции через HTTPS
    • Управление функцией
      • Изменить функцию
        • Изменить имя
        • Изменить описание
      • Масштабировать функцию
        • Посмотреть настройки масштабирования
        • Добавить настройки масштабирования
        • Удалить настройки масштабирования
      • Добавить переменные окружения
      • Указать облачную сеть
      • Передать секреты Yandex Lockbox
      • Управлять тегами
        • Добавить тег
        • Удалить тег
      • Управлять метками
        • Добавить метку
        • Изменить метку
        • Удалить метку
      • Посмотреть графики мониторинга
      • Управлять логами
        • Посмотреть логи
        • Записать логи
      • Удалить функцию
    • Получение информации о триггере
      • Получить список триггеров
      • Получить информацию о триггере
    • Создание триггера
      • Создать таймер
      • Создать триггер для Message Queue
      • Создать триггер для Object Storage
      • Создать триггер для Container Registry
      • Создать триггер для Cloud Logs
      • Создать триггер для Cloud Logging
      • Создать триггер для Yandex IoT Core
      • Создать триггер для бюджетов
      • Создать триггер для Data Streams
      • Создать триггер для почты
    • Управление триггером
      • Изменить триггер
        • Изменить имя
        • Изменить описание
      • Управлять метками
        • Добавить метку
        • Изменить метку
        • Удалить метку
      • Посмотреть графики мониторинга
      • Удалить триггер
  • Концепции
    • Обзор
    • Функция
    • Вызов функции
    • Сетевое взаимодействие
    • Среда выполнения
      • Обзор
      • Окружение
      • Контекст выполнения
      • Предзагружаемая среда выполнения
    • Сборщик
    • Триггер
      • Обзор
      • Таймер
      • Триггер для Message Queue
      • Триггер для Object Storage
      • Триггер для Container Registry
      • Триггер для Cloud Logs
      • Триггер для Cloud Logging
      • Триггер для Yandex IoT Core
      • Триггер для бюджетов
      • Триггер для Data Streams
      • Триггер для почты
    • Dead Letter Queue
    • Логи функции
    • Резервное копирование
    • Квоты и лимиты
  • Разработка на Node.js
    • Обзор
    • Управление зависимостями
    • Обработчик запросов
    • Контекст вызова
    • Журналирование
    • Обработка ошибок
    • Использование SDK
  • Разработка на Python
    • Обзор
    • Управление зависимостями
    • Обработчик запросов
    • Контекст вызова
    • Журналирование
    • Обработка ошибок
    • Использование SDK
  • Разработка на Go
    • Обзор
    • Управление зависимостями
    • Обработчик запросов
    • Контекст вызова
    • Журналирование
    • Обработка ошибок
    • Использование SDK
  • Разработка на PHP
    • Обзор
    • Управление зависимостями
    • Обработчик запросов
    • Контекст вызова
    • Журналирование
    • Обработка ошибок
  • Разработка на Bash
    • Обзор
    • Обработчик запросов
    • Журналирование
    • Обработка ошибок
    • Использование SDK
  • Разработка на Java
    • Обзор
    • Модель программирования
      • Обзор
      • Интерфейс Function
      • Интерфейс YcFunction
      • Класс HttpServlet
      • Spring Boot
    • Управление зависимостями
    • Обработчик запросов
    • Контекст вызова
    • Журналирование
    • Обработка ошибок
    • Использование SDK
  • Разработка на R
    • Обзор
    • Модель программирования
    • Управление зависимостями
    • Обработчик запросов
    • Контекст вызова
    • Журналирование
    • Обработка ошибок
  • Разработка на C#
    • Обзор
    • Модель программирования
      • Обзор
      • Интерфейс Function
      • Интерфейс YcFunction
    • Управление зависимостями
    • Обработчик запросов
    • Контекст вызова
    • Журналирование
    • Обработка ошибок
    • Использование SDK
  • Практические руководства
    • Все практические руководства
    • Создание навыка Алисы
    • Развертывание веб-приложения
    • Разработка навыка Алисы и сайта с авторизацией
    • Запись данных с устройства в Managed Service for PostgreSQL
    • Разработка Slack-бота
    • Разработка Telegram-бота
    • Подключение к базе данных YDB из функции на Python
    • Подключение к базе данных YDB из функции на Node.js
    • Конвертация видео в GIF на Python
    • Создание функции Node.js с помощью TypeScript
    • Разработка пользовательской интеграции
    • Создание триггера для бюджетов, который вызывает функцию для остановки ВМ
  • Правила тарификации
  • Управление доступом
  • Справочник API Functions
    • Аутентификация в API
    • gRPC (англ.)
      • Overview
      • FunctionService
      • OperationService
    • REST (англ.)
      • Overview
      • Function
        • Overview
        • create
        • createVersion
        • delete
        • get
        • getVersion
        • getVersionByTag
        • list
        • listAccessBindings
        • listOperations
        • listRuntimes
        • listScalingPolicies
        • listTagHistory
        • listVersions
        • removeScalingPolicy
        • removeTag
        • setAccessBindings
        • setScalingPolicy
        • setTag
        • update
        • updateAccessBindings
  • Справочник API Triggers
    • Аутентификация в API
    • gRPC (англ.)
      • Overview
      • TriggerService
      • OperationService
    • REST (англ.)
      • Overview
      • Trigger
        • Overview
        • create
        • delete
        • get
        • list
        • listOperations
        • pause
        • resume
        • update
  • Вопросы и ответы
  1. Справочник API Functions
  2. gRPC (англ.)
  3. FunctionService

Cloud Functions Service, gRPC: FunctionService

Статья создана
Yandex Cloud
  • Calls FunctionService
  • Get
    • GetFunctionRequest
    • Function
  • List
    • ListFunctionsRequest
    • ListFunctionsResponse
    • Function
  • Create
    • CreateFunctionRequest
    • Operation
    • CreateFunctionMetadata
    • Function
  • Update
    • UpdateFunctionRequest
    • Operation
    • UpdateFunctionMetadata
    • Function
  • Delete
    • DeleteFunctionRequest
    • Operation
    • DeleteFunctionMetadata
  • GetVersion
    • GetFunctionVersionRequest
    • Version
    • Resources
    • Connectivity
    • Secret
    • LogOptions
  • GetFunctionVersion
    • GetFunctionVersionRequest
    • Version
    • Resources
    • Connectivity
    • Secret
    • LogOptions
  • GetVersionByTag
    • GetFunctionVersionByTagRequest
    • Version
    • Resources
    • Connectivity
    • Secret
    • LogOptions
  • GetFunctionVersionByTag
    • GetFunctionVersionByTagRequest
    • Version
    • Resources
    • Connectivity
    • Secret
    • LogOptions
  • ListVersions
    • ListFunctionsVersionsRequest
    • ListFunctionsVersionsResponse
    • Version
    • Resources
    • Connectivity
    • Secret
    • LogOptions
  • ListFunctionVersions
    • ListFunctionsVersionsRequest
    • ListFunctionsVersionsResponse
    • Version
    • Resources
    • Connectivity
    • Secret
    • LogOptions
  • SetTag
    • SetFunctionTagRequest
    • Operation
    • SetFunctionTagMetadata
    • Version
    • Resources
    • Connectivity
    • Secret
    • LogOptions
  • RemoveTag
    • RemoveFunctionTagRequest
    • Operation
    • RemoveFunctionTagMetadata
    • Version
    • Resources
    • Connectivity
    • Secret
    • LogOptions
  • ListTagHistory
    • ListFunctionTagHistoryRequest
    • ListFunctionTagHistoryResponse
    • FunctionTagHistoryRecord
  • ListFunctionTagHistory
    • ListFunctionTagHistoryRequest
    • ListFunctionTagHistoryResponse
    • FunctionTagHistoryRecord
  • CreateVersion
    • CreateFunctionVersionRequest
    • Resources
    • Package
    • Connectivity
    • Secret
    • LogOptions
    • Operation
    • CreateFunctionVersionMetadata
    • Version
  • CreateFunctionVersion
    • CreateFunctionVersionRequest
    • Resources
    • Package
    • Connectivity
    • Secret
    • LogOptions
    • Operation
    • CreateFunctionVersionMetadata
    • Version
  • ListRuntimes
    • ListRuntimesRequest
    • ListRuntimesResponse
  • ListOperations
    • ListFunctionOperationsRequest
    • ListFunctionOperationsResponse
    • Operation
  • ListAccessBindings
    • ListAccessBindingsRequest
    • ListAccessBindingsResponse
    • AccessBinding
    • Subject
  • SetAccessBindings
    • SetAccessBindingsRequest
    • AccessBinding
    • Subject
    • Operation
    • SetAccessBindingsMetadata
  • UpdateAccessBindings
    • UpdateAccessBindingsRequest
    • AccessBindingDelta
    • AccessBinding
    • Subject
    • Operation
    • UpdateAccessBindingsMetadata
  • ListScalingPolicies
    • ListScalingPoliciesRequest
    • ListScalingPoliciesResponse
    • ScalingPolicy
  • SetScalingPolicy
    • SetScalingPolicyRequest
    • Operation
    • SetScalingPolicyMetadata
    • ScalingPolicy
  • RemoveScalingPolicy
    • RemoveScalingPolicyRequest
    • Operation
    • RemoveScalingPolicyMetadata

A set of methods for managing serverless functions.

Call Description
Get Returns the specified function.
List Retrieves the list of functions in the specified folder.
Create Creates a function in the specified folder.
Update Updates the specified function.
Delete Deletes the specified function.
GetVersion Returns the specified version of a function.
GetFunctionVersion Deprecated.
GetVersionByTag Returns all versions with the specified tag.
GetFunctionVersionByTag Deprecated.
ListVersions Retrieves the list of versions for the specified function, or of all function versions in the specified folder.
ListFunctionVersions Deprecated.
SetTag Set a tag for the specified version of a function.
RemoveTag Remove a tag from the specified version of a function.
ListTagHistory Returns the log of tags assigned to versions of the specified function.
ListFunctionTagHistory Deprecated.
CreateVersion Creates a version for the specified function.
CreateFunctionVersion Deprecated.
ListRuntimes Lists available runtime environments for the specified function.
ListOperations Lists operations for the specified function.
ListAccessBindings Lists existing access bindings for the specified function.
SetAccessBindings Sets access bindings for the function.
UpdateAccessBindings Updates access bindings for the specified function.
ListScalingPolicies Lists existing scaling policies for specified function
SetScalingPolicy Set scaling policy for specified function and tag
RemoveScalingPolicy Remove scaling policy for specified function and tag

Calls FunctionService

Get

Returns the specified function.
To get the list of all available functions, make a List request.

rpc Get (GetFunctionRequest) returns (Function)

GetFunctionRequest

Field Description
function_id string
Required. ID of the function to return.
To get a function ID make a FunctionService.List request.

Function

Field Description
id string
ID of the function. Generated at creation time.
folder_id string
ID of the folder that the function belongs to.
created_at google.protobuf.Timestamp
Creation timestamp for the function.
name string
Name of the function. The name is unique within the folder. The string length in characters must be 3-63.
description string
Description of the function. The string length in characters must be 0-256.
labels map<string,string>
Function labels as key:value pairs. No more than 64 per resource.
log_group_id string
ID of the log group for the function.
http_invoke_url string
URL that needs to be requested to invoke the function.
status enum Status
Status of the function.
  • CREATING: Function is being created.
  • ACTIVE: Function is ready to be invoked.
  • DELETING: Function is being deleted.
  • ERROR: Function failed.

List

Retrieves the list of functions in the specified folder.

rpc List (ListFunctionsRequest) returns (ListFunctionsResponse)

ListFunctionsRequest

Field Description
folder_id string
Required. ID of the folder to list functions in.
To get a folder ID make a yandex.cloud.resourcemanager.v1.FolderService.List request.
page_size 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.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 ListFunctionsResponse.next_page_token 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

Field Description
functions[] Function
List of functions in the specified folder.
next_page_token string
Token for getting the next page of the list. If the number of results is greater than the specified ListFunctionsRequest.page_size, use nextPageToken as the value for the ListFunctionsRequest.page_token parameter in the next list request.
Each subsequent page will have its own nextPageToken to continue paging through the results.

Function

Field Description
id string
ID of the function. Generated at creation time.
folder_id string
ID of the folder that the function belongs to.
created_at google.protobuf.Timestamp
Creation timestamp for the function.
name string
Name of the function. The name is unique within the folder. The string length in characters must be 3-63.
description string
Description of the function. The string length in characters must be 0-256.
labels map<string,string>
Function labels as key:value pairs. No more than 64 per resource.
log_group_id string
ID of the log group for the function.
http_invoke_url string
URL that needs to be requested to invoke the function.
status enum Status
Status of the function.
  • CREATING: Function is being created.
  • ACTIVE: Function is ready to be invoked.
  • DELETING: Function is being deleted.
  • ERROR: Function failed.

Create

Creates a function in the specified folder.

rpc Create (CreateFunctionRequest) returns (operation.Operation)

Metadata and response of Operation:

    Operation.metadata:CreateFunctionMetadata

    Operation.response:Function

CreateFunctionRequest

Field Description
folder_id string
Required. ID of the folder to create a function in.
To get a folder ID make a yandex.cloud.resourcemanager.v1.FolderService.List request.
name string
Name of the function. The name must be unique within the folder. Value must match the regular expression |[a-z][-a-z0-9]{1,61}[a-z0-9].
description string
Description of the function. The maximum string length in characters is 256.
labels map<string,string>
Resource labels as key:value pairs. No more than 64 per resource. The maximum string length in characters for each value is 63. Each value must match the regular expression [-_0-9a-z]*. The string length in characters for each key must be 1-63. Each key must match the regular expression [a-z][-_0-9a-z]*.

Operation

Field Description
id string
ID of the operation.
description string
Description of the operation. 0-256 characters long.
created_at google.protobuf.Timestamp
Creation timestamp.
created_by string
ID of the user or service account who initiated the operation.
modified_at google.protobuf.Timestamp
The time when the Operation resource was last modified.
done bool
If the value is false, it means the operation is still in progress. If true, the operation is completed, and either error or response is available.
metadata google.protobuf.Any<CreateFunctionMetadata>
Service-specific metadata associated with the operation. It typically contains the ID of the target resource that the operation is performed on. Any method that returns a long-running operation should document the metadata type, if any.
result oneof: error or response
The operation result. If done == false and there was no failure detected, neither error nor response is set. If done == false and there was a failure detected, error is set. If done == true, exactly one of error or response is set.
  error google.rpc.Status
The error result of the operation in case of failure or cancellation.
  response google.protobuf.Any<Function>
if operation finished successfully.

CreateFunctionMetadata

Field Description
function_id string
ID of the function that is being created.

Function

Field Description
id string
ID of the function. Generated at creation time.
folder_id string
ID of the folder that the function belongs to.
created_at google.protobuf.Timestamp
Creation timestamp for the function.
name string
Name of the function. The name is unique within the folder. The string length in characters must be 3-63.
description string
Description of the function. The string length in characters must be 0-256.
labels map<string,string>
Function labels as key:value pairs. No more than 64 per resource.
log_group_id string
ID of the log group for the function.
http_invoke_url string
URL that needs to be requested to invoke the function.
status enum Status
Status of the function.
  • CREATING: Function is being created.
  • ACTIVE: Function is ready to be invoked.
  • DELETING: Function is being deleted.
  • ERROR: Function failed.

Update

Updates the specified function.

rpc Update (UpdateFunctionRequest) returns (operation.Operation)

Metadata and response of Operation:

    Operation.metadata:UpdateFunctionMetadata

    Operation.response:Function

UpdateFunctionRequest

Field Description
function_id string
Required. ID of the function to update.
To get a function ID make a FunctionService.List request.
update_mask google.protobuf.FieldMask
Field mask that specifies which attributes of the function should be updated.
name string
New name for the function. The name must be unique within the folder. Value must match the regular expression |[a-z][-a-z0-9]{1,61}[a-z0-9].
description string
New description for the function. The maximum string length in characters is 256.
labels map<string,string>
Function labels as key:value pairs.
Existing set of labels is completely replaced by the provided set, so if you just want to add or remove a label, request the current set of labels with a FunctionService.Get request. No more than 64 per resource. The maximum string length in characters for each value is 63. Each value must match the regular expression [-_0-9a-z]*. The string length in characters for each key must be 1-63. Each key must match the regular expression [a-z][-_0-9a-z]*.

Operation

Field Description
id string
ID of the operation.
description string
Description of the operation. 0-256 characters long.
created_at google.protobuf.Timestamp
Creation timestamp.
created_by string
ID of the user or service account who initiated the operation.
modified_at google.protobuf.Timestamp
The time when the Operation resource was last modified.
done bool
If the value is false, it means the operation is still in progress. If true, the operation is completed, and either error or response is available.
metadata google.protobuf.Any<UpdateFunctionMetadata>
Service-specific metadata associated with the operation. It typically contains the ID of the target resource that the operation is performed on. Any method that returns a long-running operation should document the metadata type, if any.
result oneof: error or response
The operation result. If done == false and there was no failure detected, neither error nor response is set. If done == false and there was a failure detected, error is set. If done == true, exactly one of error or response is set.
  error google.rpc.Status
The error result of the operation in case of failure or cancellation.
  response google.protobuf.Any<Function>
if operation finished successfully.

UpdateFunctionMetadata

Field Description
function_id string
ID of the function that is being updated.

Function

Field Description
id string
ID of the function. Generated at creation time.
folder_id string
ID of the folder that the function belongs to.
created_at google.protobuf.Timestamp
Creation timestamp for the function.
name string
Name of the function. The name is unique within the folder. The string length in characters must be 3-63.
description string
Description of the function. The string length in characters must be 0-256.
labels map<string,string>
Function labels as key:value pairs. No more than 64 per resource.
log_group_id string
ID of the log group for the function.
http_invoke_url string
URL that needs to be requested to invoke the function.
status enum Status
Status of the function.
  • CREATING: Function is being created.
  • ACTIVE: Function is ready to be invoked.
  • DELETING: Function is being deleted.
  • ERROR: Function failed.

Delete

Deletes the specified function.

rpc Delete (DeleteFunctionRequest) returns (operation.Operation)

Metadata and response of Operation:

    Operation.metadata:DeleteFunctionMetadata

    Operation.response:google.protobuf.Empty

DeleteFunctionRequest

Field Description
function_id string
Required. ID of the function to delete. To get a function ID make a FunctionService.List request.

Operation

Field Description
id string
ID of the operation.
description string
Description of the operation. 0-256 characters long.
created_at google.protobuf.Timestamp
Creation timestamp.
created_by string
ID of the user or service account who initiated the operation.
modified_at google.protobuf.Timestamp
The time when the Operation resource was last modified.
done bool
If the value is false, it means the operation is still in progress. If true, the operation is completed, and either error or response is available.
metadata google.protobuf.Any<DeleteFunctionMetadata>
Service-specific metadata associated with the operation. It typically contains the ID of the target resource that the operation is performed on. Any method that returns a long-running operation should document the metadata type, if any.
result oneof: error or response
The operation result. If done == false and there was no failure detected, neither error nor response is set. If done == false and there was a failure detected, error is set. If done == true, exactly one of error or response is set.
  error google.rpc.Status
The error result of the operation in case of failure or cancellation.
  response google.protobuf.Any<google.protobuf.Empty>
if operation finished successfully.

DeleteFunctionMetadata

Field Description
function_id string
ID of the function that is being deleted.

GetVersion

Returns the specified version of a function.
To get the list of available version, make a ListVersions request.

rpc GetVersion (GetFunctionVersionRequest) returns (Version)

GetFunctionVersionRequest

Field Description
function_version_id string
Required. ID of the version to return.
To get a version ID make a FunctionService.ListVersions request.

Version

Field Description
id string
ID of the version.
function_id string
ID of the function that the version belongs to.
description string
Description of the version. The string length in characters must be 0-256.
created_at google.protobuf.Timestamp
Creation timestamp for the version.
runtime string
ID of the runtime environment for the function.
Supported environments and their identifiers are listed in the Runtime environments.
entrypoint string
Entrypoint for the function: the name of the function to be called as the handler.
Specified in the format <function file name>.<handler name>, for example, index.myFunction.
resources Resources
Resources allocated to the version.
execution_timeout google.protobuf.Duration
Timeout for the execution of the version.
If the timeout is exceeded, Cloud Functions responds with a 504 HTTP code.
service_account_id string
ID of the service account associated with the version.
image_size int64
Final size of the deployment package after unpacking.
status enum Status
Status of the version.
  • CREATING: Version is being created.
  • ACTIVE: Version is ready to use.
tags[] string
Version tags. For details, see Version tag.
log_group_id string
ID of the log group for the version.
environment map<string,string>
Environment settings for the version.
connectivity Connectivity
Network access. If specified the version will be attached to specified network/subnet(s).
named_service_accounts map<string,string>
Additional service accounts to be used by the version.
secrets[] Secret
Yandex Lockbox secrets to be used by the version.
log_options LogOptions
Options for logging from the function

Resources

Field Description
memory int64
Amount of memory available to the version, specified in bytes. Acceptable values are 134217728 to 4294967296, inclusive.

Connectivity

Field Description
network_id string
Network the version will have access to. It's essential to specify network with subnets in all availability zones.
subnet_id[] string
Complete list of subnets (from the same network) the version can be attached to. It's essential to specify at least one subnet for each availability zones.

Secret

Field Description
id string
ID of Yandex Lockbox secret.
version_id string
ID of Yandex Lockbox version.
key string
Key in secret's payload, which value to be delivered into function environment.
reference oneof: environment_variable
  environment_variable string
environment variable in which secret's value to be delivered.

LogOptions

Field Description
disabled bool
Is logging from function disabled.
destination oneof: log_group_id or folder_id
Log entries destination.
  log_group_id string
Entry should be written to log group resolved by ID. Value must match the regular expression ([a-zA-Z][-a-zA-Z0-9_.]{0,63})?.
  folder_id string
Entry should be written to default log group for specified folder. Value must match the regular expression ([a-zA-Z][-a-zA-Z0-9_.]{0,63})?.
min_level yandex.cloud.logging.v1.LogLevel.Level
Minimum log entry level.
See [LogLevel.Level] for details.

GetFunctionVersion

Deprecated. Use GetVersion.

rpc GetFunctionVersion (GetFunctionVersionRequest) returns (Version)

GetFunctionVersionRequest

Field Description
function_version_id string
Required. ID of the version to return.
To get a version ID make a FunctionService.ListVersions request.

Version

Field Description
id string
ID of the version.
function_id string
ID of the function that the version belongs to.
description string
Description of the version. The string length in characters must be 0-256.
created_at google.protobuf.Timestamp
Creation timestamp for the version.
runtime string
ID of the runtime environment for the function.
Supported environments and their identifiers are listed in the Runtime environments.
entrypoint string
Entrypoint for the function: the name of the function to be called as the handler.
Specified in the format <function file name>.<handler name>, for example, index.myFunction.
resources Resources
Resources allocated to the version.
execution_timeout google.protobuf.Duration
Timeout for the execution of the version.
If the timeout is exceeded, Cloud Functions responds with a 504 HTTP code.
service_account_id string
ID of the service account associated with the version.
image_size int64
Final size of the deployment package after unpacking.
status enum Status
Status of the version.
  • CREATING: Version is being created.
  • ACTIVE: Version is ready to use.
tags[] string
Version tags. For details, see Version tag.
log_group_id string
ID of the log group for the version.
environment map<string,string>
Environment settings for the version.
connectivity Connectivity
Network access. If specified the version will be attached to specified network/subnet(s).
named_service_accounts map<string,string>
Additional service accounts to be used by the version.
secrets[] Secret
Yandex Lockbox secrets to be used by the version.
log_options LogOptions
Options for logging from the function

Resources

Field Description
memory int64
Amount of memory available to the version, specified in bytes. Acceptable values are 134217728 to 4294967296, inclusive.

Connectivity

Field Description
network_id string
Network the version will have access to. It's essential to specify network with subnets in all availability zones.
subnet_id[] string
Complete list of subnets (from the same network) the version can be attached to. It's essential to specify at least one subnet for each availability zones.

Secret

Field Description
id string
ID of Yandex Lockbox secret.
version_id string
ID of Yandex Lockbox version.
key string
Key in secret's payload, which value to be delivered into function environment.
reference oneof: environment_variable
  environment_variable string
environment variable in which secret's value to be delivered.

LogOptions

Field Description
disabled bool
Is logging from function disabled.
destination oneof: log_group_id or folder_id
Log entries destination.
  log_group_id string
Entry should be written to log group resolved by ID. Value must match the regular expression ([a-zA-Z][-a-zA-Z0-9_.]{0,63})?.
  folder_id string
Entry should be written to default log group for specified folder. Value must match the regular expression ([a-zA-Z][-a-zA-Z0-9_.]{0,63})?.
min_level yandex.cloud.logging.v1.LogLevel.Level
Minimum log entry level.
See [LogLevel.Level] for details.

GetVersionByTag

Returns all versions with the specified tag.
To get the list of all available versions, make a ListVersions request.

rpc GetVersionByTag (GetFunctionVersionByTagRequest) returns (Version)

GetFunctionVersionByTagRequest

Field Description
function_id string
Required. ID of the function whose versions should be listed.
To get a function ID use a FunctionService.List request.
tag string
Version tag.
To get the history of version tags make a FunctionService.ListTagHistory request. Value must match the regular expression [a-z][-_0-9a-z]*|[$]latest.

Version

Field Description
id string
ID of the version.
function_id string
ID of the function that the version belongs to.
description string
Description of the version. The string length in characters must be 0-256.
created_at google.protobuf.Timestamp
Creation timestamp for the version.
runtime string
ID of the runtime environment for the function.
Supported environments and their identifiers are listed in the Runtime environments.
entrypoint string
Entrypoint for the function: the name of the function to be called as the handler.
Specified in the format <function file name>.<handler name>, for example, index.myFunction.
resources Resources
Resources allocated to the version.
execution_timeout google.protobuf.Duration
Timeout for the execution of the version.
If the timeout is exceeded, Cloud Functions responds with a 504 HTTP code.
service_account_id string
ID of the service account associated with the version.
image_size int64
Final size of the deployment package after unpacking.
status enum Status
Status of the version.
  • CREATING: Version is being created.
  • ACTIVE: Version is ready to use.
tags[] string
Version tags. For details, see Version tag.
log_group_id string
ID of the log group for the version.
environment map<string,string>
Environment settings for the version.
connectivity Connectivity
Network access. If specified the version will be attached to specified network/subnet(s).
named_service_accounts map<string,string>
Additional service accounts to be used by the version.
secrets[] Secret
Yandex Lockbox secrets to be used by the version.
log_options LogOptions
Options for logging from the function

Resources

Field Description
memory int64
Amount of memory available to the version, specified in bytes. Acceptable values are 134217728 to 4294967296, inclusive.

Connectivity

Field Description
network_id string
Network the version will have access to. It's essential to specify network with subnets in all availability zones.
subnet_id[] string
Complete list of subnets (from the same network) the version can be attached to. It's essential to specify at least one subnet for each availability zones.

Secret

Field Description
id string
ID of Yandex Lockbox secret.
version_id string
ID of Yandex Lockbox version.
key string
Key in secret's payload, which value to be delivered into function environment.
reference oneof: environment_variable
  environment_variable string
environment variable in which secret's value to be delivered.

LogOptions

Field Description
disabled bool
Is logging from function disabled.
destination oneof: log_group_id or folder_id
Log entries destination.
  log_group_id string
Entry should be written to log group resolved by ID. Value must match the regular expression ([a-zA-Z][-a-zA-Z0-9_.]{0,63})?.
  folder_id string
Entry should be written to default log group for specified folder. Value must match the regular expression ([a-zA-Z][-a-zA-Z0-9_.]{0,63})?.
min_level yandex.cloud.logging.v1.LogLevel.Level
Minimum log entry level.
See [LogLevel.Level] for details.

GetFunctionVersionByTag

Deprecated. Use GetVersionByTag.

rpc GetFunctionVersionByTag (GetFunctionVersionByTagRequest) returns (Version)

GetFunctionVersionByTagRequest

Field Description
function_id string
Required. ID of the function whose versions should be listed.
To get a function ID use a FunctionService.List request.
tag string
Version tag.
To get the history of version tags make a FunctionService.ListTagHistory request. Value must match the regular expression [a-z][-_0-9a-z]*|[$]latest.

Version

Field Description
id string
ID of the version.
function_id string
ID of the function that the version belongs to.
description string
Description of the version. The string length in characters must be 0-256.
created_at google.protobuf.Timestamp
Creation timestamp for the version.
runtime string
ID of the runtime environment for the function.
Supported environments and their identifiers are listed in the Runtime environments.
entrypoint string
Entrypoint for the function: the name of the function to be called as the handler.
Specified in the format <function file name>.<handler name>, for example, index.myFunction.
resources Resources
Resources allocated to the version.
execution_timeout google.protobuf.Duration
Timeout for the execution of the version.
If the timeout is exceeded, Cloud Functions responds with a 504 HTTP code.
service_account_id string
ID of the service account associated with the version.
image_size int64
Final size of the deployment package after unpacking.
status enum Status
Status of the version.
  • CREATING: Version is being created.
  • ACTIVE: Version is ready to use.
tags[] string
Version tags. For details, see Version tag.
log_group_id string
ID of the log group for the version.
environment map<string,string>
Environment settings for the version.
connectivity Connectivity
Network access. If specified the version will be attached to specified network/subnet(s).
named_service_accounts map<string,string>
Additional service accounts to be used by the version.
secrets[] Secret
Yandex Lockbox secrets to be used by the version.
log_options LogOptions
Options for logging from the function

Resources

Field Description
memory int64
Amount of memory available to the version, specified in bytes. Acceptable values are 134217728 to 4294967296, inclusive.

Connectivity

Field Description
network_id string
Network the version will have access to. It's essential to specify network with subnets in all availability zones.
subnet_id[] string
Complete list of subnets (from the same network) the version can be attached to. It's essential to specify at least one subnet for each availability zones.

Secret

Field Description
id string
ID of Yandex Lockbox secret.
version_id string
ID of Yandex Lockbox version.
key string
Key in secret's payload, which value to be delivered into function environment.
reference oneof: environment_variable
  environment_variable string
environment variable in which secret's value to be delivered.

LogOptions

Field Description
disabled bool
Is logging from function disabled.
destination oneof: log_group_id or folder_id
Log entries destination.
  log_group_id string
Entry should be written to log group resolved by ID. Value must match the regular expression ([a-zA-Z][-a-zA-Z0-9_.]{0,63})?.
  folder_id string
Entry should be written to default log group for specified folder. Value must match the regular expression ([a-zA-Z][-a-zA-Z0-9_.]{0,63})?.
min_level yandex.cloud.logging.v1.LogLevel.Level
Minimum log entry level.
See [LogLevel.Level] for details.

ListVersions

Retrieves the list of versions for the specified function, or of all function versions in the specified folder.

rpc ListVersions (ListFunctionsVersionsRequest) returns (ListFunctionsVersionsResponse)

ListFunctionsVersionsRequest

Field Description
id oneof: folder_id or function_id
  folder_id string
ID of the folder to list function versions for. To get a folder ID make a yandex.cloud.resourcemanager.v1.FolderService.List request.
  function_id string
ID of the function to list versions for. To get a function ID use a FunctionService.List request.
page_size int64
The maximum number of results per page to return. If the number of available results is larger than pageSize, the service returns a ListFunctionsVersionsResponse.next_page_token that can be used to get the next page of results in subsequent list requests.
Default value: 100. Acceptable values are 0 to 1000, inclusive.
page_token string
Page token. To get the next page of results, set pageToken to the ListFunctionsVersionsResponse.next_page_token returned by a previous list request. The maximum string length in characters is 100.
filter string
A filter expression that filters resources listed in the response.
The expression must specify:
  1. The field name. Currently filtering can only be applied to the Version.status and Version.runtime fields.
  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: status="ACTIVE". The maximum string length in characters is 1000.

ListFunctionsVersionsResponse

Field Description
versions[] Version
List of versions for the specified folder or function.
next_page_token string
Token for getting the next page of the list. If the number of results is greater than the specified ListFunctionsVersionsRequest.page_size, use nextPageToken as the value for the ListFunctionsVersionsRequest.page_token parameter in the next list request.
Each subsequent page will have its own nextPageToken to continue paging through the results.

Version

Field Description
id string
ID of the version.
function_id string
ID of the function that the version belongs to.
description string
Description of the version. The string length in characters must be 0-256.
created_at google.protobuf.Timestamp
Creation timestamp for the version.
runtime string
ID of the runtime environment for the function.
Supported environments and their identifiers are listed in the Runtime environments.
entrypoint string
Entrypoint for the function: the name of the function to be called as the handler.
Specified in the format <function file name>.<handler name>, for example, index.myFunction.
resources Resources
Resources allocated to the version.
execution_timeout google.protobuf.Duration
Timeout for the execution of the version.
If the timeout is exceeded, Cloud Functions responds with a 504 HTTP code.
service_account_id string
ID of the service account associated with the version.
image_size int64
Final size of the deployment package after unpacking.
status enum Status
Status of the version.
  • CREATING: Version is being created.
  • ACTIVE: Version is ready to use.
tags[] string
Version tags. For details, see Version tag.
log_group_id string
ID of the log group for the version.
environment map<string,string>
Environment settings for the version.
connectivity Connectivity
Network access. If specified the version will be attached to specified network/subnet(s).
named_service_accounts map<string,string>
Additional service accounts to be used by the version.
secrets[] Secret
Yandex Lockbox secrets to be used by the version.
log_options LogOptions
Options for logging from the function

Resources

Field Description
memory int64
Amount of memory available to the version, specified in bytes. Acceptable values are 134217728 to 4294967296, inclusive.

Connectivity

Field Description
network_id string
Network the version will have access to. It's essential to specify network with subnets in all availability zones.
subnet_id[] string
Complete list of subnets (from the same network) the version can be attached to. It's essential to specify at least one subnet for each availability zones.

Secret

Field Description
id string
ID of Yandex Lockbox secret.
version_id string
ID of Yandex Lockbox version.
key string
Key in secret's payload, which value to be delivered into function environment.
reference oneof: environment_variable
  environment_variable string
environment variable in which secret's value to be delivered.

LogOptions

Field Description
disabled bool
Is logging from function disabled.
destination oneof: log_group_id or folder_id
Log entries destination.
  log_group_id string
Entry should be written to log group resolved by ID. Value must match the regular expression ([a-zA-Z][-a-zA-Z0-9_.]{0,63})?.
  folder_id string
Entry should be written to default log group for specified folder. Value must match the regular expression ([a-zA-Z][-a-zA-Z0-9_.]{0,63})?.
min_level yandex.cloud.logging.v1.LogLevel.Level
Minimum log entry level.
See [LogLevel.Level] for details.

ListFunctionVersions

Deprecated. Use ListVersions.

rpc ListFunctionVersions (ListFunctionsVersionsRequest) returns (ListFunctionsVersionsResponse)

ListFunctionsVersionsRequest

Field Description
id oneof: folder_id or function_id
  folder_id string
ID of the folder to list function versions for. To get a folder ID make a yandex.cloud.resourcemanager.v1.FolderService.List request.
  function_id string
ID of the function to list versions for. To get a function ID use a FunctionService.List request.
page_size int64
The maximum number of results per page to return. If the number of available results is larger than pageSize, the service returns a ListFunctionsVersionsResponse.next_page_token that can be used to get the next page of results in subsequent list requests.
Default value: 100. Acceptable values are 0 to 1000, inclusive.
page_token string
Page token. To get the next page of results, set pageToken to the ListFunctionsVersionsResponse.next_page_token returned by a previous list request. The maximum string length in characters is 100.
filter string
A filter expression that filters resources listed in the response.
The expression must specify:
  1. The field name. Currently filtering can only be applied to the Version.status and Version.runtime fields.
  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: status="ACTIVE". The maximum string length in characters is 1000.

ListFunctionsVersionsResponse

Field Description
versions[] Version
List of versions for the specified folder or function.
next_page_token string
Token for getting the next page of the list. If the number of results is greater than the specified ListFunctionsVersionsRequest.page_size, use nextPageToken as the value for the ListFunctionsVersionsRequest.page_token parameter in the next list request.
Each subsequent page will have its own nextPageToken to continue paging through the results.

Version

Field Description
id string
ID of the version.
function_id string
ID of the function that the version belongs to.
description string
Description of the version. The string length in characters must be 0-256.
created_at google.protobuf.Timestamp
Creation timestamp for the version.
runtime string
ID of the runtime environment for the function.
Supported environments and their identifiers are listed in the Runtime environments.
entrypoint string
Entrypoint for the function: the name of the function to be called as the handler.
Specified in the format <function file name>.<handler name>, for example, index.myFunction.
resources Resources
Resources allocated to the version.
execution_timeout google.protobuf.Duration
Timeout for the execution of the version.
If the timeout is exceeded, Cloud Functions responds with a 504 HTTP code.
service_account_id string
ID of the service account associated with the version.
image_size int64
Final size of the deployment package after unpacking.
status enum Status
Status of the version.
  • CREATING: Version is being created.
  • ACTIVE: Version is ready to use.
tags[] string
Version tags. For details, see Version tag.
log_group_id string
ID of the log group for the version.
environment map<string,string>
Environment settings for the version.
connectivity Connectivity
Network access. If specified the version will be attached to specified network/subnet(s).
named_service_accounts map<string,string>
Additional service accounts to be used by the version.
secrets[] Secret
Yandex Lockbox secrets to be used by the version.
log_options LogOptions
Options for logging from the function

Resources

Field Description
memory int64
Amount of memory available to the version, specified in bytes. Acceptable values are 134217728 to 4294967296, inclusive.

Connectivity

Field Description
network_id string
Network the version will have access to. It's essential to specify network with subnets in all availability zones.
subnet_id[] string
Complete list of subnets (from the same network) the version can be attached to. It's essential to specify at least one subnet for each availability zones.

Secret

Field Description
id string
ID of Yandex Lockbox secret.
version_id string
ID of Yandex Lockbox version.
key string
Key in secret's payload, which value to be delivered into function environment.
reference oneof: environment_variable
  environment_variable string
environment variable in which secret's value to be delivered.

LogOptions

Field Description
disabled bool
Is logging from function disabled.
destination oneof: log_group_id or folder_id
Log entries destination.
  log_group_id string
Entry should be written to log group resolved by ID. Value must match the regular expression ([a-zA-Z][-a-zA-Z0-9_.]{0,63})?.
  folder_id string
Entry should be written to default log group for specified folder. Value must match the regular expression ([a-zA-Z][-a-zA-Z0-9_.]{0,63})?.
min_level yandex.cloud.logging.v1.LogLevel.Level
Minimum log entry level.
See [LogLevel.Level] for details.

SetTag

Set a tag for the specified version of a function.

rpc SetTag (SetFunctionTagRequest) returns (operation.Operation)

Metadata and response of Operation:

    Operation.metadata:SetFunctionTagMetadata

    Operation.response:Version

SetFunctionTagRequest

Field Description
function_version_id string
Required. ID of the version to set the tag for.
To get a version ID make a FunctionService.ListVersions request.
tag string
Tag to set for the version. Value must match the regular expression [a-z][-_0-9a-z]*.

Operation

Field Description
id string
ID of the operation.
description string
Description of the operation. 0-256 characters long.
created_at google.protobuf.Timestamp
Creation timestamp.
created_by string
ID of the user or service account who initiated the operation.
modified_at google.protobuf.Timestamp
The time when the Operation resource was last modified.
done bool
If the value is false, it means the operation is still in progress. If true, the operation is completed, and either error or response is available.
metadata google.protobuf.Any<SetFunctionTagMetadata>
Service-specific metadata associated with the operation. It typically contains the ID of the target resource that the operation is performed on. Any method that returns a long-running operation should document the metadata type, if any.
result oneof: error or response
The operation result. If done == false and there was no failure detected, neither error nor response is set. If done == false and there was a failure detected, error is set. If done == true, exactly one of error or response is set.
  error google.rpc.Status
The error result of the operation in case of failure or cancellation.
  response google.protobuf.Any<Version>
if operation finished successfully.

SetFunctionTagMetadata

Field Description
function_version_id string
ID of the function versions that is being tagged.

Version

Field Description
id string
ID of the version.
function_id string
ID of the function that the version belongs to.
description string
Description of the version. The string length in characters must be 0-256.
created_at google.protobuf.Timestamp
Creation timestamp for the version.
runtime string
ID of the runtime environment for the function.
Supported environments and their identifiers are listed in the Runtime environments.
entrypoint string
Entrypoint for the function: the name of the function to be called as the handler.
Specified in the format <function file name>.<handler name>, for example, index.myFunction.
resources Resources
Resources allocated to the version.
execution_timeout google.protobuf.Duration
Timeout for the execution of the version.
If the timeout is exceeded, Cloud Functions responds with a 504 HTTP code.
service_account_id string
ID of the service account associated with the version.
image_size int64
Final size of the deployment package after unpacking.
status enum Status
Status of the version.
  • CREATING: Version is being created.
  • ACTIVE: Version is ready to use.
tags[] string
Version tags. For details, see Version tag.
log_group_id string
ID of the log group for the version.
environment map<string,string>
Environment settings for the version.
connectivity Connectivity
Network access. If specified the version will be attached to specified network/subnet(s).
named_service_accounts map<string,string>
Additional service accounts to be used by the version.
secrets[] Secret
Yandex Lockbox secrets to be used by the version.
log_options LogOptions
Options for logging from the function

Resources

Field Description
memory int64
Amount of memory available to the version, specified in bytes. Acceptable values are 134217728 to 4294967296, inclusive.

Connectivity

Field Description
network_id string
Network the version will have access to. It's essential to specify network with subnets in all availability zones.
subnet_id[] string
Complete list of subnets (from the same network) the version can be attached to. It's essential to specify at least one subnet for each availability zones.

Secret

Field Description
id string
ID of Yandex Lockbox secret.
version_id string
ID of Yandex Lockbox version.
key string
Key in secret's payload, which value to be delivered into function environment.
reference oneof: environment_variable
  environment_variable string
environment variable in which secret's value to be delivered.

LogOptions

Field Description
disabled bool
Is logging from function disabled.
destination oneof: log_group_id or folder_id
Log entries destination.
  log_group_id string
Entry should be written to log group resolved by ID. Value must match the regular expression ([a-zA-Z][-a-zA-Z0-9_.]{0,63})?.
  folder_id string
Entry should be written to default log group for specified folder. Value must match the regular expression ([a-zA-Z][-a-zA-Z0-9_.]{0,63})?.
min_level yandex.cloud.logging.v1.LogLevel.Level
Minimum log entry level.
See [LogLevel.Level] for details.

RemoveTag

Remove a tag from the specified version of a function.

rpc RemoveTag (RemoveFunctionTagRequest) returns (operation.Operation)

Metadata and response of Operation:

    Operation.metadata:RemoveFunctionTagMetadata

    Operation.response:Version

RemoveFunctionTagRequest

Field Description
function_version_id string
Required. ID of the version to remove a tag from.
To get the a version ID make a FunctionService.ListVersions request.
tag string
Tag to remove from the specified version. Value must match the regular expression [a-z][-_0-9a-z]*.

Operation

Field Description
id string
ID of the operation.
description string
Description of the operation. 0-256 characters long.
created_at google.protobuf.Timestamp
Creation timestamp.
created_by string
ID of the user or service account who initiated the operation.
modified_at google.protobuf.Timestamp
The time when the Operation resource was last modified.
done bool
If the value is false, it means the operation is still in progress. If true, the operation is completed, and either error or response is available.
metadata google.protobuf.Any<RemoveFunctionTagMetadata>
Service-specific metadata associated with the operation. It typically contains the ID of the target resource that the operation is performed on. Any method that returns a long-running operation should document the metadata type, if any.
result oneof: error or response
The operation result. If done == false and there was no failure detected, neither error nor response is set. If done == false and there was a failure detected, error is set. If done == true, exactly one of error or response is set.
  error google.rpc.Status
The error result of the operation in case of failure or cancellation.
  response google.protobuf.Any<Version>
if operation finished successfully.

RemoveFunctionTagMetadata

Field Description
function_version_id string
ID of the function versions that is being untagged.

Version

Field Description
id string
ID of the version.
function_id string
ID of the function that the version belongs to.
description string
Description of the version. The string length in characters must be 0-256.
created_at google.protobuf.Timestamp
Creation timestamp for the version.
runtime string
ID of the runtime environment for the function.
Supported environments and their identifiers are listed in the Runtime environments.
entrypoint string
Entrypoint for the function: the name of the function to be called as the handler.
Specified in the format <function file name>.<handler name>, for example, index.myFunction.
resources Resources
Resources allocated to the version.
execution_timeout google.protobuf.Duration
Timeout for the execution of the version.
If the timeout is exceeded, Cloud Functions responds with a 504 HTTP code.
service_account_id string
ID of the service account associated with the version.
image_size int64
Final size of the deployment package after unpacking.
status enum Status
Status of the version.
  • CREATING: Version is being created.
  • ACTIVE: Version is ready to use.
tags[] string
Version tags. For details, see Version tag.
log_group_id string
ID of the log group for the version.
environment map<string,string>
Environment settings for the version.
connectivity Connectivity
Network access. If specified the version will be attached to specified network/subnet(s).
named_service_accounts map<string,string>
Additional service accounts to be used by the version.
secrets[] Secret
Yandex Lockbox secrets to be used by the version.
log_options LogOptions
Options for logging from the function

Resources

Field Description
memory int64
Amount of memory available to the version, specified in bytes. Acceptable values are 134217728 to 4294967296, inclusive.

Connectivity

Field Description
network_id string
Network the version will have access to. It's essential to specify network with subnets in all availability zones.
subnet_id[] string
Complete list of subnets (from the same network) the version can be attached to. It's essential to specify at least one subnet for each availability zones.

Secret

Field Description
id string
ID of Yandex Lockbox secret.
version_id string
ID of Yandex Lockbox version.
key string
Key in secret's payload, which value to be delivered into function environment.
reference oneof: environment_variable
  environment_variable string
environment variable in which secret's value to be delivered.

LogOptions

Field Description
disabled bool
Is logging from function disabled.
destination oneof: log_group_id or folder_id
Log entries destination.
  log_group_id string
Entry should be written to log group resolved by ID. Value must match the regular expression ([a-zA-Z][-a-zA-Z0-9_.]{0,63})?.
  folder_id string
Entry should be written to default log group for specified folder. Value must match the regular expression ([a-zA-Z][-a-zA-Z0-9_.]{0,63})?.
min_level yandex.cloud.logging.v1.LogLevel.Level
Minimum log entry level.
See [LogLevel.Level] for details.

ListTagHistory

Returns the log of tags assigned to versions of the specified function.

rpc ListTagHistory (ListFunctionTagHistoryRequest) returns (ListFunctionTagHistoryResponse)

ListFunctionTagHistoryRequest

Field Description
function_id string
Required. ID of the function to retrieve tag history for.
To get a function ID, make a FunctionService.List request.
tag string
Specific tag that history should be limited to. Value must match the regular expression [a-z][-_0-9a-z]*|[$]latest.
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 ListFunctionOperationsResponse.next_page_token that can be used to get the next page of results in subsequent list requests. Default value: 100. Acceptable values are 0 to 1000, inclusive.
page_token string
Page token. To get the next page of results, set pageToken to the ListFunctionOperationsResponse.next_page_token returned by a previous list request. The maximum string length in characters is 100.
filter string
A filter expression that filters resources listed in the response.
The expression must specify:
  1. The field name. Currently filtering can only be applied to the [FunctionTagHistoryRecord.effective_from] and [FunctionTagHistoryRecord.effective_to] fields.
  2. An = or > or < 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].
For example, effective_to>2021-01-01T12:00:00Z. The maximum string length in characters is 1000.

ListFunctionTagHistoryResponse

Field Description
function_tag_history_record[] FunctionTagHistoryRecord
Set of relevant tag history records.
next_page_token string
Token for getting the next page of the list. If the number of results is greater than the specified ListFunctionTagHistoryRequest.page_size, use nextPageToken as the value for the ListFunctionTagHistoryRequest.page_token parameter in the next list request.
Each subsequent page will have its own nextPageToken to continue paging through the results.

FunctionTagHistoryRecord

Field Description
function_id string
ID of the function that the record is about.
function_version_id string
ID of the function version that the record is about.
tag string
Tag that was set for the version at some point.
effective_from google.protobuf.Timestamp
Timestamp when the tag started being active for the function.
effective_to google.protobuf.Timestamp
Timestamp when the tag stopped being active for the function.

ListFunctionTagHistory

Deprecated. Use ListTagHistory.

rpc ListFunctionTagHistory (ListFunctionTagHistoryRequest) returns (ListFunctionTagHistoryResponse)

ListFunctionTagHistoryRequest

Field Description
function_id string
Required. ID of the function to retrieve tag history for.
To get a function ID, make a FunctionService.List request.
tag string
Specific tag that history should be limited to. Value must match the regular expression [a-z][-_0-9a-z]*|[$]latest.
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 ListFunctionOperationsResponse.next_page_token that can be used to get the next page of results in subsequent list requests. Default value: 100. Acceptable values are 0 to 1000, inclusive.
page_token string
Page token. To get the next page of results, set pageToken to the ListFunctionOperationsResponse.next_page_token returned by a previous list request. The maximum string length in characters is 100.
filter string
A filter expression that filters resources listed in the response.
The expression must specify:
  1. The field name. Currently filtering can only be applied to the [FunctionTagHistoryRecord.effective_from] and [FunctionTagHistoryRecord.effective_to] fields.
  2. An = or > or < 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].
For example, effective_to>2021-01-01T12:00:00Z. The maximum string length in characters is 1000.

ListFunctionTagHistoryResponse

Field Description
function_tag_history_record[] FunctionTagHistoryRecord
Set of relevant tag history records.
next_page_token string
Token for getting the next page of the list. If the number of results is greater than the specified ListFunctionTagHistoryRequest.page_size, use nextPageToken as the value for the ListFunctionTagHistoryRequest.page_token parameter in the next list request.
Each subsequent page will have its own nextPageToken to continue paging through the results.

FunctionTagHistoryRecord

Field Description
function_id string
ID of the function that the record is about.
function_version_id string
ID of the function version that the record is about.
tag string
Tag that was set for the version at some point.
effective_from google.protobuf.Timestamp
Timestamp when the tag started being active for the function.
effective_to google.protobuf.Timestamp
Timestamp when the tag stopped being active for the function.

CreateVersion

Creates a version for the specified function.

rpc CreateVersion (CreateFunctionVersionRequest) returns (operation.Operation)

Metadata and response of Operation:

    Operation.metadata:CreateFunctionVersionMetadata

    Operation.response:Version

CreateFunctionVersionRequest

Field Description
function_id string
Required. ID of the function to create a version for.
To get a function ID, make a FunctionService.List request.
runtime string
Required. Runtime environment for the version.
description string
Description of the version The string length in characters must be 0-256.
entrypoint string
Required. Entrypoint of the version.
resources Resources
Required. Resources allocated to the version.
execution_timeout google.protobuf.Duration
Required. Timeout for the execution of the version.
If the timeout is exceeded, Cloud Functions responds with a 504 HTTP code.
service_account_id string
ID of the service account to associate with the version.
package_source oneof: package, content or version_id
Source of the deployment package for the version.
  package Package
Functions deployment package.
  content bytes
Content of the deployment package. The maximum string length in characters is 52428800.
  version_id string
ID of the version to be copied from. Source version must belong to the same folder as the created version and the user must have read permissions to the source version.
environment map<string,string>
Environment settings for the version. The maximum string length in characters for each value is 4096. Each key must match the regular expression [a-zA-Z][a-zA-Z0-9_]*.
tag[] string
Function version tags. For details, see Version tag. Each value must match the regular expression [a-z][-_0-9a-z]*.
connectivity Connectivity
Function version connectivity. If specified the version will be attached to specified network/subnet(s).
named_service_accounts map<string,string>
Additional service accounts to be used by the version.
secrets[] Secret
Yandex Lockbox secrets to be used by the version.
log_options LogOptions
Options for logging from the function

Resources

Field Description
memory int64
Amount of memory available to the version, specified in bytes. Acceptable values are 134217728 to 4294967296, inclusive.

Package

Field Description
bucket_name string
Required. Name of the bucket that stores the code for the version.
object_name string
Required. Name of the object in the bucket that stores the code for the version.
sha256 string
SHA256 hash of the version deployment package.

Connectivity

Field Description
network_id string
Network the version will have access to. It's essential to specify network with subnets in all availability zones.
subnet_id[] string
Complete list of subnets (from the same network) the version can be attached to. It's essential to specify at least one subnet for each availability zones.

Secret

Field Description
id string
ID of Yandex Lockbox secret.
version_id string
ID of Yandex Lockbox version.
key string
Key in secret's payload, which value to be delivered into function environment.
reference oneof: environment_variable
  environment_variable string
environment variable in which secret's value to be delivered.

LogOptions

Field Description
disabled bool
Is logging from function disabled.
destination oneof: log_group_id or folder_id
Log entries destination.
  log_group_id string
Entry should be written to log group resolved by ID. Value must match the regular expression ([a-zA-Z][-a-zA-Z0-9_.]{0,63})?.
  folder_id string
Entry should be written to default log group for specified folder. Value must match the regular expression ([a-zA-Z][-a-zA-Z0-9_.]{0,63})?.
min_level yandex.cloud.logging.v1.LogLevel.Level
Minimum log entry level.
See [LogLevel.Level] for details.

Operation

Field Description
id string
ID of the operation.
description string
Description of the operation. 0-256 characters long.
created_at google.protobuf.Timestamp
Creation timestamp.
created_by string
ID of the user or service account who initiated the operation.
modified_at google.protobuf.Timestamp
The time when the Operation resource was last modified.
done bool
If the value is false, it means the operation is still in progress. If true, the operation is completed, and either error or response is available.
metadata google.protobuf.Any<CreateFunctionVersionMetadata>
Service-specific metadata associated with the operation. It typically contains the ID of the target resource that the operation is performed on. Any method that returns a long-running operation should document the metadata type, if any.
result oneof: error or response
The operation result. If done == false and there was no failure detected, neither error nor response is set. If done == false and there was a failure detected, error is set. If done == true, exactly one of error or response is set.
  error google.rpc.Status
The error result of the operation in case of failure or cancellation.
  response google.protobuf.Any<Version>
if operation finished successfully.

CreateFunctionVersionMetadata

Field Description
function_version_id string
ID of the version that is being created.

Version

Field Description
id string
ID of the version.
function_id string
ID of the function that the version belongs to.
description string
Description of the version. The string length in characters must be 0-256.
created_at google.protobuf.Timestamp
Creation timestamp for the version.
runtime string
ID of the runtime environment for the function.
Supported environments and their identifiers are listed in the Runtime environments.
entrypoint string
Entrypoint for the function: the name of the function to be called as the handler.
Specified in the format <function file name>.<handler name>, for example, index.myFunction.
resources Resources
Resources allocated to the version.
execution_timeout google.protobuf.Duration
Timeout for the execution of the version.
If the timeout is exceeded, Cloud Functions responds with a 504 HTTP code.
service_account_id string
ID of the service account associated with the version.
image_size int64
Final size of the deployment package after unpacking.
status enum Status
Status of the version.
  • CREATING: Version is being created.
  • ACTIVE: Version is ready to use.
tags[] string
Version tags. For details, see Version tag.
log_group_id string
ID of the log group for the version.
environment map<string,string>
Environment settings for the version.
connectivity Connectivity
Network access. If specified the version will be attached to specified network/subnet(s).
named_service_accounts map<string,string>
Additional service accounts to be used by the version.
secrets[] Secret
Yandex Lockbox secrets to be used by the version.
log_options LogOptions
Options for logging from the function

CreateFunctionVersion

Deprecated. Use CreateVersion.

rpc CreateFunctionVersion (CreateFunctionVersionRequest) returns (operation.Operation)

Metadata and response of Operation:

    Operation.metadata:CreateFunctionVersionMetadata

    Operation.response:Version

CreateFunctionVersionRequest

Field Description
function_id string
Required. ID of the function to create a version for.
To get a function ID, make a FunctionService.List request.
runtime string
Required. Runtime environment for the version.
description string
Description of the version The string length in characters must be 0-256.
entrypoint string
Required. Entrypoint of the version.
resources Resources
Required. Resources allocated to the version.
execution_timeout google.protobuf.Duration
Required. Timeout for the execution of the version.
If the timeout is exceeded, Cloud Functions responds with a 504 HTTP code.
service_account_id string
ID of the service account to associate with the version.
package_source oneof: package, content or version_id
Source of the deployment package for the version.
  package Package
Functions deployment package.
  content bytes
Content of the deployment package. The maximum string length in characters is 52428800.
  version_id string
ID of the version to be copied from. Source version must belong to the same folder as the created version and the user must have read permissions to the source version.
environment map<string,string>
Environment settings for the version. The maximum string length in characters for each value is 4096. Each key must match the regular expression [a-zA-Z][a-zA-Z0-9_]*.
tag[] string
Function version tags. For details, see Version tag. Each value must match the regular expression [a-z][-_0-9a-z]*.
connectivity Connectivity
Function version connectivity. If specified the version will be attached to specified network/subnet(s).
named_service_accounts map<string,string>
Additional service accounts to be used by the version.
secrets[] Secret
Yandex Lockbox secrets to be used by the version.
log_options LogOptions
Options for logging from the function

Resources

Field Description
memory int64
Amount of memory available to the version, specified in bytes. Acceptable values are 134217728 to 4294967296, inclusive.

Package

Field Description
bucket_name string
Required. Name of the bucket that stores the code for the version.
object_name string
Required. Name of the object in the bucket that stores the code for the version.
sha256 string
SHA256 hash of the version deployment package.

Connectivity

Field Description
network_id string
Network the version will have access to. It's essential to specify network with subnets in all availability zones.
subnet_id[] string
Complete list of subnets (from the same network) the version can be attached to. It's essential to specify at least one subnet for each availability zones.

Secret

Field Description
id string
ID of Yandex Lockbox secret.
version_id string
ID of Yandex Lockbox version.
key string
Key in secret's payload, which value to be delivered into function environment.
reference oneof: environment_variable
  environment_variable string
environment variable in which secret's value to be delivered.

LogOptions

Field Description
disabled bool
Is logging from function disabled.
destination oneof: log_group_id or folder_id
Log entries destination.
  log_group_id string
Entry should be written to log group resolved by ID. Value must match the regular expression ([a-zA-Z][-a-zA-Z0-9_.]{0,63})?.
  folder_id string
Entry should be written to default log group for specified folder. Value must match the regular expression ([a-zA-Z][-a-zA-Z0-9_.]{0,63})?.
min_level yandex.cloud.logging.v1.LogLevel.Level
Minimum log entry level.
See [LogLevel.Level] for details.

Operation

Field Description
id string
ID of the operation.
description string
Description of the operation. 0-256 characters long.
created_at google.protobuf.Timestamp
Creation timestamp.
created_by string
ID of the user or service account who initiated the operation.
modified_at google.protobuf.Timestamp
The time when the Operation resource was last modified.
done bool
If the value is false, it means the operation is still in progress. If true, the operation is completed, and either error or response is available.
metadata google.protobuf.Any<CreateFunctionVersionMetadata>
Service-specific metadata associated with the operation. It typically contains the ID of the target resource that the operation is performed on. Any method that returns a long-running operation should document the metadata type, if any.
result oneof: error or response
The operation result. If done == false and there was no failure detected, neither error nor response is set. If done == false and there was a failure detected, error is set. If done == true, exactly one of error or response is set.
  error google.rpc.Status
The error result of the operation in case of failure or cancellation.
  response google.protobuf.Any<Version>
if operation finished successfully.

CreateFunctionVersionMetadata

Field Description
function_version_id string
ID of the version that is being created.

Version

Field Description
id string
ID of the version.
function_id string
ID of the function that the version belongs to.
description string
Description of the version. The string length in characters must be 0-256.
created_at google.protobuf.Timestamp
Creation timestamp for the version.
runtime string
ID of the runtime environment for the function.
Supported environments and their identifiers are listed in the Runtime environments.
entrypoint string
Entrypoint for the function: the name of the function to be called as the handler.
Specified in the format <function file name>.<handler name>, for example, index.myFunction.
resources Resources
Resources allocated to the version.
execution_timeout google.protobuf.Duration
Timeout for the execution of the version.
If the timeout is exceeded, Cloud Functions responds with a 504 HTTP code.
service_account_id string
ID of the service account associated with the version.
image_size int64
Final size of the deployment package after unpacking.
status enum Status
Status of the version.
  • CREATING: Version is being created.
  • ACTIVE: Version is ready to use.
tags[] string
Version tags. For details, see Version tag.
log_group_id string
ID of the log group for the version.
environment map<string,string>
Environment settings for the version.
connectivity Connectivity
Network access. If specified the version will be attached to specified network/subnet(s).
named_service_accounts map<string,string>
Additional service accounts to be used by the version.
secrets[] Secret
Yandex Lockbox secrets to be used by the version.
log_options LogOptions
Options for logging from the function

ListRuntimes

Lists available runtime environments for the specified function.

rpc ListRuntimes (ListRuntimesRequest) returns (ListRuntimesResponse)

ListRuntimesRequest

ListRuntimesResponse

Field Description
runtimes[] string
Runtime environments available for the specified function.

ListOperations

Lists operations for the specified function.

rpc ListOperations (ListFunctionOperationsRequest) returns (ListFunctionOperationsResponse)

ListFunctionOperationsRequest

Field Description
function_id string
Required. ID of the function to list operations for.
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 ListFunctionOperationsResponse.next_page_token that can be used to get the next page of results in subsequent list requests.
Default value: 100. Acceptable values are 0 to 1000, inclusive.
page_token string
Page token. To get the next page of results, set pageToken to the ListFunctionOperationsResponse.next_page_token returned by a previous list request. The maximum string length in characters is 100.
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 operation.Operation.done, operation.Operation.created_by 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].
Examples of a filter: done=false, created_by='John.Doe'. The maximum string length in characters is 1000.

ListFunctionOperationsResponse

Field Description
operations[] operation.Operation
List of operations for the specified function.
next_page_token string
Token for getting the next page of the list. If the number of results is greater than the specified ListFunctionOperationsRequest.page_size, use nextPageToken as the value for the ListFunctionOperationsRequest.page_token parameter in the next list request.
Each subsequent page will have its own nextPageToken to continue paging through the results.

Operation

Field Description
id string
ID of the operation.
description string
Description of the operation. 0-256 characters long.
created_at google.protobuf.Timestamp
Creation timestamp.
created_by string
ID of the user or service account who initiated the operation.
modified_at google.protobuf.Timestamp
The time when the Operation resource was last modified.
done bool
If the value is false, it means the operation is still in progress. If true, the operation is completed, and either error or response is available.
metadata google.protobuf.Any
Service-specific metadata associated with the operation. It typically contains the ID of the target resource that the operation is performed on. Any method that returns a long-running operation should document the metadata type, if any.
result oneof: error or response
The operation result. If done == false and there was no failure detected, neither error nor response is set. If done == false and there was a failure detected, error is set. If done == true, exactly one of error or response is set.
  error google.rpc.Status
The error result of the operation in case of failure or cancellation.
  response google.protobuf.Any
The normal response of the operation in case of success. If the original method returns no data on success, such as Delete, the response is google.protobuf.Empty. If the original method is the standard Create/Update, the response should be the target resource of the operation. Any method that returns a long-running operation should document the response type, if any.

ListAccessBindings

Lists existing access bindings for the specified function.

rpc ListAccessBindings (ListAccessBindingsRequest) returns (ListAccessBindingsResponse)

ListAccessBindingsRequest

Field Description
resource_id string
Required. ID of the resource to list access bindings for.
To get the resource ID, use a corresponding List request. For example, use the yandex.cloud.resourcemanager.v1.CloudService.List request to get the Cloud resource ID. The maximum string length in characters is 50.
page_size int64
The maximum number of results per page that should be returned. If the number of available results is larger than page_size, the service returns a ListAccessBindingsResponse.next_page_token that can be used to get the next page of results in subsequent list requests. Default value: 100. The maximum value is 1000.
page_token string
Page token. Set page_token to the ListAccessBindingsResponse.next_page_token returned by a previous list request to get the next page of results. The maximum string length in characters is 100.

ListAccessBindingsResponse

Field Description
access_bindings[] AccessBinding
List of access bindings for the specified resource.
next_page_token string
This token allows you to get the next page of results for list requests. If the number of results is larger than ListAccessBindingsRequest.page_size, use the next_page_token as the value for the ListAccessBindingsRequest.page_token query parameter in the next list request. Each subsequent list request will have its own next_page_token to continue paging through the results.

AccessBinding

Field Description
role_id string
Required. ID of the yandex.cloud.iam.v1.Role that is assigned to the subject. The maximum string length in characters is 50.
subject Subject
Required. Identity for which access binding is being created. It can represent an account with a unique ID or several accounts with a system identifier.

Subject

Field Description
id string
Required. ID of the subject.
It can contain one of the following values:
  • allAuthenticatedUsers: A special system identifier that represents anyone
who is authenticated. It can be used only if the type is system.
  • allUsers: A special system identifier that represents anyone. No authentication is required.
For example, you don't need to specify the IAM token in an API query.
  • <cloud generated id>: An identifier that represents a user account.
It can be used only if the type is userAccount, federatedUser or serviceAccount. The maximum string length in characters is 50.
type string
Required. Type of the subject.
It can contain one of the following values:
  • userAccount: An account on Yandex or Yandex.Connect, added to Yandex.Cloud.
  • serviceAccount: A service account. This type represents the yandex.cloud.iam.v1.ServiceAccount resource.
  • federatedUser: A federated account. This type represents a user from an identity federation, like Active Directory.
  • system: System group. This type represents several accounts with a common system identifier.

For more information, see Subject to which the role is assigned. The maximum string length in characters is 100.

SetAccessBindings

Sets access bindings for the function.

rpc SetAccessBindings (SetAccessBindingsRequest) returns (operation.Operation)

Metadata and response of Operation:

    Operation.metadata:SetAccessBindingsMetadata

    Operation.response:google.protobuf.Empty

SetAccessBindingsRequest

Field Description
resource_id string
Required. ID of the resource for which access bindings are being set.
To get the resource ID, use a corresponding List request. The maximum string length in characters is 50.
access_bindings[] AccessBinding
Required. Access bindings to be set. For more information, see Access Bindings.

AccessBinding

Field Description
role_id string
Required. ID of the yandex.cloud.iam.v1.Role that is assigned to the subject. The maximum string length in characters is 50.
subject Subject
Required. Identity for which access binding is being created. It can represent an account with a unique ID or several accounts with a system identifier.

Subject

Field Description
id string
Required. ID of the subject.
It can contain one of the following values:
  • allAuthenticatedUsers: A special system identifier that represents anyone
who is authenticated. It can be used only if the type is system.
  • allUsers: A special system identifier that represents anyone. No authentication is required.
For example, you don't need to specify the IAM token in an API query.
  • <cloud generated id>: An identifier that represents a user account.
It can be used only if the type is userAccount, federatedUser or serviceAccount. The maximum string length in characters is 50.
type string
Required. Type of the subject.
It can contain one of the following values:
  • userAccount: An account on Yandex or Yandex.Connect, added to Yandex.Cloud.
  • serviceAccount: A service account. This type represents the yandex.cloud.iam.v1.ServiceAccount resource.
  • federatedUser: A federated account. This type represents a user from an identity federation, like Active Directory.
  • system: System group. This type represents several accounts with a common system identifier.

For more information, see Subject to which the role is assigned. The maximum string length in characters is 100.

Operation

Field Description
id string
ID of the operation.
description string
Description of the operation. 0-256 characters long.
created_at google.protobuf.Timestamp
Creation timestamp.
created_by string
ID of the user or service account who initiated the operation.
modified_at google.protobuf.Timestamp
The time when the Operation resource was last modified.
done bool
If the value is false, it means the operation is still in progress. If true, the operation is completed, and either error or response is available.
metadata google.protobuf.Any<SetAccessBindingsMetadata>
Service-specific metadata associated with the operation. It typically contains the ID of the target resource that the operation is performed on. Any method that returns a long-running operation should document the metadata type, if any.
result oneof: error or response
The operation result. If done == false and there was no failure detected, neither error nor response is set. If done == false and there was a failure detected, error is set. If done == true, exactly one of error or response is set.
  error google.rpc.Status
The error result of the operation in case of failure or cancellation.
  response google.protobuf.Any<google.protobuf.Empty>
if operation finished successfully.

SetAccessBindingsMetadata

Field Description
resource_id string
ID of the resource for which access bindings are being set.

UpdateAccessBindings

Updates access bindings for the specified function.

rpc UpdateAccessBindings (UpdateAccessBindingsRequest) returns (operation.Operation)

Metadata and response of Operation:

    Operation.metadata:UpdateAccessBindingsMetadata

    Operation.response:google.protobuf.Empty

UpdateAccessBindingsRequest

Field Description
resource_id string
Required. ID of the resource for which access bindings are being updated. The maximum string length in characters is 50.
access_binding_deltas[] AccessBindingDelta
Required. Updates to access bindings. The number of elements must be greater than 0.

AccessBindingDelta

Field Description
action enum AccessBindingAction
Required. The action that is being performed on an access binding.
  • ADD: Addition of an access binding.
  • REMOVE: Removal of an access binding.
access_binding AccessBinding
Required. Access binding. For more information, see Access Bindings.

AccessBinding

Field Description
role_id string
Required. ID of the yandex.cloud.iam.v1.Role that is assigned to the subject. The maximum string length in characters is 50.
subject Subject
Required. Identity for which access binding is being created. It can represent an account with a unique ID or several accounts with a system identifier.

Subject

Field Description
id string
Required. ID of the subject.
It can contain one of the following values:
  • allAuthenticatedUsers: A special system identifier that represents anyone
who is authenticated. It can be used only if the type is system.
  • allUsers: A special system identifier that represents anyone. No authentication is required.
For example, you don't need to specify the IAM token in an API query.
  • <cloud generated id>: An identifier that represents a user account.
It can be used only if the type is userAccount, federatedUser or serviceAccount. The maximum string length in characters is 50.
type string
Required. Type of the subject.
It can contain one of the following values:
  • userAccount: An account on Yandex or Yandex.Connect, added to Yandex.Cloud.
  • serviceAccount: A service account. This type represents the yandex.cloud.iam.v1.ServiceAccount resource.
  • federatedUser: A federated account. This type represents a user from an identity federation, like Active Directory.
  • system: System group. This type represents several accounts with a common system identifier.

For more information, see Subject to which the role is assigned. The maximum string length in characters is 100.

Operation

Field Description
id string
ID of the operation.
description string
Description of the operation. 0-256 characters long.
created_at google.protobuf.Timestamp
Creation timestamp.
created_by string
ID of the user or service account who initiated the operation.
modified_at google.protobuf.Timestamp
The time when the Operation resource was last modified.
done bool
If the value is false, it means the operation is still in progress. If true, the operation is completed, and either error or response is available.
metadata google.protobuf.Any<UpdateAccessBindingsMetadata>
Service-specific metadata associated with the operation. It typically contains the ID of the target resource that the operation is performed on. Any method that returns a long-running operation should document the metadata type, if any.
result oneof: error or response
The operation result. If done == false and there was no failure detected, neither error nor response is set. If done == false and there was a failure detected, error is set. If done == true, exactly one of error or response is set.
  error google.rpc.Status
The error result of the operation in case of failure or cancellation.
  response google.protobuf.Any<google.protobuf.Empty>
if operation finished successfully.

UpdateAccessBindingsMetadata

Field Description
resource_id string
ID of the resource for which access bindings are being updated.

ListScalingPolicies

Lists existing scaling policies for specified function

rpc ListScalingPolicies (ListScalingPoliciesRequest) returns (ListScalingPoliciesResponse)

ListScalingPoliciesRequest

Field Description
function_id string
Required. ID of the function to retrieve scaling policies for.
To get a function ID, make a FunctionService.List request.
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 ListScalingPoliciesResponse.next_page_token that can be used to get the next page of results in subsequent list requests.
Default value: 100. Acceptable values are 0 to 1000, inclusive.
page_token string
Page token. To get the next page of results, set pageToken to the ListScalingPoliciesResponse.next_page_token returned by a previous list request. The maximum string length in characters is 100.

ListScalingPoliciesResponse

Field Description
scaling_policies[] ScalingPolicy
Set of relevant scaling policies.
next_page_token string
Token for getting the next page of the list. If the number of results is greater than the specified ListScalingPoliciesRequest.page_size, use nextPageToken as the value for the ListScalingPoliciesRequest.page_token parameter in the next list request.
Each subsequent page will have its own nextPageToken to continue paging through the results.

ScalingPolicy

Field Description
function_id string
ID of the function that the scaling policy belongs to.
tag string
Tag of the version that the scaling policy belongs to. For details, see Version tag.
created_at google.protobuf.Timestamp
Creation timestamp for the scaling policy
modified_at google.protobuf.Timestamp
Modification timestamp for the scaling policy
provisioned_instances_count int64
Minimum guaranteed provisioned instances count for all zones in total. Billed separately.
zone_instances_limit int64
Upper limit for instance count in each zone. 0 means no limit.
zone_requests_limit int64
Upper limit of requests count in each zone. 0 means no limit.

SetScalingPolicy

Set scaling policy for specified function and tag

rpc SetScalingPolicy (SetScalingPolicyRequest) returns (operation.Operation)

Metadata and response of Operation:

    Operation.metadata:SetScalingPolicyMetadata

    Operation.response:ScalingPolicy

SetScalingPolicyRequest

Field Description
function_id string
Required. ID of the function to retrieve scaling policies for.
To get a function ID, make a FunctionService.List request.
tag string
Required. Version tag.
To get the history of version tags make a FunctionService.ListTagHistory request. Value must match the regular expression [a-z][-_0-9a-z]*|[$]latest.
provisioned_instances_count int64
Minimum guaranteed provisioned instances count for all zones in total. Billed separately. Acceptable values are 0 to 1000, inclusive.
zone_instances_limit int64
Upper limit for instance count in each zone. 0 means no limit. Acceptable values are 0 to 1000, inclusive.
zone_requests_limit int64
Upper limit of requests count in each zone. 0 means no limit. Acceptable values are 0 to 1000, inclusive.

Operation

Field Description
id string
ID of the operation.
description string
Description of the operation. 0-256 characters long.
created_at google.protobuf.Timestamp
Creation timestamp.
created_by string
ID of the user or service account who initiated the operation.
modified_at google.protobuf.Timestamp
The time when the Operation resource was last modified.
done bool
If the value is false, it means the operation is still in progress. If true, the operation is completed, and either error or response is available.
metadata google.protobuf.Any<SetScalingPolicyMetadata>
Service-specific metadata associated with the operation. It typically contains the ID of the target resource that the operation is performed on. Any method that returns a long-running operation should document the metadata type, if any.
result oneof: error or response
The operation result. If done == false and there was no failure detected, neither error nor response is set. If done == false and there was a failure detected, error is set. If done == true, exactly one of error or response is set.
  error google.rpc.Status
The error result of the operation in case of failure or cancellation.
  response google.protobuf.Any<ScalingPolicy>
if operation finished successfully.

SetScalingPolicyMetadata

Field Description
function_id string
ID of the function for which scaling policy was set.

ScalingPolicy

Field Description
function_id string
ID of the function that the scaling policy belongs to.
tag string
Tag of the version that the scaling policy belongs to. For details, see Version tag.
created_at google.protobuf.Timestamp
Creation timestamp for the scaling policy
modified_at google.protobuf.Timestamp
Modification timestamp for the scaling policy
provisioned_instances_count int64
Minimum guaranteed provisioned instances count for all zones in total. Billed separately.
zone_instances_limit int64
Upper limit for instance count in each zone. 0 means no limit.
zone_requests_limit int64
Upper limit of requests count in each zone. 0 means no limit.

RemoveScalingPolicy

Remove scaling policy for specified function and tag

rpc RemoveScalingPolicy (RemoveScalingPolicyRequest) returns (operation.Operation)

Metadata and response of Operation:

    Operation.metadata:RemoveScalingPolicyMetadata

    Operation.response:google.protobuf.Empty

RemoveScalingPolicyRequest

Field Description
function_id string
Required. ID of the function to remove scaling policies for.
To get a function ID, make a FunctionService.List request.
tag string
Required. Version tag.
To get the history of version tags make a FunctionService.ListTagHistory request. Value must match the regular expression [a-z][-_0-9a-z]*|[$]latest.

Operation

Field Description
id string
ID of the operation.
description string
Description of the operation. 0-256 characters long.
created_at google.protobuf.Timestamp
Creation timestamp.
created_by string
ID of the user or service account who initiated the operation.
modified_at google.protobuf.Timestamp
The time when the Operation resource was last modified.
done bool
If the value is false, it means the operation is still in progress. If true, the operation is completed, and either error or response is available.
metadata google.protobuf.Any<RemoveScalingPolicyMetadata>
Service-specific metadata associated with the operation. It typically contains the ID of the target resource that the operation is performed on. Any method that returns a long-running operation should document the metadata type, if any.
result oneof: error or response
The operation result. If done == false and there was no failure detected, neither error nor response is set. If done == false and there was a failure detected, error is set. If done == true, exactly one of error or response is set.
  error google.rpc.Status
The error result of the operation in case of failure or cancellation.
  response google.protobuf.Any<google.protobuf.Empty>
if operation finished successfully.

RemoveScalingPolicyMetadata

Field Description
function_id string
ID of the function for which scaling policy was removed.

Была ли статья полезна?

Language / Region
Проект Яндекса
© 2023 ООО «Яндекс.Облако»
В этой статье:
  • Calls FunctionService
  • Get
  • GetFunctionRequest
  • Function
  • List
  • ListFunctionsRequest
  • ListFunctionsResponse
  • Function
  • Create
  • CreateFunctionRequest
  • Operation
  • CreateFunctionMetadata
  • Function
  • Update
  • UpdateFunctionRequest
  • Operation
  • UpdateFunctionMetadata
  • Function
  • Delete
  • DeleteFunctionRequest
  • Operation
  • DeleteFunctionMetadata
  • GetVersion
  • GetFunctionVersionRequest
  • Version
  • Resources
  • Connectivity
  • Secret
  • LogOptions
  • GetFunctionVersion
  • GetFunctionVersionRequest
  • Version
  • Resources
  • Connectivity
  • Secret
  • LogOptions
  • GetVersionByTag
  • GetFunctionVersionByTagRequest
  • Version
  • Resources
  • Connectivity
  • Secret
  • LogOptions
  • GetFunctionVersionByTag
  • GetFunctionVersionByTagRequest
  • Version
  • Resources
  • Connectivity
  • Secret
  • LogOptions
  • ListVersions
  • ListFunctionsVersionsRequest
  • ListFunctionsVersionsResponse
  • Version
  • Resources
  • Connectivity
  • Secret
  • LogOptions
  • ListFunctionVersions
  • ListFunctionsVersionsRequest
  • ListFunctionsVersionsResponse
  • Version
  • Resources
  • Connectivity
  • Secret
  • LogOptions
  • SetTag
  • SetFunctionTagRequest
  • Operation
  • SetFunctionTagMetadata
  • Version
  • Resources
  • Connectivity
  • Secret
  • LogOptions
  • RemoveTag
  • RemoveFunctionTagRequest
  • Operation
  • RemoveFunctionTagMetadata
  • Version
  • Resources
  • Connectivity
  • Secret
  • LogOptions
  • ListTagHistory
  • ListFunctionTagHistoryRequest
  • ListFunctionTagHistoryResponse
  • FunctionTagHistoryRecord
  • ListFunctionTagHistory
  • ListFunctionTagHistoryRequest
  • ListFunctionTagHistoryResponse
  • FunctionTagHistoryRecord
  • CreateVersion
  • CreateFunctionVersionRequest
  • Resources
  • Package
  • Connectivity
  • Secret
  • LogOptions
  • Operation
  • CreateFunctionVersionMetadata
  • Version
  • CreateFunctionVersion
  • CreateFunctionVersionRequest
  • Resources
  • Package
  • Connectivity
  • Secret
  • LogOptions
  • Operation
  • CreateFunctionVersionMetadata
  • Version
  • ListRuntimes
  • ListRuntimesRequest
  • ListRuntimesResponse
  • ListOperations
  • ListFunctionOperationsRequest
  • ListFunctionOperationsResponse
  • Operation
  • ListAccessBindings
  • ListAccessBindingsRequest
  • ListAccessBindingsResponse
  • AccessBinding
  • Subject
  • SetAccessBindings
  • SetAccessBindingsRequest
  • AccessBinding
  • Subject
  • Operation
  • SetAccessBindingsMetadata
  • UpdateAccessBindings
  • UpdateAccessBindingsRequest
  • AccessBindingDelta
  • AccessBinding
  • Subject
  • Operation
  • UpdateAccessBindingsMetadata
  • ListScalingPolicies
  • ListScalingPoliciesRequest
  • ListScalingPoliciesResponse
  • ScalingPolicy
  • SetScalingPolicy
  • SetScalingPolicyRequest
  • Operation
  • SetScalingPolicyMetadata
  • ScalingPolicy
  • RemoveScalingPolicy
  • RemoveScalingPolicyRequest
  • Operation
  • RemoveScalingPolicyMetadata