Cloud Functions Service, REST: Function.GetVersion
Returns the specified version of a function.
To get the list of available version, make a ListVersions request.
HTTP request
GET https://serverless-functions.api.cloud.yandex.net/functions/v1/versions/{functionVersionId}
Path parameters
|
Field |
Description |
|
functionVersionId |
string Required field. ID of the version to return. To get a version ID make a FunctionService.ListVersions request. |
Response
HTTP Code: 200 - OK
{
"id": "string",
"functionId": "string",
"description": "string",
"createdAt": "string",
"runtime": "string",
"entrypoint": "string",
"resources": {
"memory": "string"
},
"executionTimeout": "string",
"serviceAccountId": "string",
"imageSize": "string",
"status": "string",
"tags": [
"string"
],
"environment": "object",
"connectivity": {
"networkId": "string",
"subnetId": [
"string"
]
},
"namedServiceAccounts": "object",
"secrets": [
{
"id": "string",
"versionId": "string",
"key": "string",
// Includes only one of the fields `environmentVariable`
"environmentVariable": "string"
// end of the list of possible fields
}
],
"logOptions": {
"disabled": "boolean",
// Includes only one of the fields `logGroupId`, `folderId`
"logGroupId": "string",
"folderId": "string",
// end of the list of possible fields
"minLevel": "string"
},
"storageMounts": [
{
"bucketId": "string",
"prefix": "string",
"mountPointName": "string",
"readOnly": "boolean"
}
],
"asyncInvocationConfig": {
"retriesCount": "string",
"successTarget": {
// Includes only one of the fields `emptyTarget`, `ymqTarget`
"emptyTarget": "object",
"ymqTarget": {
"queueArn": "string",
"serviceAccountId": "string"
}
// end of the list of possible fields
},
"failureTarget": {
// Includes only one of the fields `emptyTarget`, `ymqTarget`
"emptyTarget": "object",
"ymqTarget": {
"queueArn": "string",
"serviceAccountId": "string"
}
// end of the list of possible fields
},
"serviceAccountId": "string"
},
"tmpfsSize": "string",
"concurrency": "string",
"mounts": [
{
"name": "string",
"mode": "string",
// Includes only one of the fields `objectStorage`, `ephemeralDiskSpec`
"objectStorage": {
"bucketId": "string",
"prefix": "string"
},
"ephemeralDiskSpec": {
"size": "string",
"blockSize": "string"
}
// end of the list of possible fields
}
],
"metadataOptions": {
"gceHttpEndpoint": "string",
"awsV1HttpEndpoint": "string"
}
}
Version of a function. For details about the concept, see Function versions.
|
Field |
Description |
|
id |
string ID of the version. |
|
functionId |
string ID of the function that the version belongs to. |
|
description |
string Description of the version. |
|
createdAt |
string (date-time) Creation timestamp for the version. String in RFC3339 text format. The range of possible values is from To work with values in this field, use the APIs described in the |
|
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 |
|
resources |
Resources allocated to the version. |
|
executionTimeout |
string (duration) Timeout for the execution of the version. If the timeout is exceeded, Cloud Functions responds with a 504 HTTP code. |
|
serviceAccountId |
string ID of the service account associated with the version. |
|
imageSize |
string (int64) Final size of the deployment package after unpacking. |
|
status |
enum (Status) Status of the version.
|
|
tags[] |
string Version tags. For details, see Version tag. |
|
environment |
object (map<string, string>) Environment settings for the version. |
|
connectivity |
Network access. If specified the version will be attached to specified network/subnet(s). |
|
namedServiceAccounts |
object (map<string, string>) Additional service accounts to be used by the version. |
|
secrets[] |
Yandex Lockbox secrets to be used by the version. |
|
logOptions |
Options for logging from the function |
|
storageMounts[] |
S3 mounts to be used by the version. |
|
asyncInvocationConfig |
Config for asynchronous invocations of the version |
|
tmpfsSize |
string (int64) Optional size of in-memory mounted /tmp directory in bytes. |
|
concurrency |
string (int64) The maximum number of requests processed by a function instance at the same time |
|
mounts[] |
Mounts to be used by the version. |
|
metadataOptions |
Metadata options for the version. |
Resources
Resources allocated to a version.
|
Field |
Description |
|
memory |
string (int64) Amount of memory available to the version, specified in bytes, multiple of 128MB. |
Connectivity
Version connectivity specification.
|
Field |
Description |
|
networkId |
string Network the version will have access to. |
|
subnetId[] |
string Complete list of subnets (from the same network) the version can be attached to. |
Secret
Secret for serverless function.
|
Field |
Description |
|
id |
string ID of Yandex Lockbox secret. |
|
versionId |
string ID of Yandex Lockbox version. |
|
key |
string Key in secret's payload, which value to be delivered into function environment. |
|
environmentVariable |
string environment variable in which secret's value to be delivered. Includes only one of the fields |
LogOptions
|
Field |
Description |
|
disabled |
boolean Is logging from function disabled. |
|
logGroupId |
string Entry should be written to log group resolved by ID. Includes only one of the fields Log entries destination. |
|
folderId |
string Entry should be written to default log group for specified folder. Includes only one of the fields Log entries destination. |
|
minLevel |
enum (Level) Minimum log entry level. See LogLevel.Level for details.
|
StorageMount
|
Field |
Description |
|
bucketId |
string Required field. S3 bucket name for mounting. |
|
prefix |
string S3 bucket prefix for mounting. |
|
mountPointName |
string Required field. Mount point directory name (not path) for mounting. |
|
readOnly |
boolean Is mount read only. |
AsyncInvocationConfig
|
Field |
Description |
|
retriesCount |
string (int64) Number of retries of version invocation |
|
successTarget |
Required field. Target for successful result of the version's invocation |
|
failureTarget |
Required field. Target for unsuccessful result, if all retries failed |
|
serviceAccountId |
string Service account which can invoke version |
ResponseTarget
Target to which a result of an invocation will be sent
|
Field |
Description |
|
emptyTarget |
object Target to ignore a result Includes only one of the fields |
|
ymqTarget |
Target to send a result to ymq Includes only one of the fields |
YMQTarget
|
Field |
Description |
|
queueArn |
string Required field. Queue ARN |
|
serviceAccountId |
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
|
|
objectStorage |
Object storage mounts Includes only one of the fields Target mount option |
|
ephemeralDiskSpec |
Working disk (worker-local non-shared read-write NBS disk templates) Includes only one of the fields Target mount option |
ObjectStorage
ObjectStorage as a mount
|
Field |
Description |
|
bucketId |
string Required field. ObjectStorage bucket name for mounting. |
|
prefix |
string ObjectStorage bucket prefix for mounting. |
DiskSpec
Disk as a mount
|
Field |
Description |
|
size |
string (int64) The size of disk for mount in bytes |
|
blockSize |
string (int64) Optional block size of disk for mount in bytes |
MetadataOptions
|
Field |
Description |
|
gceHttpEndpoint |
enum (MetadataOption) Enabled access to GCE flavored metadata
|
|
awsV1HttpEndpoint |
enum (MetadataOption) Enabled access to AWS flavored metadata (IMDSv1)
|