FunctionService
- Вызовы FunctionService
- Get
- List
- Create
- Update
- Delete
- GetVersion
- GetFunctionVersion
- GetVersionByTag
- GetFunctionVersionByTag
- ListVersions
- ListFunctionVersions
- SetTag
- RemoveTag
- ListTagHistory
- ListFunctionTagHistory
- CreateVersion
- CreateFunctionVersion
- ListRuntimes
- ListOperations
- ListAccessBindings
- SetAccessBindings
- UpdateAccessBindings
Набор методов управления бессерверными функциями.
Вызов | Описание |
---|---|
Get | Возвращает указанную функцию. |
List | Возвращает список функций в указанном каталоге. |
Create | Создает функцию в указанном каталоге. |
Update | Обновляет указанную функцию. |
Delete | Удаляет указанную функцию. |
GetVersion | Возвращает указанную версию функции. |
GetFunctionVersion | Устарел. |
GetVersionByTag | Возвращает все версии с указанным тегом. |
GetFunctionVersionByTag | Устарел. |
ListVersions | Извлекает список версий для указанной функции или всех версий функции в указанном каталоге |
ListFunctionVersions | Устарел. |
SetTag | Устанавливает тег для указанной версии функции. |
RemoveTag | Удаляет тег из указанной версии функции. |
ListTagHistory | Возвращает журнал тегов, назначенных версиям указанной функции. |
ListFunctionTagHistory | Устарел. |
CreateVersion | Создает версию для указанной функции. |
CreateFunctionVersion | Устарел. |
ListRuntimes | Список доступных сред выполнения для указанной функции. |
ListOperations | Возвращает список операций для указанной функции. |
ListAccessBindings | Возвращает список привязок прав доступа для указанной функции. |
SetAccessBindings | Устанавливает привязки прав доступа для указанной функции. |
UpdateAccessBindings | Обновляет привязки прав доступа для указанной функции. |
Вызовы FunctionService
Get
Возвращает указанную функцию.
Чтобы получить список доступных функций, используйте запрос List .
rpc Get (GetFunctionRequest) returns (Function)
GetFunctionRequest
Поле | Описание |
---|---|
function_id | string Обязательное поле. Идентификатор возвращаемой функции. Чтобы получить идентификатор функции, используйте запрос FunctionService.List . |
Function
Поле | Описание |
---|---|
id | string Идентификатор функции. Генерируется во время создания. |
folder_id | string Идентификатор каталога, к которому принадлежит функция. |
created_at | google.protobuf.Timestamp Время создания функции. |
name | string Имя функции. Имя уникально в рамках каталога. Длина строки в символах должна быть от 3 до 63. |
description | string Описание функции. Длина строки в символах должна быть от 0 до 256. |
labels | map<string,string> Метки функций в виде пар key:value . Не более 64 на ресурс. |
log_group_id | string Идентификатор группы журналов выполнения функции. |
http_invoke_url | string URL-адрес, который нужнозапросить для вызова функции. |
status | enum Status Состояние функции.
|
List
Возвращает список функций в указанном каталоге.
rpc List (ListFunctionsRequest) returns (ListFunctionsResponse)
ListFunctionsRequest
Поле | Описание |
---|---|
folder_id | string Обязательное поле. Идентификатор каталога для получения списка функций. Чтобы получить идентификатор каталога, используйте запрос yandex.cloud.resourcemanager.v1.FolderService.List. |
page_size | int64 Максимальное количество результатов на странице ответа на запрос. Если количество результатов больше чем pageSize , сервис вернет значение ListFunctionsResponse.next_page_token, которое можно использовать для получения следующей страницы. Значение по умолчанию: 100. |
page_token | string Токен страницы. Установите значение pageToken равным значению поля ListFunctionsResponse.next_page_token предыдущего запроса, чтобы получить следующую страницу результатов. |
filter | string
|
ListFunctionsResponse
Поле | Описание |
---|---|
functions[] | Function Возвращает список функций в указанном каталоге. |
next_page_token | string Токен для получения следующей страницы списка. Если количество результатов больше чем ListFunctionsRequest.page_size, используйте nextPageToken в качестве значения параметра ListFunctionsRequest.page_token в следующем запросе списка ресурсов. Все последующие запросы будут получать свои значения nextPageToken для перебора страниц результатов. |
Function
Поле | Описание |
---|---|
id | string Идентификатор функции. Генерируется во время создания. |
folder_id | string Идентификатор каталога, к которому принадлежит функция. |
created_at | google.protobuf.Timestamp Время создания функции. |
name | string Имя функции. Имя уникально в рамках каталога. Длина строки в символах должна быть от 3 до 63. |
description | string Описание функции. Длина строки в символах должна быть от 0 до 256. |
labels | map<string,string> Метки функций в виде пар key:value . Не более 64 на ресурс. |
log_group_id | string Идентификатор группы журналов выполнения функции. |
http_invoke_url | string URL-адрес, который нужнозапросить для вызова функции. |
status | enum Status Состояние функции.
|
Create
Создает функцию в указанном каталоге.
rpc Create (CreateFunctionRequest) returns (operation.Operation)
Метаданные и результат операции:
Operation.metadata:CreateFunctionMetadata
Operation.response:Function
CreateFunctionRequest
Поле | Описание |
---|---|
folder_id | string Обязательное поле. Идентификатор каталога, в котором создается функция. Чтобы получить идентификатор каталога, используйте запрос yandex.cloud.resourcemanager.v1.FolderService.List. |
name | string Имя функции. Имя должно быть уникальным в рамках каталога. Значение должно соответствовать регулярному выражению |[a-z][-a-z0-9]{1,61}[a-z0-9] . |
description | string Описание функции. Максимальная длина строки в символах — 256. |
labels | map<string,string> Метки ресурса в формате key:value . Не более 64 на ресурс. Максимальная длина строки в символах для каждого значения — 63. Каждое значение должно соответствовать регулярному выражению [-_0-9a-z]* . Длина строки в символах для каждого ключа должна быть от 1 до 63. Каждый ключ должен соответствовать регулярному выражению [a-z][-_0-9a-z]* . |
Operation
Поле | Описание |
---|---|
id | string Идентификатор операции. |
description | string Описание операции. Длина описания должна быть от 0 до 256 символов. |
created_at | google.protobuf.Timestamp Время создания ресурса в формате в RFC3339. |
created_by | string Идентификатор пользователя или сервисного аккаунта, инициировавшего операцию. |
modified_at | google.protobuf.Timestamp Время, когда ресурс Operation последний раз обновлялся. Значение в формате RFC3339. |
done | bool Если значение равно false — операция еще выполняется. Если true — операция завершена, и задано значение одного из полей error или response . |
metadata | google.protobuf.Any<CreateFunctionMetadata> Метаданные операции. Обычно в поле содержится идентификатор ресурса, над которым выполняется операция. Если метод возвращает ресурс Operation, в описании метода приведена структура соответствующего ему поля metadata . |
result | oneof: error или response Результат операции. Если done == false и не было выявлено ошибок — значения полей error и response не заданы. Если done == false и была выявлена ошибка — задано значение поля error . Если done == true — задано значение ровно одного из полей error или response . |
error | google.rpc.Status Описание ошибки в случае сбоя или отмены операции. |
response | google.protobuf.Any<Function> в случае успешного выполнения операции. |
CreateFunctionMetadata
Поле | Описание |
---|---|
function_id | string Идентификатор создаваемой функции. |
Function
Поле | Описание |
---|---|
id | string Идентификатор функции. Генерируется во время создания. |
folder_id | string Идентификатор каталога, к которому принадлежит функция. |
created_at | google.protobuf.Timestamp Время создания функции. |
name | string Имя функции. Имя уникально в рамках каталога. Длина строки в символах должна быть от 3 до 63. |
description | string Описание функции. Длина строки в символах должна быть от 0 до 256. |
labels | map<string,string> Метки функций в виде пар key:value . Не более 64 на ресурс. |
log_group_id | string Идентификатор группы журналов выполнения функции. |
http_invoke_url | string URL-адрес, который нужнозапросить для вызова функции. |
status | enum Status Состояние функции.
|
Update
Обновляет указанную функцию.
rpc Update (UpdateFunctionRequest) returns (operation.Operation)
Метаданные и результат операции:
Operation.metadata:UpdateFunctionMetadata
Operation.response:Function
UpdateFunctionRequest
Поле | Описание |
---|---|
function_id | string Обязательное поле. Идентификатор функции для обновления. Чтобы получить идентификатор функции, используйте запрос FunctionService.List . |
update_mask | google.protobuf.FieldMask Маска поля, которая указывает, какие атрибуты функции должны быть обновлены. |
name | string Новое имя функции. Имя должно быть уникальным в рамках каталога. Значение должно соответствовать регулярному выражению |[a-z][-a-z0-9]{1,61}[a-z0-9] . |
description | string Новое описание функции. Максимальная длина строки в символах — 256. |
labels | map<string,string> Метки функций в виде пар key:value . Существующий набор меток полностью заменяется предоставленным набором, поэтому, если вы просто хотите добавить или удалить метку, запросите текущий набор меток, используя запрос FunctionService.Get . Не более 64 на ресурс. Максимальная длина строки в символах для каждого значения — 63. Каждое значение должно соответствовать регулярному выражению [-_0-9a-z]* . Длина строки в символах для каждого ключа должна быть от 1 до 63. Каждый ключ должен соответствовать регулярному выражению [a-z][-_0-9a-z]* . |
Operation
Поле | Описание |
---|---|
id | string Идентификатор операции. |
description | string Описание операции. Длина описания должна быть от 0 до 256 символов. |
created_at | google.protobuf.Timestamp Время создания ресурса в формате в RFC3339. |
created_by | string Идентификатор пользователя или сервисного аккаунта, инициировавшего операцию. |
modified_at | google.protobuf.Timestamp Время, когда ресурс Operation последний раз обновлялся. Значение в формате RFC3339. |
done | bool Если значение равно false — операция еще выполняется. Если true — операция завершена, и задано значение одного из полей error или response . |
metadata | google.protobuf.Any<UpdateFunctionMetadata> Метаданные операции. Обычно в поле содержится идентификатор ресурса, над которым выполняется операция. Если метод возвращает ресурс Operation, в описании метода приведена структура соответствующего ему поля metadata . |
result | oneof: error или response Результат операции. Если done == false и не было выявлено ошибок — значения полей error и response не заданы. Если done == false и была выявлена ошибка — задано значение поля error . Если done == true — задано значение ровно одного из полей error или response . |
error | google.rpc.Status Описание ошибки в случае сбоя или отмены операции. |
response | google.protobuf.Any<Function> в случае успешного выполнения операции. |
UpdateFunctionMetadata
Поле | Описание |
---|---|
function_id | string Идентификатор обновляемой функции. |
Function
Поле | Описание |
---|---|
id | string Идентификатор функции. Генерируется во время создания. |
folder_id | string Идентификатор каталога, к которому принадлежит функция. |
created_at | google.protobuf.Timestamp Время создания функции. |
name | string Имя функции. Имя уникально в рамках каталога. Длина строки в символах должна быть от 3 до 63. |
description | string Описание функции. Длина строки в символах должна быть от 0 до 256. |
labels | map<string,string> Метки функций в виде пар key:value . Не более 64 на ресурс. |
log_group_id | string Идентификатор группы журналов выполнения функции. |
http_invoke_url | string URL-адрес, который нужнозапросить для вызова функции. |
status | enum Status Состояние функции.
|
Delete
Удаляет указанную функцию.
rpc Delete (DeleteFunctionRequest) returns (operation.Operation)
Метаданные и результат операции:
Operation.metadata:DeleteFunctionMetadata
Operation.response:google.protobuf.Empty
DeleteFunctionRequest
Поле | Описание |
---|---|
function_id | string Обязательное поле. Идентификатор удаляемой функции. Чтобы получить идентификатор функции, используйте запрос FunctionService.List . |
Operation
Поле | Описание |
---|---|
id | string Идентификатор операции. |
description | string Описание операции. Длина описания должна быть от 0 до 256 символов. |
created_at | google.protobuf.Timestamp Время создания ресурса в формате в RFC3339. |
created_by | string Идентификатор пользователя или сервисного аккаунта, инициировавшего операцию. |
modified_at | google.protobuf.Timestamp Время, когда ресурс Operation последний раз обновлялся. Значение в формате RFC3339. |
done | bool Если значение равно false — операция еще выполняется. Если true — операция завершена, и задано значение одного из полей error или response . |
metadata | google.protobuf.Any<DeleteFunctionMetadata> Метаданные операции. Обычно в поле содержится идентификатор ресурса, над которым выполняется операция. Если метод возвращает ресурс Operation, в описании метода приведена структура соответствующего ему поля metadata . |
result | oneof: error или response Результат операции. Если done == false и не было выявлено ошибок — значения полей error и response не заданы. Если done == false и была выявлена ошибка — задано значение поля error . Если done == true — задано значение ровно одного из полей error или response . |
error | google.rpc.Status Описание ошибки в случае сбоя или отмены операции. |
response | google.protobuf.Any<google.protobuf.Empty> в случае успешного выполнения операции. |
DeleteFunctionMetadata
Поле | Описание |
---|---|
function_id | string Идентификатор удаляемой функции. |
GetVersion
Возвращает указанную версию функции.
Чтобы получить список доступных версий, используйте запрос ListVersions .
rpc GetVersion (GetFunctionVersionRequest) returns (Version)
GetFunctionVersionRequest
Поле | Описание |
---|---|
function_version_id | string Обязательное поле. Идентификатор возвращаемой версии. Чтобы получить идентификатор версии, используйте запрос FunctionService.ListVersions . |
Version
Поле | Описание |
---|---|
id | string Идентификатор версии. |
function_id | string Идентификатор функции, которой принадлежит версия. |
description | string Описание версии. Длина строки в символах должна быть от 0 до 256. |
created_at | google.protobuf.Timestamp Время создания версии. |
runtime | string Идентификатор среды выполнения для функции. Поддерживаемые среды и их идентификаторы перечислены в списке Среда выполнения. |
entrypoint | string Точка входа для функции: имя функции, вызываемой в качестве обработчика. Указывается в формате <function file name>.<handler name> , например, index.myFunction . |
resources | Resources Ресурсы, выделенные для версии. |
execution_timeout | google.protobuf.Duration Таймаут для выполнения версии. Если время ожидания будет превышено, Cloud Functions возвращает 504 HTTP-код. |
service_account_id | string Идентификатор сервисного аккаунта, который связан с версией. |
image_size | int64 Окончательный размер пакета развертывания после распаковки. |
status | enum Status Состояние версии.
|
tags[] | string Теги версий. Подробнее см. в Тег версии. |
log_group_id | string Идентификатор группы журналов выполнения для версии. |
environment | map<string,string> Параметры среды выполнения для версии. |
Resources
Поле | Описание |
---|---|
memory | int64 Объем памяти в байтах, доступный для версии. Допустимые значения — от 33554432 до 1073741824 включительно. |
GetFunctionVersion
Устарел. Используйте GetVersion.
rpc GetFunctionVersion (GetFunctionVersionRequest) returns (Version)
GetFunctionVersionRequest
Поле | Описание |
---|---|
function_version_id | string Обязательное поле. Идентификатор возвращаемой версии. Чтобы получить идентификатор версии, используйте запрос FunctionService.ListVersions . |
Version
Поле | Описание |
---|---|
id | string Идентификатор версии. |
function_id | string Идентификатор функции, которой принадлежит версия. |
description | string Описание версии. Длина строки в символах должна быть от 0 до 256. |
created_at | google.protobuf.Timestamp Время создания версии. |
runtime | string Идентификатор среды выполнения для функции. Поддерживаемые среды и их идентификаторы перечислены в списке Среда выполнения. |
entrypoint | string Точка входа для функции: имя функции, вызываемой в качестве обработчика. Указывается в формате <function file name>.<handler name> , например, index.myFunction . |
resources | Resources Ресурсы, выделенные для версии. |
execution_timeout | google.protobuf.Duration Таймаут для выполнения версии. Если время ожидания будет превышено, Cloud Functions возвращает 504 HTTP-код. |
service_account_id | string Идентификатор сервисного аккаунта, который связан с версией. |
image_size | int64 Окончательный размер пакета развертывания после распаковки. |
status | enum Status Состояние версии.
|
tags[] | string Теги версий. Подробнее см. в Тег версии. |
log_group_id | string Идентификатор группы журналов выполнения для версии. |
environment | map<string,string> Параметры среды выполнения для версии. |
Resources
Поле | Описание |
---|---|
memory | int64 Объем памяти в байтах, доступный для версии. Допустимые значения — от 33554432 до 1073741824 включительно. |
GetVersionByTag
Возвращает все версии с указанным тегом.
Чтобы получить список доступных версий, используйте запрос ListVersions .
rpc GetVersionByTag (GetFunctionVersionByTagRequest) returns (Version)
GetFunctionVersionByTagRequest
Поле | Описание |
---|---|
function_id | string Обязательное поле. Идентификатор функции, для которой нужно вернуть список версий. Чтобы получить идентификатор функции, используйте запрос FunctionService.List . |
tag | string Тег версии. Чтобы получить историю тегов версий, используйте запрос FunctionService.ListTagHistory . Значение должно соответствовать регулярному выражению [a-z][-_0-9a-z]*|[$]latest . |
Version
Поле | Описание |
---|---|
id | string Идентификатор версии. |
function_id | string Идентификатор функции, которой принадлежит версия. |
description | string Описание версии. Длина строки в символах должна быть от 0 до 256. |
created_at | google.protobuf.Timestamp Время создания версии. |
runtime | string Идентификатор среды выполнения для функции. Поддерживаемые среды и их идентификаторы перечислены в списке Среда выполнения. |
entrypoint | string Точка входа для функции: имя функции, вызываемой в качестве обработчика. Указывается в формате <function file name>.<handler name> , например, index.myFunction . |
resources | Resources Ресурсы, выделенные для версии. |
execution_timeout | google.protobuf.Duration Таймаут для выполнения версии. Если время ожидания будет превышено, Cloud Functions возвращает 504 HTTP-код. |
service_account_id | string Идентификатор сервисного аккаунта, который связан с версией. |
image_size | int64 Окончательный размер пакета развертывания после распаковки. |
status | enum Status Состояние версии.
|
tags[] | string Теги версий. Подробнее см. в Тег версии. |
log_group_id | string Идентификатор группы журналов выполнения для версии. |
environment | map<string,string> Параметры среды выполнения для версии. |
Resources
Поле | Описание |
---|---|
memory | int64 Объем памяти в байтах, доступный для версии. Допустимые значения — от 33554432 до 1073741824 включительно. |
GetFunctionVersionByTag
Устарел. Используйте GetVersionByTag.
rpc GetFunctionVersionByTag (GetFunctionVersionByTagRequest) returns (Version)
GetFunctionVersionByTagRequest
Поле | Описание |
---|---|
function_id | string Обязательное поле. Идентификатор функции, для которой нужно вернуть список версий. Чтобы получить идентификатор функции, используйте запрос FunctionService.List . |
tag | string Тег версии. Чтобы получить историю тегов версий, используйте запрос FunctionService.ListTagHistory . Значение должно соответствовать регулярному выражению [a-z][-_0-9a-z]*|[$]latest . |
Version
Поле | Описание |
---|---|
id | string Идентификатор версии. |
function_id | string Идентификатор функции, которой принадлежит версия. |
description | string Описание версии. Длина строки в символах должна быть от 0 до 256. |
created_at | google.protobuf.Timestamp Время создания версии. |
runtime | string Идентификатор среды выполнения для функции. Поддерживаемые среды и их идентификаторы перечислены в списке Среда выполнения. |
entrypoint | string Точка входа для функции: имя функции, вызываемой в качестве обработчика. Указывается в формате <function file name>.<handler name> , например, index.myFunction . |
resources | Resources Ресурсы, выделенные для версии. |
execution_timeout | google.protobuf.Duration Таймаут для выполнения версии. Если время ожидания будет превышено, Cloud Functions возвращает 504 HTTP-код. |
service_account_id | string Идентификатор сервисного аккаунта, который связан с версией. |
image_size | int64 Окончательный размер пакета развертывания после распаковки. |
status | enum Status Состояние версии.
|
tags[] | string Теги версий. Подробнее см. в Тег версии. |
log_group_id | string Идентификатор группы журналов выполнения для версии. |
environment | map<string,string> Параметры среды выполнения для версии. |
Resources
Поле | Описание |
---|---|
memory | int64 Объем памяти в байтах, доступный для версии. Допустимые значения — от 33554432 до 1073741824 включительно. |
ListVersions
Извлекает список версий для указанной функции или всех версий функции в указанном каталоге
rpc ListVersions (ListFunctionsVersionsRequest) returns (ListFunctionsVersionsResponse)
ListFunctionsVersionsRequest
Поле | Описание |
---|---|
id | oneof: folder_id или function_id |
folder_id | string Идентификатор каталога, для которого нужно вернуть список версий функции. Чтобы получить идентификатор каталога, используйте запрос yandex.cloud.resourcemanager.v1.FolderService.List. |
function_id | string Идентификатор функции, для которой нужно вернуть список версий. Чтобы получить идентификатор функции, используйте запрос FunctionService.List . |
page_size | int64 Максимальное количество результатов на странице ответа на запрос. Если количество результатов больше чем pageSize , сервис вернет значение ListFunctionsVersionsResponse.next_page_token, которое можно использовать для получения следующей страницы. Значение по умолчанию: 100. Допустимые значения — от 0 до 1000 включительно. |
page_token | string Токен страницы. Установите значение pageToken равным значению поля ListFunctionsVersionsResponse.next_page_token предыдущего запроса, чтобы получить следующую страницу результатов. Максимальная длина строки в символах — 100. |
filter | string
|
ListFunctionsVersionsResponse
Поле | Описание |
---|---|
versions[] | Version Список версий для указанного каталога или функции. |
next_page_token | string Токен для получения следующей страницы списка. Если количество результатов больше чем ListFunctionsVersionsRequest.page_size, используйте nextPageToken в качестве значения параметра ListFunctionsVersionsRequest.page_token в следующем запросе списка ресурсов. Все последующие запросы будут получать свои значения nextPageToken для перебора страниц результатов. |
Version
Поле | Описание |
---|---|
id | string Идентификатор версии. |
function_id | string Идентификатор функции, которой принадлежит версия. |
description | string Описание версии. Длина строки в символах должна быть от 0 до 256. |
created_at | google.protobuf.Timestamp Время создания версии. |
runtime | string Идентификатор среды выполнения для функции. Поддерживаемые среды и их идентификаторы перечислены в списке Среда выполнения. |
entrypoint | string Точка входа для функции: имя функции, вызываемой в качестве обработчика. Указывается в формате <function file name>.<handler name> , например, index.myFunction . |
resources | Resources Ресурсы, выделенные для версии. |
execution_timeout | google.protobuf.Duration Таймаут для выполнения версии. Если время ожидания будет превышено, Cloud Functions возвращает 504 HTTP-код. |
service_account_id | string Идентификатор сервисного аккаунта, который связан с версией. |
image_size | int64 Окончательный размер пакета развертывания после распаковки. |
status | enum Status Состояние версии.
|
tags[] | string Теги версий. Подробнее см. в Тег версии. |
log_group_id | string Идентификатор группы журналов выполнения для версии. |
environment | map<string,string> Параметры среды выполнения для версии. |
Resources
Поле | Описание |
---|---|
memory | int64 Объем памяти в байтах, доступный для версии. Допустимые значения — от 33554432 до 1073741824 включительно. |
ListFunctionVersions
Устарел. Используйте ListVersions.
rpc ListFunctionVersions (ListFunctionsVersionsRequest) returns (ListFunctionsVersionsResponse)
ListFunctionsVersionsRequest
Поле | Описание |
---|---|
id | oneof: folder_id или function_id |
folder_id | string Идентификатор каталога, для которого нужно вернуть список версий функции. Чтобы получить идентификатор каталога, используйте запрос yandex.cloud.resourcemanager.v1.FolderService.List. |
function_id | string Идентификатор функции, для которой нужно вернуть список версий. Чтобы получить идентификатор функции, используйте запрос FunctionService.List . |
page_size | int64 Максимальное количество результатов на странице ответа на запрос. Если количество результатов больше чем pageSize , сервис вернет значение ListFunctionsVersionsResponse.next_page_token, которое можно использовать для получения следующей страницы. Значение по умолчанию: 100. Допустимые значения — от 0 до 1000 включительно. |
page_token | string Токен страницы. Установите значение pageToken равным значению поля ListFunctionsVersionsResponse.next_page_token предыдущего запроса, чтобы получить следующую страницу результатов. Максимальная длина строки в символах — 100. |
filter | string
|
ListFunctionsVersionsResponse
Поле | Описание |
---|---|
versions[] | Version Список версий для указанного каталога или функции. |
next_page_token | string Токен для получения следующей страницы списка. Если количество результатов больше чем ListFunctionsVersionsRequest.page_size, используйте nextPageToken в качестве значения параметра ListFunctionsVersionsRequest.page_token в следующем запросе списка ресурсов. Все последующие запросы будут получать свои значения nextPageToken для перебора страниц результатов. |
Version
Поле | Описание |
---|---|
id | string Идентификатор версии. |
function_id | string Идентификатор функции, которой принадлежит версия. |
description | string Описание версии. Длина строки в символах должна быть от 0 до 256. |
created_at | google.protobuf.Timestamp Время создания версии. |
runtime | string Идентификатор среды выполнения для функции. Поддерживаемые среды и их идентификаторы перечислены в списке Среда выполнения. |
entrypoint | string Точка входа для функции: имя функции, вызываемой в качестве обработчика. Указывается в формате <function file name>.<handler name> , например, index.myFunction . |
resources | Resources Ресурсы, выделенные для версии. |
execution_timeout | google.protobuf.Duration Таймаут для выполнения версии. Если время ожидания будет превышено, Cloud Functions возвращает 504 HTTP-код. |
service_account_id | string Идентификатор сервисного аккаунта, который связан с версией. |
image_size | int64 Окончательный размер пакета развертывания после распаковки. |
status | enum Status Состояние версии.
|
tags[] | string Теги версий. Подробнее см. в Тег версии. |
log_group_id | string Идентификатор группы журналов выполнения для версии. |
environment | map<string,string> Параметры среды выполнения для версии. |
Resources
Поле | Описание |
---|---|
memory | int64 Объем памяти в байтах, доступный для версии. Допустимые значения — от 33554432 до 1073741824 включительно. |
SetTag
Устанавливает тег для указанной версии функции.
rpc SetTag (SetFunctionTagRequest) returns (operation.Operation)
Метаданные и результат операции:
Operation.metadata:SetFunctionTagMetadata
Operation.response:Version
SetFunctionTagRequest
Поле | Описание |
---|---|
function_version_id | string Обязательное поле. Идентификатор версии для установки тега. Чтобы получить идентификатор версии, используйте запрос FunctionService.ListVersions . |
tag | string Тег для установки версии. Значение должно соответствовать регулярному выражению [a-z][-_0-9a-z]* . |
Operation
Поле | Описание |
---|---|
id | string Идентификатор операции. |
description | string Описание операции. Длина описания должна быть от 0 до 256 символов. |
created_at | google.protobuf.Timestamp Время создания ресурса в формате в RFC3339. |
created_by | string Идентификатор пользователя или сервисного аккаунта, инициировавшего операцию. |
modified_at | google.protobuf.Timestamp Время, когда ресурс Operation последний раз обновлялся. Значение в формате RFC3339. |
done | bool Если значение равно false — операция еще выполняется. Если true — операция завершена, и задано значение одного из полей error или response . |
metadata | google.protobuf.Any<SetFunctionTagMetadata> Метаданные операции. Обычно в поле содержится идентификатор ресурса, над которым выполняется операция. Если метод возвращает ресурс Operation, в описании метода приведена структура соответствующего ему поля metadata . |
result | oneof: error или response Результат операции. Если done == false и не было выявлено ошибок — значения полей error и response не заданы. Если done == false и была выявлена ошибка — задано значение поля error . Если done == true — задано значение ровно одного из полей error или response . |
error | google.rpc.Status Описание ошибки в случае сбоя или отмены операции. |
response | google.protobuf.Any<Version> в случае успешного выполнения операции. |
SetFunctionTagMetadata
Поле | Описание |
---|---|
function_version_id | string Идентификатор версии функции, для которой добавляется тег. |
Version
Поле | Описание |
---|---|
id | string Идентификатор версии. |
function_id | string Идентификатор функции, которой принадлежит версия. |
description | string Описание версии. Длина строки в символах должна быть от 0 до 256. |
created_at | google.protobuf.Timestamp Время создания версии. |
runtime | string Идентификатор среды выполнения для функции. Поддерживаемые среды и их идентификаторы перечислены в списке Среда выполнения. |
entrypoint | string Точка входа для функции: имя функции, вызываемой в качестве обработчика. Указывается в формате <function file name>.<handler name> , например, index.myFunction . |
resources | Resources Ресурсы, выделенные для версии. |
execution_timeout | google.protobuf.Duration Таймаут для выполнения версии. Если время ожидания будет превышено, Cloud Functions возвращает 504 HTTP-код. |
service_account_id | string Идентификатор сервисного аккаунта, который связан с версией. |
image_size | int64 Окончательный размер пакета развертывания после распаковки. |
status | enum Status Состояние версии.
|
tags[] | string Теги версий. Подробнее см. в Тег версии. |
log_group_id | string Идентификатор группы журналов выполнения для версии. |
environment | map<string,string> Параметры среды выполнения для версии. |
Resources
Поле | Описание |
---|---|
memory | int64 Объем памяти в байтах, доступный для версии. Допустимые значения — от 33554432 до 1073741824 включительно. |
RemoveTag
Удаляет тег из указанной версии функции.
rpc RemoveTag (RemoveFunctionTagRequest) returns (operation.Operation)
Метаданные и результат операции:
Operation.metadata:RemoveFunctionTagMetadata
Operation.response:Version
RemoveFunctionTagRequest
Поле | Описание |
---|---|
function_version_id | string Обязательное поле. Идентификатор версии, из которой нужно удалить тег. Чтобы получить идентификатор версии, используйте запрос FunctionService.ListVersions . |
tag | string Тег, который нужно удалить из указанной версии. Значение должно соответствовать регулярному выражению [a-z][-_0-9a-z]* . |
Operation
Поле | Описание |
---|---|
id | string Идентификатор операции. |
description | string Описание операции. Длина описания должна быть от 0 до 256 символов. |
created_at | google.protobuf.Timestamp Время создания ресурса в формате в RFC3339. |
created_by | string Идентификатор пользователя или сервисного аккаунта, инициировавшего операцию. |
modified_at | google.protobuf.Timestamp Время, когда ресурс Operation последний раз обновлялся. Значение в формате RFC3339. |
done | bool Если значение равно false — операция еще выполняется. Если true — операция завершена, и задано значение одного из полей error или response . |
metadata | google.protobuf.Any<RemoveFunctionTagMetadata> Метаданные операции. Обычно в поле содержится идентификатор ресурса, над которым выполняется операция. Если метод возвращает ресурс Operation, в описании метода приведена структура соответствующего ему поля metadata . |
result | oneof: error или response Результат операции. Если done == false и не было выявлено ошибок — значения полей error и response не заданы. Если done == false и была выявлена ошибка — задано значение поля error . Если done == true — задано значение ровно одного из полей error или response . |
error | google.rpc.Status Описание ошибки в случае сбоя или отмены операции. |
response | google.protobuf.Any<Version> в случае успешного выполнения операции. |
RemoveFunctionTagMetadata
Поле | Описание |
---|---|
function_version_id | string Идентификатор версии функции, для которой удаляется тег. |
Version
Поле | Описание |
---|---|
id | string Идентификатор версии. |
function_id | string Идентификатор функции, которой принадлежит версия. |
description | string Описание версии. Длина строки в символах должна быть от 0 до 256. |
created_at | google.protobuf.Timestamp Время создания версии. |
runtime | string Идентификатор среды выполнения для функции. Поддерживаемые среды и их идентификаторы перечислены в списке Среда выполнения. |
entrypoint | string Точка входа для функции: имя функции, вызываемой в качестве обработчика. Указывается в формате <function file name>.<handler name> , например, index.myFunction . |
resources | Resources Ресурсы, выделенные для версии. |
execution_timeout | google.protobuf.Duration Таймаут для выполнения версии. Если время ожидания будет превышено, Cloud Functions возвращает 504 HTTP-код. |
service_account_id | string Идентификатор сервисного аккаунта, который связан с версией. |
image_size | int64 Окончательный размер пакета развертывания после распаковки. |
status | enum Status Состояние версии.
|
tags[] | string Теги версий. Подробнее см. в Тег версии. |
log_group_id | string Идентификатор группы журналов выполнения для версии. |
environment | map<string,string> Параметры среды выполнения для версии. |
Resources
Поле | Описание |
---|---|
memory | int64 Объем памяти в байтах, доступный для версии. Допустимые значения — от 33554432 до 1073741824 включительно. |
ListTagHistory
Возвращает журнал тегов, назначенных версиям указанной функции.
rpc ListTagHistory (ListFunctionTagHistoryRequest) returns (ListFunctionTagHistoryResponse)
ListFunctionTagHistoryRequest
Поле | Описание |
---|---|
function_id | string Обязательное поле. Идентификатор функции для получения истории тегов. Чтобы получить идентификатор функции, используйте запрос FunctionService.List . |
tag | string Конкретный тег, которым должна быть ограничена история. Значение должно соответствовать регулярному выражению [a-z][-_0-9a-z]*|[$]latest . |
page_size | int64 Максимальное число возвращаемых результатов на странице. Если количество результатов больше чем pageSize , сервис вернет значение ListFunctionOperationsResponse.next_page_token, которое можно использовать для получения следующей страницы. Значение по умолчанию: 100. Допустимые значения — от 0 до 1000 включительно. |
page_token | string Токен страницы. Установите значение pageToken равным значению поля ListFunctionOperationsResponse.next_page_token предыдущего запроса, чтобы получить следующую страницу результатов. Максимальная длина строки в символах — 100. |
filter | string
|
ListFunctionTagHistoryResponse
Поле | Описание |
---|---|
function_tag_history_record[] | FunctionTagHistoryRecord Набор соответствующих записей истории тегов. |
next_page_token | string Токен для получения следующей страницы списка. Если количество результатов больше чем ListFunctionTagHistoryRequest.page_size, используйте nextPageToken в качестве значения параметра ListFunctionTagHistoryRequest.page_token в следующем запросе списка ресурсов. Все последующие запросы будут получать свои значения nextPageToken для перебора страниц результатов. |
FunctionTagHistoryRecord
Поле | Описание |
---|---|
function_id | string Идентификатор функции, для которой идет запись. |
function_version_id | string Идентификатор версии функции, для которой идет запись. |
tag | string Тег, который был установлен для версии в какой-то момент. |
effective_from | google.protobuf.Timestamp Отметка времени, когда тег начал быть активным для функции. |
effective_to | google.protobuf.Timestamp Отметка времени, когда тег перестал быть активным для функции. |
ListFunctionTagHistory
Устарел. Используйте ListTagHistory.
rpc ListFunctionTagHistory (ListFunctionTagHistoryRequest) returns (ListFunctionTagHistoryResponse)
ListFunctionTagHistoryRequest
Поле | Описание |
---|---|
function_id | string Обязательное поле. Идентификатор функции для получения истории тегов. Чтобы получить идентификатор функции, используйте запрос FunctionService.List . |
tag | string Конкретный тег, которым должна быть ограничена история. Значение должно соответствовать регулярному выражению [a-z][-_0-9a-z]*|[$]latest . |
page_size | int64 Максимальное число возвращаемых результатов на странице. Если количество результатов больше чем pageSize , сервис вернет значение ListFunctionOperationsResponse.next_page_token, которое можно использовать для получения следующей страницы. Значение по умолчанию: 100. Допустимые значения — от 0 до 1000 включительно. |
page_token | string Токен страницы. Установите значение pageToken равным значению поля ListFunctionOperationsResponse.next_page_token предыдущего запроса, чтобы получить следующую страницу результатов. Максимальная длина строки в символах — 100. |
filter | string
|
ListFunctionTagHistoryResponse
Поле | Описание |
---|---|
function_tag_history_record[] | FunctionTagHistoryRecord Набор соответствующих записей истории тегов. |
next_page_token | string Токен для получения следующей страницы списка. Если количество результатов больше чем ListFunctionTagHistoryRequest.page_size, используйте nextPageToken в качестве значения параметра ListFunctionTagHistoryRequest.page_token в следующем запросе списка ресурсов. Все последующие запросы будут получать свои значения nextPageToken для перебора страниц результатов. |
FunctionTagHistoryRecord
Поле | Описание |
---|---|
function_id | string Идентификатор функции, для которой идет запись. |
function_version_id | string Идентификатор версии функции, для которой идет запись. |
tag | string Тег, который был установлен для версии в какой-то момент. |
effective_from | google.protobuf.Timestamp Отметка времени, когда тег начал быть активным для функции. |
effective_to | google.protobuf.Timestamp Отметка времени, когда тег перестал быть активным для функции. |
CreateVersion
Создает версию для указанной функции.
rpc CreateVersion (CreateFunctionVersionRequest) returns (operation.Operation)
Метаданные и результат операции:
Operation.metadata:CreateFunctionVersionMetadata
Operation.response:Version
CreateFunctionVersionRequest
Поле | Описание |
---|---|
function_id | string Обязательное поле. Идентификатор функции для создания версии. Чтобы получить идентификатор функции, используйте запрос FunctionService.List . |
runtime | string Обязательное поле. Среда выполнения для версии. |
description | string Описание версии. Длина строки в символах должна быть от 0 до 256. |
entrypoint | string Обязательное поле. Точка входа для версии. |
resources | Resources Обязательное поле. Ресурсы, выделенные для версии. |
execution_timeout | google.protobuf.Duration Обязательное поле. Таймаут для выполнения версии. Если время ожидания будет превышено, Cloud Functions возвращает 504 HTTP-код. |
service_account_id | string Идентификатор сервисного аккаунта, который нужно связать с версией. |
package_source | oneof: package или content Источник пакета развертывания для версии. |
package | Package Пакет развертывания функций. |
content | bytes Содержимое пакета развертывания. Максимальная длина строки в символах — 52428800. |
environment | map<string,string> Параметры среды выполнения для версии. Максимальная длина строки в символах для каждого значения — 4096. Каждый ключ должен соответствовать регулярному выражению [a-zA-Z][a-zA-Z0-9_]* . |
Resources
Поле | Описание |
---|---|
memory | int64 Объем памяти в байтах, доступный для версии. Допустимые значения — от 33554432 до 1073741824 включительно. |
Package
Поле | Описание |
---|---|
bucket_name | string Обязательное поле. Имя бакета, в котором хранится код версии. |
object_name | string Обязательное поле. Имя объекта в корзине, в которой хранится код версии. |
sha256 | string SHA256-хэш пакета развертывания для версии. |
Operation
Поле | Описание |
---|---|
id | string Идентификатор операции. |
description | string Описание операции. Длина описания должна быть от 0 до 256 символов. |
created_at | google.protobuf.Timestamp Время создания ресурса в формате в RFC3339. |
created_by | string Идентификатор пользователя или сервисного аккаунта, инициировавшего операцию. |
modified_at | google.protobuf.Timestamp Время, когда ресурс Operation последний раз обновлялся. Значение в формате RFC3339. |
done | bool Если значение равно false — операция еще выполняется. Если true — операция завершена, и задано значение одного из полей error или response . |
metadata | google.protobuf.Any<CreateFunctionVersionMetadata> Метаданные операции. Обычно в поле содержится идентификатор ресурса, над которым выполняется операция. Если метод возвращает ресурс Operation, в описании метода приведена структура соответствующего ему поля metadata . |
result | oneof: error или response Результат операции. Если done == false и не было выявлено ошибок — значения полей error и response не заданы. Если done == false и была выявлена ошибка — задано значение поля error . Если done == true — задано значение ровно одного из полей error или response . |
error | google.rpc.Status Описание ошибки в случае сбоя или отмены операции. |
response | google.protobuf.Any<Version> в случае успешного выполнения операции. |
CreateFunctionVersionMetadata
Поле | Описание |
---|---|
function_version_id | string Идентификатор создаваемой версии. |
Version
Поле | Описание |
---|---|
id | string Идентификатор версии. |
function_id | string Идентификатор функции, которой принадлежит версия. |
description | string Описание версии. Длина строки в символах должна быть от 0 до 256. |
created_at | google.protobuf.Timestamp Время создания версии. |
runtime | string Идентификатор среды выполнения для функции. Поддерживаемые среды и их идентификаторы перечислены в списке Среда выполнения. |
entrypoint | string Точка входа для функции: имя функции, вызываемой в качестве обработчика. Указывается в формате <function file name>.<handler name> , например, index.myFunction . |
resources | Resources Ресурсы, выделенные для версии. |
execution_timeout | google.protobuf.Duration Таймаут для выполнения версии. Если время ожидания будет превышено, Cloud Functions возвращает 504 HTTP-код. |
service_account_id | string Идентификатор сервисного аккаунта, который связан с версией. |
image_size | int64 Окончательный размер пакета развертывания после распаковки. |
status | enum Status Состояние версии.
|
tags[] | string Теги версий. Подробнее см. в Тег версии. |
log_group_id | string Идентификатор группы журналов выполнения для версии. |
environment | map<string,string> Параметры среды выполнения для версии. |
Resources
Поле | Описание |
---|---|
memory | int64 Объем памяти в байтах, доступный для версии. Допустимые значения — от 33554432 до 1073741824 включительно. |
CreateFunctionVersion
Устарел. Используйте CreateVersion.
rpc CreateFunctionVersion (CreateFunctionVersionRequest) returns (operation.Operation)
Метаданные и результат операции:
Operation.metadata:CreateFunctionVersionMetadata
Operation.response:Version
CreateFunctionVersionRequest
Поле | Описание |
---|---|
function_id | string Обязательное поле. Идентификатор функции для создания версии. Чтобы получить идентификатор функции, используйте запрос FunctionService.List . |
runtime | string Обязательное поле. Среда выполнения для версии. |
description | string Описание версии. Длина строки в символах должна быть от 0 до 256. |
entrypoint | string Обязательное поле. Точка входа для версии. |
resources | Resources Обязательное поле. Ресурсы, выделенные для версии. |
execution_timeout | google.protobuf.Duration Обязательное поле. Таймаут для выполнения версии. Если время ожидания будет превышено, Cloud Functions возвращает 504 HTTP-код. |
service_account_id | string Идентификатор сервисного аккаунта, который нужно связать с версией. |
package_source | oneof: package или content Источник пакета развертывания для версии. |
package | Package Пакет развертывания функций. |
content | bytes Содержимое пакета развертывания. Максимальная длина строки в символах — 52428800. |
environment | map<string,string> Параметры среды выполнения для версии. Максимальная длина строки в символах для каждого значения — 4096. Каждый ключ должен соответствовать регулярному выражению [a-zA-Z][a-zA-Z0-9_]* . |
Resources
Поле | Описание |
---|---|
memory | int64 Объем памяти в байтах, доступный для версии. Допустимые значения — от 33554432 до 1073741824 включительно. |
Package
Поле | Описание |
---|---|
bucket_name | string Обязательное поле. Имя бакета, в котором хранится код версии. |
object_name | string Обязательное поле. Имя объекта в корзине, в которой хранится код версии. |
sha256 | string SHA256-хэш пакета развертывания для версии. |
Operation
Поле | Описание |
---|---|
id | string Идентификатор операции. |
description | string Описание операции. Длина описания должна быть от 0 до 256 символов. |
created_at | google.protobuf.Timestamp Время создания ресурса в формате в RFC3339. |
created_by | string Идентификатор пользователя или сервисного аккаунта, инициировавшего операцию. |
modified_at | google.protobuf.Timestamp Время, когда ресурс Operation последний раз обновлялся. Значение в формате RFC3339. |
done | bool Если значение равно false — операция еще выполняется. Если true — операция завершена, и задано значение одного из полей error или response . |
metadata | google.protobuf.Any<CreateFunctionVersionMetadata> Метаданные операции. Обычно в поле содержится идентификатор ресурса, над которым выполняется операция. Если метод возвращает ресурс Operation, в описании метода приведена структура соответствующего ему поля metadata . |
result | oneof: error или response Результат операции. Если done == false и не было выявлено ошибок — значения полей error и response не заданы. Если done == false и была выявлена ошибка — задано значение поля error . Если done == true — задано значение ровно одного из полей error или response . |
error | google.rpc.Status Описание ошибки в случае сбоя или отмены операции. |
response | google.protobuf.Any<Version> в случае успешного выполнения операции. |
CreateFunctionVersionMetadata
Поле | Описание |
---|---|
function_version_id | string Идентификатор создаваемой версии. |
Version
Поле | Описание |
---|---|
id | string Идентификатор версии. |
function_id | string Идентификатор функции, которой принадлежит версия. |
description | string Описание версии. Длина строки в символах должна быть от 0 до 256. |
created_at | google.protobuf.Timestamp Время создания версии. |
runtime | string Идентификатор среды выполнения для функции. Поддерживаемые среды и их идентификаторы перечислены в списке Среда выполнения. |
entrypoint | string Точка входа для функции: имя функции, вызываемой в качестве обработчика. Указывается в формате <function file name>.<handler name> , например, index.myFunction . |
resources | Resources Ресурсы, выделенные для версии. |
execution_timeout | google.protobuf.Duration Таймаут для выполнения версии. Если время ожидания будет превышено, Cloud Functions возвращает 504 HTTP-код. |
service_account_id | string Идентификатор сервисного аккаунта, который связан с версией. |
image_size | int64 Окончательный размер пакета развертывания после распаковки. |
status | enum Status Состояние версии.
|
tags[] | string Теги версий. Подробнее см. в Тег версии. |
log_group_id | string Идентификатор группы журналов выполнения для версии. |
environment | map<string,string> Параметры среды выполнения для версии. |
Resources
Поле | Описание |
---|---|
memory | int64 Объем памяти в байтах, доступный для версии. Допустимые значения — от 33554432 до 1073741824 включительно. |
ListRuntimes
Список доступных сред выполнения для указанной функции.
rpc ListRuntimes (ListRuntimesRequest) returns (ListRuntimesResponse)
ListRuntimesRequest
ListRuntimesResponse
Поле | Описание |
---|---|
runtimes[] | string Среды выполнения, доступные для указанной функции. |
ListOperations
Возвращает список операций для указанной функции.
rpc ListOperations (ListFunctionOperationsRequest) returns (ListFunctionOperationsResponse)
ListFunctionOperationsRequest
Поле | Описание |
---|---|
function_id | string Обязательное поле. Идентификатор функции, для которой нужно вернуть список версий. |
page_size | int64 Максимальное число возвращаемых результатов на странице. Если количество результатов больше чем pageSize , сервис вернет значение ListFunctionOperationsResponse.next_page_token, которое можно использовать для получения следующей страницы. Значение по умолчанию: 100. Допустимые значения — от 0 до 1000 включительно. |
page_token | string Токен страницы. Установите значение pageToken равным значению поля ListFunctionOperationsResponse.next_page_token предыдущего запроса, чтобы получить следующую страницу результатов. Максимальная длина строки в символах — 100. |
filter | string
|
ListFunctionOperationsResponse
Поле | Описание |
---|---|
operations[] | operation.Operation Список операций для указанной функции. |
next_page_token | string Токен для получения следующей страницы списка. Если количество результатов больше чем ListFunctionOperationsRequest.page_size, используйте nextPageToken в качестве значения параметра ListFunctionOperationsRequest.page_token в следующем запросе списка ресурсов. Все последующие запросы будут получать свои значения nextPageToken для перебора страниц результатов. |
Operation
Поле | Описание |
---|---|
id | string Идентификатор операции. |
description | string Описание операции. Длина описания должна быть от 0 до 256 символов. |
created_at | google.protobuf.Timestamp Время создания ресурса в формате в RFC3339. |
created_by | string Идентификатор пользователя или сервисного аккаунта, инициировавшего операцию. |
modified_at | google.protobuf.Timestamp Время, когда ресурс Operation последний раз обновлялся. Значение в формате RFC3339. |
done | bool Если значение равно false — операция еще выполняется. Если true — операция завершена, и задано значение одного из полей error или response . |
metadata | google.protobuf.Any Метаданные операции. Обычно в поле содержится идентификатор ресурса, над которым выполняется операция. Если метод возвращает ресурс Operation, в описании метода приведена структура соответствующего ему поля metadata . |
result | oneof: error или response Результат операции. Если done == false и не было выявлено ошибок — значения полей error и response не заданы. Если done == false и была выявлена ошибка — задано значение поля error . Если done == true — задано значение ровно одного из полей error или response . |
error | google.rpc.Status Описание ошибки в случае сбоя или отмены операции. |
response | google.protobuf.Any Результат операции в случае успешного завершения. Если исходный метод не возвращает никаких данных при успешном завершении, например метод Delete, поле содержит объект google.protobuf.Empty. Если исходный метод — это стандартный метод Create / Update, поле содержит целевой ресурс операции. Если метод возвращает ресурс Operation, в описании метода приведена структура соответствующего ему поля response . |
ListAccessBindings
Возвращает список привязок прав доступа для указанной функции.
rpc ListAccessBindings (ListAccessBindingsRequest) returns (ListAccessBindingsResponse)
ListAccessBindingsRequest
Поле | Описание |
---|---|
resource_id | string Обязательное поле. Идентификатор ресурса, для которого запрашивается список привязок прав доступа. Чтобы получить идентификатор ресурса, используйте соответствующий запрос List. Например, используйте запрос yandex.cloud.resourcemanager.v1.CloudService.List для получения идентификатора ресурса Cloud. Максимальная длина строки в символах — 50. |
page_size | int64 Максимальное число возвращаемых результатов на странице. Если количество результатов больше чем page_size , сервис вернет значение ListAccessBindingsResponse.next_page_token, которое можно использовать для получения следующей страницы. Значение по умолчанию: 100. Максимальное значение — 1000. |
page_token | string Токен страницы. Установите значение page_token равным значению поля ListAccessBindingsResponse.next_page_token прошлого запроса, чтобы получить следующую страницу результатов. Максимальная длина строки в символах — 100. |
ListAccessBindingsResponse
Поле | Описание |
---|---|
access_bindings[] | AccessBinding Список привязок прав доступа для указанного ресурса. |
next_page_token | string Токен для получения следующей страницы результатов в ответе. Если количество результатов больше чем ListAccessBindingsRequest.page_size, используйте next_page_token в качестве значения параметра ListAccessBindingsRequest.page_token в следующем запросе списка ресурсов. Все последующие запросы будут получать свои значения next_page_token для перебора страниц результатов. |
AccessBinding
Поле | Описание |
---|---|
role_id | string Обязательное поле. Идентификатор ресурса yandex.cloud.iam.v1.Role который назначен для субъекта, указанного в параметре subject . Максимальная длина строки в символах — 50. |
subject | Subject Обязательное поле. Субъект, для которого создается привязка прав доступа. Может представлять собой аккаунт с уникальным идентификатором в облаке или системную группу с общим системным идентификатором. |
Subject
Поле | Описание |
---|---|
id | string Обязательное поле.
|
type | string Обязательное поле.
|
SetAccessBindings
Устанавливает привязки прав доступа для указанной функции.
rpc SetAccessBindings (SetAccessBindingsRequest) returns (operation.Operation)
Метаданные и результат операции:
Operation.metadata:SetAccessBindingsMetadata
Operation.response:google.protobuf.Empty
SetAccessBindingsRequest
Поле | Описание |
---|---|
resource_id | string Обязательное поле. Идентификатор ресурса, для которого задается список привязок прав доступа. Чтобы получить идентификатор ресурса, используйте соответствующий запрос List. Максимальная длина строки в символах — 50. |
access_bindings[] | AccessBinding Обязательное поле. Привязки прав доступа, которые будут установлены. Дополнительные сведения см. в разделе Привязка прав доступа. |
AccessBinding
Поле | Описание |
---|---|
role_id | string Обязательное поле. Идентификатор ресурса yandex.cloud.iam.v1.Role который назначен для субъекта, указанного в параметре subject . Максимальная длина строки в символах — 50. |
subject | Subject Обязательное поле. Субъект, для которого создается привязка прав доступа. Может представлять собой аккаунт с уникальным идентификатором в облаке или системную группу с общим системным идентификатором. |
Subject
Поле | Описание |
---|---|
id | string Обязательное поле.
|
type | string Обязательное поле.
|
Operation
Поле | Описание |
---|---|
id | string Идентификатор операции. |
description | string Описание операции. Длина описания должна быть от 0 до 256 символов. |
created_at | google.protobuf.Timestamp Время создания ресурса в формате в RFC3339. |
created_by | string Идентификатор пользователя или сервисного аккаунта, инициировавшего операцию. |
modified_at | google.protobuf.Timestamp Время, когда ресурс Operation последний раз обновлялся. Значение в формате RFC3339. |
done | bool Если значение равно false — операция еще выполняется. Если true — операция завершена, и задано значение одного из полей error или response . |
metadata | google.protobuf.Any<SetAccessBindingsMetadata> Метаданные операции. Обычно в поле содержится идентификатор ресурса, над которым выполняется операция. Если метод возвращает ресурс Operation, в описании метода приведена структура соответствующего ему поля metadata . |
result | oneof: error или response Результат операции. Если done == false и не было выявлено ошибок — значения полей error и response не заданы. Если done == false и была выявлена ошибка — задано значение поля error . Если done == true — задано значение ровно одного из полей error или response . |
error | google.rpc.Status Описание ошибки в случае сбоя или отмены операции. |
response | google.protobuf.Any<google.protobuf.Empty> в случае успешного выполнения операции. |
SetAccessBindingsMetadata
Поле | Описание |
---|---|
resource_id | string Идентификатор ресурса, для которого задается список привязок прав доступа. |
UpdateAccessBindings
Обновляет привязки прав доступа для указанной функции.
rpc UpdateAccessBindings (UpdateAccessBindingsRequest) returns (operation.Operation)
Метаданные и результат операции:
Operation.metadata:UpdateAccessBindingsMetadata
Operation.response:google.protobuf.Empty
UpdateAccessBindingsRequest
Поле | Описание |
---|---|
resource_id | string Обязательное поле. Идентификатор ресурса, для которого обновляется список привязок прав доступа. Максимальная длина строки в символах — 50. |
access_binding_deltas[] | AccessBindingDelta Обязательное поле. Изменения в список привязок прав доступа. Количество элементов должно быть больше 0. |
AccessBindingDelta
Поле | Описание |
---|---|
action | enum AccessBindingAction Обязательное поле. Действие, которое надо выполнить с привязкой прав доступа.
|
access_binding | AccessBinding Обязательное поле. Привязка прав доступа. Дополнительные сведения см. в разделе Привязка прав доступа. |
AccessBinding
Поле | Описание |
---|---|
role_id | string Обязательное поле. Идентификатор ресурса yandex.cloud.iam.v1.Role который назначен для субъекта, указанного в параметре subject . Максимальная длина строки в символах — 50. |
subject | Subject Обязательное поле. Субъект, для которого создается привязка прав доступа. Может представлять собой аккаунт с уникальным идентификатором в облаке или системную группу с общим системным идентификатором. |
Subject
Поле | Описание |
---|---|
id | string Обязательное поле.
|
type | string Обязательное поле.
|
Operation
Поле | Описание |
---|---|
id | string Идентификатор операции. |
description | string Описание операции. Длина описания должна быть от 0 до 256 символов. |
created_at | google.protobuf.Timestamp Время создания ресурса в формате в RFC3339. |
created_by | string Идентификатор пользователя или сервисного аккаунта, инициировавшего операцию. |
modified_at | google.protobuf.Timestamp Время, когда ресурс Operation последний раз обновлялся. Значение в формате RFC3339. |
done | bool Если значение равно false — операция еще выполняется. Если true — операция завершена, и задано значение одного из полей error или response . |
metadata | google.protobuf.Any<UpdateAccessBindingsMetadata> Метаданные операции. Обычно в поле содержится идентификатор ресурса, над которым выполняется операция. Если метод возвращает ресурс Operation, в описании метода приведена структура соответствующего ему поля metadata . |
result | oneof: error или response Результат операции. Если done == false и не было выявлено ошибок — значения полей error и response не заданы. Если done == false и была выявлена ошибка — задано значение поля error . Если done == true — задано значение ровно одного из полей error или response . |
error | google.rpc.Status Описание ошибки в случае сбоя или отмены операции. |
response | google.protobuf.Any<google.protobuf.Empty> в случае успешного выполнения операции. |
UpdateAccessBindingsMetadata
Поле | Описание |
---|---|
resource_id | string Идентификатор ресурса, для которого обновляется список привязок прав доступа. |