Serverless Containers Service, gRPC: ContainerService

A set of methods for managing serverless containers.

Call	Description
Get	Returns the specified container.
List	Retrieves the list of containers in the specified folder.
Create	Creates a container in the specified folder.
Update	Updates the specified container.
Delete	Deletes the specified container.
DeployRevision	Deploys a revision for the specified container.
Rollback	Rollback the specified container to an old revision.
GetRevision	Returns the specified revision of a container.
ListRevisions	Retrieves the list of revisions for the specified container, or of all container revisions in the specified folder.
ListOperations	Lists operations for the specified container.
ListAccessBindings	Lists existing access bindings for the specified container.
SetAccessBindings	Sets access bindings for the container.
UpdateAccessBindings	Updates access bindings for the specified container.

Calls ContainerServiceCalls ContainerService

GetGet

Returns the specified container.
To get the list of all available containers, make a List request.

rpc Get (GetContainerRequest) returns (Container)

GetContainerRequestGetContainerRequest

Field	Description
container_id	string Required. ID of the container to return. To get a container ID make a ContainerService.List request.

ContainerContainer

Field	Description
id	string ID of the container. Generated at creation time.
folder_id	string ID of the folder that the container belongs to.
created_at	google.protobuf.Timestamp Creation timestamp for the container.
name	string Name of the container. The name is unique within the folder.
description	string Description of the container.
labels	map<string,string> Container labels as key:value pairs.
url	string URL that needs to be requested to call the container.
status	enum Status Status of the container. CREATING: Container is being created. ACTIVE: Container is ready for use. DELETING: Container is being deleted. ERROR: Container failed. The only allowed action is delete.

ListList

Retrieves the list of containers in the specified folder.

rpc List (ListContainersRequest) returns (ListContainersResponse)

ListContainersRequestListContainersRequest

Field	Description
folder_id	string Required. ID of the folder to list containers 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 ListContainersResponse.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 ListContainersResponse.next_page_token returned by a previous list request.
filter	string A filter expression that filters containers listed in the response. The expression must specify: The field name. Currently filtering can only be applied to the Container.name field. An = operator. 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-container".

ListContainersResponseListContainersResponse

Field	Description
containers[]	Container List of containers 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 ListContainersRequest.page_size, use nextPageToken as the value for the ListContainersRequest.page_token parameter in the next list request. Each subsequent page will have its own nextPageToken to continue paging through the results.

ContainerContainer

Field	Description
id	string ID of the container. Generated at creation time.
folder_id	string ID of the folder that the container belongs to.
created_at	google.protobuf.Timestamp Creation timestamp for the container.
name	string Name of the container. The name is unique within the folder.
description	string Description of the container.
labels	map<string,string> Container labels as key:value pairs.
url	string URL that needs to be requested to call the container.
status	enum Status Status of the container. CREATING: Container is being created. ACTIVE: Container is ready for use. DELETING: Container is being deleted. ERROR: Container failed. The only allowed action is delete.

CreateCreate

Creates a container in the specified folder.

rpc Create (CreateContainerRequest) returns (operation.Operation)

Metadata and response of Operation:

    Operation.metadata:CreateContainerMetadata

    Operation.response:Container

CreateContainerRequestCreateContainerRequest

Field	Description
folder_id	string Required. ID of the folder to create a container in. To get a folder ID make a yandex.cloud.resourcemanager.v1.FolderService.List request.
name	string Name of the container. 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 container. 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]*.

OperationOperation

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<CreateContainerMetadata> 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<Container> if operation finished successfully.

CreateContainerMetadataCreateContainerMetadata

Field	Description
container_id	string ID of the container that is being created.

ContainerContainer

Field	Description
id	string ID of the container. Generated at creation time.
folder_id	string ID of the folder that the container belongs to.
created_at	google.protobuf.Timestamp Creation timestamp for the container.
name	string Name of the container. The name is unique within the folder.
description	string Description of the container.
labels	map<string,string> Container labels as key:value pairs.
url	string URL that needs to be requested to call the container.
status	enum Status Status of the container. CREATING: Container is being created. ACTIVE: Container is ready for use. DELETING: Container is being deleted. ERROR: Container failed. The only allowed action is delete.

UpdateUpdate

Updates the specified container.

rpc Update (UpdateContainerRequest) returns (operation.Operation)

Metadata and response of Operation:

    Operation.metadata:UpdateContainerMetadata

    Operation.response:Container

