Cloud Functions Service, gRPC: FunctionService.GetVersionByTag

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

Yandex Cloud

Обновлена 17 декабря 2024 г.

gRPC request
GetFunctionVersionByTagRequest
Version
Resources
Connectivity
Secret
LogOptions
StorageMount
AsyncInvocationConfig
ResponseTarget
EmptyTarget
YMQTarget
Mount
ObjectStorage
DiskSpec
MetadataOptions

Returns all versions with the specified tag.

To get the list of all available versions, make a ListVersions request.

gRPC request

rpc GetVersionByTag (GetFunctionVersionByTagRequest) returns (Version)

GetFunctionVersionByTagRequest

{
  "function_id": "string",
  "tag": "string"
}

Field

Description

function_id

string

Required field. ID of the function whose versions should be listed.

To get a function ID use a FunctionService.List request.

tag

string

Version tag.

To get the history of version tags make a FunctionService.ListTagHistory request.

Version

{
  "id": "string",
  "function_id": "string",
  "description": "string",
  "created_at": "google.protobuf.Timestamp",
  "runtime": "string",
  "entrypoint": "string",
  "resources": {
    "memory": "int64"
  },
  "execution_timeout": "google.protobuf.Duration",
  "service_account_id": "string",
  "image_size": "int64",
  "status": "Status",
  "tags": [
    "string"
  ],
  "environment": "map<string, string>",
  "connectivity": {
    "network_id": "string",
    "subnet_id": [
      "string"
    ]
  },
  "named_service_accounts": "map<string, string>",
  "secrets": [
    {
      "id": "string",
      "version_id": "string",
      "key": "string",
      // Includes only one of the fields `environment_variable`
      "environment_variable": "string"
      // end of the list of possible fields
    }
  ],
  "log_options": {
    "disabled": "bool",
    // Includes only one of the fields `log_group_id`, `folder_id`
    "log_group_id": "string",
    "folder_id": "string",
    // end of the list of possible fields
    "min_level": "Level"
  },
  "storage_mounts": [
    {
      "bucket_id": "string",
      "prefix": "string",
      "mount_point_name": "string",
      "read_only": "bool"
    }
  ],
  "async_invocation_config": {
    "retries_count": "int64",
    "success_target": {
      // Includes only one of the fields `empty_target`, `ymq_target`
      "empty_target": "EmptyTarget",
      "ymq_target": {
        "queue_arn": "string",
        "service_account_id": "string"
      }
      // end of the list of possible fields
    },
    "failure_target": {
      // Includes only one of the fields `empty_target`, `ymq_target`
      "empty_target": "EmptyTarget",
      "ymq_target": {
        "queue_arn": "string",
        "service_account_id": "string"
      }
      // end of the list of possible fields
    },
    "service_account_id": "string"
  },
  "tmpfs_size": "int64",
  "concurrency": "int64",
  "mounts": [
    {
      "name": "string",
      "mode": "Mode",
      // Includes only one of the fields `object_storage`, `ephemeral_disk_spec`
      "object_storage": {
        "bucket_id": "string",
        "prefix": "string"
      },
      "ephemeral_disk_spec": {
        "size": "int64",
        "block_size": "int64"
      }
      // end of the list of possible fields
    }
  ],
  "metadata_options": {
    "gce_http_endpoint": "MetadataOption",
    "aws_v1_http_endpoint": "MetadataOption"
  }
}

Version of a function. For details about the concept, see Function versions.

Field	Description
id	string ID of the version.
function_id	string ID of the function that the version belongs to.
description	string Description of the version.
created_at	google.protobuf.Timestamp Creation timestamp for the version.
runtime	string ID of the runtime environment for the function. Supported environments and their identifiers are listed in the Runtime environments.
entrypoint	string Entrypoint for the function: the name of the function to be called as the handler. Specified in the format `<function file name>.<handler name>`, for example, `index.myFunction`.
resources	Resources Resources allocated to the version.
execution_timeout	google.protobuf.Duration Timeout for the execution of the version. If the timeout is exceeded, Cloud Functions responds with a 504 HTTP code.
service_account_id	string ID of the service account associated with the version.
image_size	int64 Final size of the deployment package after unpacking.
status	enum Status Status of the version. `STATUS_UNSPECIFIED` `CREATING`: Version is being created. `ACTIVE`: Version is ready to use. `OBSOLETE`: Version will be deleted soon. `DELETING`: Version is being deleted.
tags[]	string Version tags. For details, see Version tag.
environment	object (map<string, string>) Environment settings for the version.
connectivity	Connectivity Network access. If specified the version will be attached to specified network/subnet(s).
named_service_accounts	object (map<string, string>) Additional service accounts to be used by the version.
secrets[]	Secret Yandex Lockbox secrets to be used by the version.
log_options	LogOptions Options for logging from the function
storage_mounts[]	StorageMount S3 mounts to be used by the version.
async_invocation_config	AsyncInvocationConfig Config for asynchronous invocations of the version
tmpfs_size	int64 Optional size of in-memory mounted /tmp directory in bytes.
concurrency	int64 The maximum number of requests processed by a function instance at the same time
mounts[]	Mount Mounts to be used by the version.
metadata_options	MetadataOptions Metadata options for the version.