UpdateContainerRequestUpdateContainerRequest

Field	Description
container_id	string Required. ID of the container to update. To get a container ID make a ContainerService.List request.
update_mask	google.protobuf.FieldMask Field mask that specifies which attributes of the container should be updated.
name	string New name for the container. 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 container. The maximum string length in characters is 256.
labels	map<string,string> Container 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 ContainerService.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]*.

OperationOperation

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<UpdateContainerMetadata> 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<Container> if operation finished successfully.

UpdateContainerMetadataUpdateContainerMetadata

Field	Description
container_id	string ID of the container that is being updated.

ContainerContainer

Field	Description
id	string ID of the container. Generated at creation time.
folder_id	string ID of the folder that the container belongs to.
created_at	google.protobuf.Timestamp Creation timestamp for the container.
name	string Name of the container. The name is unique within the folder.
description	string Description of the container.
labels	map<string,string> Container labels as key:value pairs.
url	string URL that needs to be requested to call the container.
status	enum Status Status of the container. CREATING: Container is being created. ACTIVE: Container is ready for use. DELETING: Container is being deleted. ERROR: Container failed. The only allowed action is delete.

DeleteDelete

Deletes the specified container.

rpc Delete (DeleteContainerRequest) returns (operation.Operation)

Metadata and response of Operation:

    Operation.metadata:DeleteContainerMetadata

    Operation.response:google.protobuf.Empty

DeleteContainerRequestDeleteContainerRequest

Field	Description
container_id	string Required. ID of the container to delete. To get a container ID make a ContainerService.List request.

OperationOperation

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

DeleteContainerMetadataDeleteContainerMetadata

Field	Description
container_id	string ID of the container that is being deleted.

DeployRevisionDeployRevision

Deploys a revision for the specified container.

rpc DeployRevision (DeployContainerRevisionRequest) returns (operation.Operation)

Metadata and response of Operation:

    Operation.metadata:DeployContainerRevisionMetadata

    Operation.response:Revision

DeployContainerRevisionRequestDeployContainerRevisionRequest

Field	Description
container_id	string Required. ID of the container to create a revision for. To get a container ID, make a ContainerService.List request.
description	string Description of the revision.
resources	Resources Required. Resources allocated to the revision.
execution_timeout	google.protobuf.Duration Timeout for the execution of the revision. If the timeout is exceeded, Serverless Containers responds with a 504 HTTP code. The maximum value is 600s.
service_account_id	string ID of the service account to associate with the revision.
image_spec	ImageSpec Required. Image configuration for the revision.
concurrency	int64 The number of concurrent requests allowed per container instance. The default value is 1.
secrets[]	Secret Yandex Lockbox secrets to be used by the revision.
connectivity	Connectivity Network access. If specified the revision will be attached to specified network/subnet(s).
provision_policy	ProvisionPolicy Policy for provisioning instances of the revision. The policy is only applied when the revision is ACTIVE.
scaling_policy	ScalingPolicy Policy for scaling instances of the revision.
log_options	LogOptions Options for logging from the container.
storage_mounts[]	StorageMount S3 mounts to be used by the revision.
mounts[]	Mount Mounts to be used by the revision.

ResourcesResources

Field	Description
memory	int64 Amount of memory available to the revision, specified in bytes, multiple of 128MB. Acceptable values are 134217728 to 8589934592, inclusive.
cores	int64 Number of cores available to the revision. Acceptable values are 0 to 4, inclusive.
core_fraction	int64 Specifies baseline performance for a core in percent, multiple of 5%. Should be 100% for cores > 1. Acceptable values are 0 to 100, inclusive.

ImageSpecImageSpec

Field	Description
image_url	string Required. Image URL, that is used by the revision.
command	Command Override for the image's ENTRYPOINT.
args	Args Override for the image's CMD.
environment	map<string,string> Additional environment for the container. 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_]*.
working_dir	string Override for the image's WORKDIR.

CommandCommand

Field	Description
command[]	string Command that will override ENTRYPOINT of an image. Commands will be executed as is. The runtime will not substitute environment variables or execute shell commands. If one wants to do that, they should invoke shell interpreter with an appropriate shell script.

ArgsArgs

Field	Description
args[]	string Arguments that will override CMD of an image. Arguments will be passed as is. The runtime will not substitute environment variables or execute shell commands. If one wants to do that, they should invoke shell interpreter with an appropriate shell script.

SecretSecret

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

ConnectivityConnectivity

Field	Description
network_id	string Network the revision will have access to.
subnet_ids[]	string The list of subnets (from the same network) the revision can be attached to. Deprecated, it is sufficient to specify only network_id, without the list of subnet_ids. The string length in characters for each value must be greater than 0.

ProvisionPolicyProvisionPolicy

Field	Description
min_instances	int64 Minimum number of guaranteed provisioned container instances for all zones in total.

ScalingPolicyScalingPolicy

Field	Description
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.

LogOptionsLogOptions

Field	Description
disabled	bool Is logging from container 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.

StorageMountStorageMount

Field	Description
bucket_id	string Required. S3 bucket name for mounting. The string length in characters must be 3-63. Value must match the regular expression [-.0-9a-zA-Z]*.
prefix	string S3 bucket prefix for mounting.
read_only	bool Is mount read only.
mount_point_path	string Required. Mount point path inside the container for mounting. The string length in characters must be 1-300. Value must match the regular expression [-_0-9a-zA-Z/]*.

MountMount

Field	Description
mount_point_path	string Required. The absolute mount point path inside the container for mounting. The string length in characters must be 1-300. Value must match the regular expression [-_0-9a-zA-Z/]*.
mode	enum Mode Mount's mode
target	oneof: object_storage or ephemeral_disk_spec Target mount option
object_storage	ObjectStorage Object storage mounts
ephemeral_disk_spec	DiskSpec Working disk (worker-local non-shared read-write NBS disk templates)

ObjectStorageObjectStorage

Field	Description
bucket_id	string Required. ObjectStorage bucket name for mounting. The string length in characters must be 3-63. Value must match the regular expression [-.0-9a-zA-Z]*.
prefix	string ObjectStorage bucket prefix for mounting.

DiskSpecDiskSpec

Field	Description
size	int64 The size of disk for mount in bytes Value must be greater than 0.
block_size	int64 Optional block size of disk for mount in bytes

OperationOperation

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<DeployContainerRevisionMetadata> 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<Revision> if operation finished successfully.

DeployContainerRevisionMetadataDeployContainerRevisionMetadata

Field	Description
container_revision_id	string ID of the revision that is being created.

RevisionRevision

Field	Description
id	string ID of the revision.
container_id	string ID of the container that the revision belongs to.
description	string Description of the revision.
created_at	google.protobuf.Timestamp Creation timestamp for the revision.
image	Image Image configuration for the revision.
resources	Resources Resources allocated to the revision.
execution_timeout	google.protobuf.Duration Timeout for the execution of the revision. If the timeout is exceeded, Serverless Containers responds with a 504 HTTP code.
concurrency	int64 The number of concurrent requests allowed per container instance.
service_account_id	string ID of the service account associated with the revision.
status	enum Status Status of the revision. CREATING: Revision is being created. ACTIVE: Revision is currently used by the container. OBSOLETE: Revision is not used by the container. May be deleted later.
secrets[]	Secret Yandex Lockbox secrets to be used by the revision.
connectivity	Connectivity Network access. If specified the revision will be attached to specified network/subnet(s).
provision_policy	ProvisionPolicy Policy for provisioning instances of the revision. The policy is only applied when the revision is ACTIVE.
scaling_policy	ScalingPolicy Policy for scaling instances of the revision.
log_options	LogOptions Options for logging from the container.
storage_mounts[]	StorageMount S3 mounts to be used by the revision.
mounts[]	Mount Mounts to be used by the revision.

ImageImage

Field	Description
image_url	string Image URL, that is used by the revision.
image_digest	string Digest of the image. Calculated at creation time.
command	Command Override for the image's ENTRYPOINT.
args	Args Override for the image's CMD.
environment	map<string,string> Additional environment for the container. 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_]*.
working_dir	string Override for the image's WORKDIR.

RollbackRollback

Rollback the specified container to an old revision.

rpc Rollback (RollbackContainerRequest) returns (operation.Operation)

Metadata and response of Operation:

    Operation.metadata:RollbackContainerMetadata

    Operation.response:Container

RollbackContainerRequestRollbackContainerRequest

Field	Description
container_id	string Required. ID of the container to rollback to an old revision. To get a container ID, make a ContainerService.List request.
revision_id	string Required. ID of the revision to rollback to. To get a revision ID make a ContainerService.ListRevisions request.