Resources

Resources allocated to a version.

Field

Description

memory

int64

Amount of memory available to the version, specified in bytes, multiple of 128MB.

Connectivity

Version connectivity specification.

Field

Description

network_id

string

Network the version will have access to.
It's essential to specify network with subnets in all availability zones.

subnet_id[]

string

Complete list of subnets (from the same network) the version can be attached to.
It's essential to specify at least one subnet for each availability zones.

Secret

Secret for serverless function.

Field	Description
id	string ID of Yandex Lockbox secret.
version_id	string ID of Yandex Lockbox version.
key	string Key in secret's payload, which value to be delivered into function environment.
environment_variable	string environment variable in which secret's value to be delivered. Includes only one of the fields `environment_variable`.

LogOptions

Field	Description
disabled	bool Is logging from function disabled.
log_group_id	string Entry should be written to log group resolved by ID. Includes only one of the fields `log_group_id`, `folder_id`. Log entries destination.
folder_id	string Entry should be written to default log group for specified folder. Includes only one of the fields `log_group_id`, `folder_id`. Log entries destination.
min_level	enum Level Minimum log entry level. See LogLevel.Level for details. `LEVEL_UNSPECIFIED`: Default log level. Equivalent to not specifying log level at all. `TRACE`: Trace log level. Possible use case: verbose logging of some business logic. `DEBUG`: Debug log level. Possible use case: debugging special cases in application logic. `INFO`: Info log level. Mostly used for information messages. `WARN`: Warn log level. May be used to alert about significant events. `ERROR`: Error log level. May be used to alert about errors in infrastructure, logic, etc. `FATAL`: Fatal log level. May be used to alert about unrecoverable failures and events.

StorageMount

Field	Description
bucket_id	string Required field. S3 bucket name for mounting.
prefix	string S3 bucket prefix for mounting.
mount_point_name	string Required field. Mount point directory name (not path) for mounting.
read_only	bool Is mount read only.

AsyncInvocationConfig

Field	Description
retries_count	int64 Number of retries of version invocation
success_target	ResponseTarget Required field. Target for successful result of the version's invocation
failure_target	ResponseTarget Required field. Target for unsuccessful result, if all retries failed
service_account_id	string Service account which can invoke version

ResponseTarget

Target to which a result of an invocation will be sent

Field

Description

empty_target

EmptyTarget

Target to ignore a result

Includes only one of the fields empty_target, ymq_target.

ymq_target

YMQTarget

Target to send a result to ymq

Includes only one of the fields empty_target, ymq_target.

EmptyTarget

Field	Description
Empty

YMQTarget

Field

Description

queue_arn

string

Required field. Queue ARN

service_account_id

string

Required field. Service account which has write permission on the queue.

Mount

Mount contains an information about version's external storage mount

Field	Description
name	string Required field. Unique mount point name. Device will be mounted into /function/storage/
mode	enum Mode Mount's mode `MODE_UNSPECIFIED` `READ_ONLY` `READ_WRITE`
object_storage	ObjectStorage Object storage mounts Includes only one of the fields `object_storage`, `ephemeral_disk_spec`. Target mount option
ephemeral_disk_spec	DiskSpec Working disk (worker-local non-shared read-write NBS disk templates) Includes only one of the fields `object_storage`, `ephemeral_disk_spec`. Target mount option

ObjectStorage

ObjectStorage as a mount

Field

Description

bucket_id

string

Required field. ObjectStorage bucket name for mounting.

prefix

string

ObjectStorage bucket prefix for mounting.

DiskSpec

Disk as a mount

Field

Description

size

int64

The size of disk for mount in bytes

block_size

int64

Optional block size of disk for mount in bytes

MetadataOptions

Field

Description

gce_http_endpoint

enum MetadataOption

Enabled access to GCE flavored metadata

METADATA_OPTION_UNSPECIFIED: Option is default
ENABLED: Option is enabled
DISABLED: Option is disabled

aws_v1_http_endpoint

enum MetadataOption

Enabled access to AWS flavored metadata (IMDSv1)

METADATA_OPTION_UNSPECIFIED: Option is default
ENABLED: Option is enabled
DISABLED: Option is disabled

Cloud Functions Service, gRPC: FunctionService.GetVersionByTag

gRPC requestgRPC request

GetFunctionVersionByTagRequestGetFunctionVersionByTagRequest

VersionVersion

ResourcesResources

ConnectivityConnectivity

SecretSecret

LogOptionsLogOptions

StorageMountStorageMount

AsyncInvocationConfigAsyncInvocationConfig

ResponseTargetResponseTarget

EmptyTargetEmptyTarget

YMQTargetYMQTarget

MountMount

ObjectStorageObjectStorage

DiskSpecDiskSpec

MetadataOptionsMetadataOptions

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

gRPC request

GetFunctionVersionByTagRequest

Version

Resources

Connectivity

Secret

LogOptions

StorageMount

AsyncInvocationConfig

ResponseTarget

EmptyTarget

YMQTarget

Mount

ObjectStorage

DiskSpec

MetadataOptions