OperationOperation

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<RollbackContainerMetadata> 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<Container> if operation finished successfully.

RollbackContainerMetadataRollbackContainerMetadata

Field	Description
container_id	string ID of the container that is being rolled back.
revision_id	string ID of the revision that the container is being rolled back to.

ContainerContainer

Field	Description
id	string ID of the container. Generated at creation time.
folder_id	string ID of the folder that the container belongs to.
created_at	google.protobuf.Timestamp Creation timestamp for the container.
name	string Name of the container. The name is unique within the folder.
description	string Description of the container.
labels	map<string,string> Container labels as key:value pairs.
url	string URL that needs to be requested to call the container.
status	enum Status Status of the container. CREATING: Container is being created. ACTIVE: Container is ready for use. DELETING: Container is being deleted. ERROR: Container failed. The only allowed action is delete.

GetRevisionGetRevision

Returns the specified revision of a container.
To get the list of available revision, make a ListRevisions request.

rpc GetRevision (GetContainerRevisionRequest) returns (Revision)

GetContainerRevisionRequestGetContainerRevisionRequest

Field	Description
container_revision_id	string Required. ID of the revision to return. To get a revision ID make a ContainerService.ListRevisions request.

RevisionRevision

Field	Description
id	string ID of the revision.
container_id	string ID of the container that the revision belongs to.
description	string Description of the revision.
created_at	google.protobuf.Timestamp Creation timestamp for the revision.
image	Image Image configuration for the revision.
resources	Resources Resources allocated to the revision.
execution_timeout	google.protobuf.Duration Timeout for the execution of the revision. If the timeout is exceeded, Serverless Containers responds with a 504 HTTP code.
concurrency	int64 The number of concurrent requests allowed per container instance.
service_account_id	string ID of the service account associated with the revision.
status	enum Status Status of the revision. CREATING: Revision is being created. ACTIVE: Revision is currently used by the container. OBSOLETE: Revision is not used by the container. May be deleted later.
secrets[]	Secret Yandex Lockbox secrets to be used by the revision.
connectivity	Connectivity Network access. If specified the revision will be attached to specified network/subnet(s).
provision_policy	ProvisionPolicy Policy for provisioning instances of the revision. The policy is only applied when the revision is ACTIVE.
scaling_policy	ScalingPolicy Policy for scaling instances of the revision.
log_options	LogOptions Options for logging from the container.
storage_mounts[]	StorageMount S3 mounts to be used by the revision.
mounts[]	Mount Mounts to be used by the revision.

ImageImage

Field	Description
image_url	string Image URL, that is used by the revision.
image_digest	string Digest of the image. Calculated at creation time.
command	Command Override for the image's ENTRYPOINT.
args	Args Override for the image's CMD.
environment	map<string,string> Additional environment for the container. 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_]*.
working_dir	string Override for the image's WORKDIR.

CommandCommand

Field	Description
command[]	string Command that will override ENTRYPOINT of an image. Commands will be executed as is. The runtime will not substitute environment variables or execute shell commands. If one wants to do that, they should invoke shell interpreter with an appropriate shell script.

ArgsArgs

Field	Description
args[]	string Arguments that will override CMD of an image. Arguments will be passed as is. The runtime will not substitute environment variables or execute shell commands. If one wants to do that, they should invoke shell interpreter with an appropriate shell script.

ResourcesResources

Field	Description
memory	int64 Amount of memory available to the revision, specified in bytes, multiple of 128MB. Acceptable values are 134217728 to 8589934592, inclusive.
cores	int64 Number of cores available to the revision. Acceptable values are 0 to 4, inclusive.
core_fraction	int64 Specifies baseline performance for a core in percent, multiple of 5%. Should be 100% for cores > 1. Acceptable values are 0 to 100, inclusive.

SecretSecret

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

ConnectivityConnectivity

Field	Description
network_id	string Network the revision will have access to.
subnet_ids[]	string The list of subnets (from the same network) the revision can be attached to. Deprecated, it is sufficient to specify only network_id, without the list of subnet_ids. The string length in characters for each value must be greater than 0.

ProvisionPolicyProvisionPolicy

Field	Description
min_instances	int64 Minimum number of guaranteed provisioned container instances for all zones in total.

ScalingPolicyScalingPolicy

Field	Description
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.

LogOptionsLogOptions

Field	Description
disabled	bool Is logging from container 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.

StorageMountStorageMount

Field	Description
bucket_id	string Required. S3 bucket name for mounting. The string length in characters must be 3-63. Value must match the regular expression [-.0-9a-zA-Z]*.
prefix	string S3 bucket prefix for mounting.
read_only	bool Is mount read only.
mount_point_path	string Required. Mount point path inside the container for mounting. The string length in characters must be 1-300. Value must match the regular expression [-_0-9a-zA-Z/]*.

MountMount

Field	Description
mount_point_path	string Required. The absolute mount point path inside the container for mounting. The string length in characters must be 1-300. Value must match the regular expression [-_0-9a-zA-Z/]*.
mode	enum Mode Mount's mode
target	oneof: object_storage or ephemeral_disk_spec Target mount option
object_storage	ObjectStorage Object storage mounts
ephemeral_disk_spec	DiskSpec Working disk (worker-local non-shared read-write NBS disk templates)

ObjectStorageObjectStorage

Field	Description
bucket_id	string Required. ObjectStorage bucket name for mounting. The string length in characters must be 3-63. Value must match the regular expression [-.0-9a-zA-Z]*.
prefix	string ObjectStorage bucket prefix for mounting.

DiskSpecDiskSpec

Field	Description
size	int64 The size of disk for mount in bytes Value must be greater than 0.
block_size	int64 Optional block size of disk for mount in bytes

ListRevisionsListRevisions

Retrieves the list of revisions for the specified container, or of all container revisions in the specified folder.

rpc ListRevisions (ListContainersRevisionsRequest) returns (ListContainersRevisionsResponse)

ListContainersRevisionsRequestListContainersRevisionsRequest

Field	Description
id	oneof: folder_id or container_id
folder_id	string ID of the folder to list container revisions for. To get a folder ID make a yandex.cloud.resourcemanager.v1.FolderService.List request.
container_id	string ID of the container to list revisions for. To get a container ID use a ContainerService.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 ListContainersRevisionsResponse.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 ListContainersRevisionsResponse.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: The field name. Currently filtering can only be applied to the Revision.status and Revision.runtime fields. An = operator. 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.

ListContainersRevisionsResponseListContainersRevisionsResponse

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

RevisionRevision

Field	Description
id	string ID of the revision.
container_id	string ID of the container that the revision belongs to.
description	string Description of the revision.
created_at	google.protobuf.Timestamp Creation timestamp for the revision.
image	Image Image configuration for the revision.
resources	Resources Resources allocated to the revision.
execution_timeout	google.protobuf.Duration Timeout for the execution of the revision. If the timeout is exceeded, Serverless Containers responds with a 504 HTTP code.
concurrency	int64 The number of concurrent requests allowed per container instance.
service_account_id	string ID of the service account associated with the revision.
status	enum Status Status of the revision. CREATING: Revision is being created. ACTIVE: Revision is currently used by the container. OBSOLETE: Revision is not used by the container. May be deleted later.
secrets[]	Secret Yandex Lockbox secrets to be used by the revision.
connectivity	Connectivity Network access. If specified the revision will be attached to specified network/subnet(s).
provision_policy	ProvisionPolicy Policy for provisioning instances of the revision. The policy is only applied when the revision is ACTIVE.
scaling_policy	ScalingPolicy Policy for scaling instances of the revision.
log_options	LogOptions Options for logging from the container.
storage_mounts[]	StorageMount S3 mounts to be used by the revision.
mounts[]	Mount Mounts to be used by the revision.

ImageImage

Field	Description
image_url	string Image URL, that is used by the revision.
image_digest	string Digest of the image. Calculated at creation time.
command	Command Override for the image's ENTRYPOINT.
args	Args Override for the image's CMD.
environment	map<string,string> Additional environment for the container. 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_]*.
working_dir	string Override for the image's WORKDIR.

CommandCommand

Field	Description
command[]	string Command that will override ENTRYPOINT of an image. Commands will be executed as is. The runtime will not substitute environment variables or execute shell commands. If one wants to do that, they should invoke shell interpreter with an appropriate shell script.

ArgsArgs

Field	Description
args[]	string Arguments that will override CMD of an image. Arguments will be passed as is. The runtime will not substitute environment variables or execute shell commands. If one wants to do that, they should invoke shell interpreter with an appropriate shell script.

ResourcesResources

Field	Description
memory	int64 Amount of memory available to the revision, specified in bytes, multiple of 128MB. Acceptable values are 134217728 to 8589934592, inclusive.
cores	int64 Number of cores available to the revision. Acceptable values are 0 to 4, inclusive.
core_fraction	int64 Specifies baseline performance for a core in percent, multiple of 5%. Should be 100% for cores > 1. Acceptable values are 0 to 100, inclusive.

SecretSecret

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

ConnectivityConnectivity

Field	Description
network_id	string Network the revision will have access to.
subnet_ids[]	string The list of subnets (from the same network) the revision can be attached to. Deprecated, it is sufficient to specify only network_id, without the list of subnet_ids. The string length in characters for each value must be greater than 0.

ProvisionPolicyProvisionPolicy

Field	Description
min_instances	int64 Minimum number of guaranteed provisioned container instances for all zones in total.

ScalingPolicyScalingPolicy

Field	Description
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.

LogOptionsLogOptions

Field	Description
disabled	bool Is logging from container 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.

StorageMountStorageMount

Field	Description
bucket_id	string Required. S3 bucket name for mounting. The string length in characters must be 3-63. Value must match the regular expression [-.0-9a-zA-Z]*.
prefix	string S3 bucket prefix for mounting.
read_only	bool Is mount read only.
mount_point_path	string Required. Mount point path inside the container for mounting. The string length in characters must be 1-300. Value must match the regular expression [-_0-9a-zA-Z/]*.

MountMount

Field	Description
mount_point_path	string Required. The absolute mount point path inside the container for mounting. The string length in characters must be 1-300. Value must match the regular expression [-_0-9a-zA-Z/]*.
mode	enum Mode Mount's mode
target	oneof: object_storage or ephemeral_disk_spec Target mount option
object_storage	ObjectStorage Object storage mounts
ephemeral_disk_spec	DiskSpec Working disk (worker-local non-shared read-write NBS disk templates)

ObjectStorageObjectStorage

Field	Description
bucket_id	string Required. ObjectStorage bucket name for mounting. The string length in characters must be 3-63. Value must match the regular expression [-.0-9a-zA-Z]*.
prefix	string ObjectStorage bucket prefix for mounting.

DiskSpecDiskSpec

Field	Description
size	int64 The size of disk for mount in bytes Value must be greater than 0.
block_size	int64 Optional block size of disk for mount in bytes

ListOperationsListOperations

Lists operations for the specified container.

rpc ListOperations (ListContainerOperationsRequest) returns (ListContainerOperationsResponse)

ListContainerOperationsRequestListContainerOperationsRequest

Field	Description
container_id	string Required. ID of the container 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 ListContainerOperationsResponse.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 ListContainerOperationsResponse.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: The field name. Currently filtering can be applied to the operation.Operation.done, operation.Operation.created_by field. An = operator. 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.

ListContainerOperationsResponseListContainerOperationsResponse

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

OperationOperation

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.

ListAccessBindingsListAccessBindings

Lists existing access bindings for the specified container.

rpc ListAccessBindings (ListAccessBindingsRequest) returns (ListAccessBindingsResponse)

ListAccessBindingsRequestListAccessBindingsRequest

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.

ListAccessBindingsResponseListAccessBindingsResponse

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.

AccessBindingAccessBinding

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.

SubjectSubject

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.

SetAccessBindingsSetAccessBindings

Sets access bindings for the container.

rpc SetAccessBindings (SetAccessBindingsRequest) returns (operation.Operation)

Metadata and response of Operation:

    Operation.metadata:SetAccessBindingsMetadata

    Operation.response:google.protobuf.Empty

SetAccessBindingsRequestSetAccessBindingsRequest

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.

AccessBindingAccessBinding

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.

SubjectSubject

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.

OperationOperation

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.

SetAccessBindingsMetadataSetAccessBindingsMetadata

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

UpdateAccessBindingsUpdateAccessBindings

Updates access bindings for the specified container.

rpc UpdateAccessBindings (UpdateAccessBindingsRequest) returns (operation.Operation)

Metadata and response of Operation:

    Operation.metadata:UpdateAccessBindingsMetadata

    Operation.response:google.protobuf.Empty

UpdateAccessBindingsRequestUpdateAccessBindingsRequest

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.

AccessBindingDeltaAccessBindingDelta

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.

AccessBindingAccessBinding

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.

SubjectSubject

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.

OperationOperation

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.

UpdateAccessBindingsMetadataUpdateAccessBindingsMetadata

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