GetRevision--函数服务-火山引擎

文档中心

立即注册

导航

GetRevision

最近更新时间：2024.09.24 19:03:21首次发布时间：2024.08.07 11:48:17

获取函数的目标版本信息，包括当前版本的配置和代码信息。

请求说明

请求方式：POST
请求地址：http://open.volcengineapi.com/?Action=GetRevision&Version=2024-06-06 HTTP/1.1

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

参数	类型	是否必选	示例值	描述
Action	String	是	GetRevision	接口名称。当前 API 的名称为 `GetRevision`。
Version	String	是	2024-06-06	接口版本。当前 API 的版本为 `2024-06-06`。
FunctionId	String	是	ajqns826	函数 ID。
RevisionNumber	Integer	是	1	函数版本号。

请求示例

POST http://open.volcengineapi.com/?Action=GetRevision&Version=2024-06-06 HTTP/1.1
Content-Type: application/json
{
    "FunctionId": "ajqns826",
    "RevisionNumber": 1
}

返回参数

参数	类型	示例值	描述
Id	String	nwwzoaq1	函数 ID。
Name	String	official-site	函数名称。
Description	String	This is a description	函数描述。
RevisionNumber	Integer	1	函数版本号。
RevisionDescription	String	This is a revision description	函数版本描述。
Runtime	String	python3.8/v1	函数运行时。
ExclusiveMode	Boolean	false	独占模式开关。 true：关闭单实例多并发，即同一时刻单实例只能处理一个请求的独占模式。 false（默认）：开启单实例多并发，即同一时刻单实例可处理多个请求的非独占模式，可通过 MaxConcurrency 设置单实例能够承载的最大并发请求数量。
RequestTimeout	Integer	30	请求超时（单位：秒）。
MaxReplicas	Integer	10	最大实例数量。
MaxConcurrency	Integer	100	单实例最大并发。ExclusiveMode=false 时可设置该参数, 取值范围 10-1000。
MemoryMB	Integer	1024	单实例最大内存（单位：MB）。
CodeSize	Integer	1024	代码包大小。
CodeSizeLimit	Integer	64	代码包大小上限，只暴露给管理员/开了白名单的用户。Native 函数默认 256 MB，其他默认 64 MB。
Source	String	templates/vefaas-python38-default.zip	代码/镜像 Source。
SourceLocation	String	tos://tos-cn-beijing.volces.com/test.zip	代码/镜像的来源地址。
SourceType	String	tos	代码 Source 类型。
Envs	Array of EnvVar	[{"Key": "ENV_NAME", "Value": "ENV_VALUE"}]	函数环境变量。
VpcConfig	Object of VpcConfig	{"EnableVpc":true,"VpcId":"vpc-rragpljjr9q8v0x57hsabcd","SubnetIds":["subnet-milbxl46sdfk5smt1aa8defg"],"SecurityGroupIds":["sg-rragprgn3fnkv0x584ghijk"],"EnableSharedInternetAccess":true}	VPC 配置。
CreationTime	String	2020-05-20T13:00:55Z	函数创建时间。
RevisionCreationTime	String	2020-05-20T13:00:55Z	版本创建时间。
TlsConfig	Object of TlsConfig	{"EnableLog": true, "TlsProjectId": "a40202c5-fe22-4ea7-a3a5-06d1bca77abcd", "TlsTopicId": "2ff955cb-1f03-4b9b-8982-306e98c27890"}	函数 TLS 日志配置。
NasStorage	Object of NasStorage	{"EnableNas":true,"NasConfigs":[{"FileSystemId":"cnas-cnbjb37c2193e51234","MountPointId":"mount-bce15678","RemotePath":"/","LocalMountPath":"/mnt/nas","Uid":1000,"Gid":1000}]}	文件存储 NAS 挂载配置。
TosMountConfig	Object of TosMountConfig	{"EnableTos":true,"MountPoints":[{"BucketPath":"/","LocalMountPath":"/mnt/tos","ReadOnly":false,"BucketName":"ai-models","Endpoint":"http://tos-cn-beijing.ivolces.com"}],"Credentials":{"AccessKeyId": "TZTJjfewfweiFJIEFLDMFDKFabcd", "SecretAccessKey": "FweiffJEFJEWFJWERYTKRVFJlewjfwelFslfjsdflsjdfl=="}}	对象存储 TOS 挂载配置。
InitializerSec	Integer	30	函数初始化超时配置。

EnvVar

参数	类型	示例值	描述
Key	String	business_type	环境变量的 Key。1 ~ 63 个字符，字符中可包含英文、数字以及下划线（_），并且不能以数字开头。同一函数下 Key 唯一。
Value	String	free	环境变量的 Value。

VpcConfig

参数	类型	示例值	描述
VpcId	String	vpc-3rf87yoa8yn0g5zsk2hfevabcd	VPC ID。如果 VPC ID 为空字符串，代表删除当前 VPC 配置。
EnableVpc	Boolean	false	函数是否开启私有网络访问。
SubnetIds	Array of String	subnet-mj1lxywnkq2o5smt1bhyefgh	VPC 子网 ID。
SecurityGroupIds	Array of String	sg-rs6schq63nk0v0x57j4wxyz	安全组 ID。
EnableSharedInternetAccess	Boolean	false	函数访问公网开关。在用户绑定自己 VPC 的情况下，是否通过 vefaas VPC 共享 NAT 网关访问公网。 true：开启，通过默认网卡访问公网，会产生公网出流量费用。 false：关闭，函数无法通过默认网卡访问公网。

TlsConfig

参数	类型	示例值	描述
EnableLog	Boolean	false	TlS 日志功能开关。 true：开启，函数的 stdout/stderr 日志将被采集至日志服务的指定日志项目和日志主题中。 false：关闭。不采集日志。
TlsTopicId	String	tls-vefaas-logstore	TLS 日志主题 ID。
TlsProjectId	String	tls-vefaas	TLS 日志项目 ID。

参数

类型

示例值

描述

EnableLog

Boolean

false

TlS 日志功能开关。

true：开启，函数的 stdout/stderr 日志将被采集至日志服务的指定日志项目和日志主题中。
false：关闭。不采集日志。

TlsTopicId

String

tls-vefaas-logstore

TLS 日志主题 ID。

TlsProjectId

String

tls-vefaas

TLS 日志项目 ID。

NasStorage

参数	类型	示例值	描述
EnableNas	Boolean	false	是否开启 NAS 存储挂载。
NasConfigs	Array of NasConfig	[{"FileSystemId": "enas-cnsha0a8842997abcd", "MountPointId": "mount-6303defg", "RemotePath": "/", "LocalMountPath": "/mnt/nas", "Uid": "1000", "Gid": "1000"}]	Nas 存储配置。

TosMountConfig

参数	类型	示例值	描述
EnableTos	Boolean	false	是否开启 TOS 存储挂载。
Credentials	Object of Credentials	{"AccessKeyId": "TZTJjfewfweiFJIEFLDMFDKFabcd", "SecretAccessKey": "FweiffJEFJEWFJWERYTKRVFJlewjfwelFslfjsdflsjdfl=="}	开启 TOS 后需要提供具有 TOS 域名访问权限的 AKSK。
MountPoints	Array of TosMountPoint	[{"Endpoint": "http://tos-cn-beijing.ivolces.com", "BucketName": "ai-model", "BucketPath": "/", "LocalMountPath": "/mnt/tos", "ReadOnly": "true"}]	开启 TOS 后需要提供 TOS 存储配置列表，最多不超过 5 个。

NasConfig

参数	类型	示例值	描述
Gid	Long	1000	文件系统中的用户组，暂时不支持自定义，如果提供该参数，参数值 1000（和函数 run user gid 保持一致）。
Uid	Long	1000	文件系统中的用户，暂时不支持自定义，如果提供该参数，参数值只能为 1000（和函数 run user uid 保持一致）。
RemotePath	String	/	文件系统远端目录。长度 1-128 个字符，只能以“/”开头，支持大小写字母、数字和特殊字符（- . _ ~ / : @ = + ? # ）。
FileSystemId	String	enas-cnsha0a8842997abcd	NAS 文件系统 ID。
MountPointId	String	mount-6303defg	NAS 挂载点 ID。
LocalMountPath	String	/mnt/nas	函数本地挂载目录。长度 1-128 个字符，只能以“/”开头，支持大小写字母、数字和特殊字符（- . _ ~ / : @ = + ? # ）。

Credentials

参数	类型	示例值	描述
AccessKeyId	String	TZTJjfewfweiFJIEFLDMFDKFabcd	Access Key ID。
SecretAccessKey	String	FweiffJEFJEWFJWERYTKRVFJlewjfwelFslfjsdflsjdfl==	Secret Access Key。

TosMountPoint

参数	类型	示例值	描述
Endpoint	String	http://tos-cn-beijing.ivolces.com	TOS 访问域名。
ReadOnly	Boolean	true	函数本地目录访问权限，挂载 TOS Bucket后，函数本地挂载目录的访问权限是否为只读。 true：只读 false（默认）：读写
BucketName	String	ai-model	TOS 存储桶。
BucketPath	String	/	挂载的 TOS Bucket 路径。
LocalMountPath	String	/mnt/tos	函数本地挂载目录。

返回示例

HTTP/1.1 200 OK
Content-Type: application/json
{
    "ResponseMetadata": {
        "RequestId": "20230604110420****100232280022D31",
        "Action": "GetRevision",
        "Version": "2024-06-06",
        "Service": "vefaas",
        "Region": "cn-beijing"
    },
    "Result": {
        "Id": "nwwzoaq1",
        "Name": "official-site",
        "Description": "This is a description",
        "RevisionNumber": 1,
        "RevisionDescription": "This is a revision description",
        "Runtime": "python3.8/v1",
        "ExclusiveMode": true,
        "RequestTimeout": 30,
        "MaxReplicas": 10,
        "MaxConcurrency": 100,
        "MemoryMB": 1024,
        "CodeSize": 1024,
        "CodeSizeLimit": 64,
        "Source": "templates/vefaas-python38-default.zip",
        "SourceLocation": "tos://tos-cn-beijing.volces.com/test.zip",
        "SourceType": "tos",
        "Envs": [
            {
                "Key": "ENV_NAME",
                "Value": "ENV_VALUE"
            }
        ],
        "VpcConfig": {
            "EnableVpc": true,
            "VpcId": "vpc-rragpljjr9q8v0x57hsabcd",
            "SubnetIds": [
                "subnet-milbxl46sdfk5smt1aa8defg"
            ],
            "SecurityGroupIds": [
                "sg-rragprgn3fnkv0x584ghijk"
            ],
            "EnableSharedInternetAccess": true
        },
        "CreationTime": "2020-05-20T13:00:55Z",
        "RevisionCreationTime": "2020-05-20T13:00:55Z",
        "TlsConfig": {
            "EnableLog": true,
            "TlsProjectId": "a40202c5-fe22-4ea7-a3a5-06d1bca77abcd",
            "TlsTopicId": "2ff955cb-1f03-4b9b-8982-306e98c27890"
        },
        "NasStorage": {
            "EnableNas": true,
            "NasConfigs": [
                {
                    "FileSystemId": "cnas-cnbjb37c2193e51234",
                    "MountPointId": "mount-bce15678",
                    "RemotePath": "/",
                    "LocalMountPath": "/mnt/nas",
                    "Uid": 1000,
                    "Gid": 1000
                }
            ]
        },
        "TosMountConfig": {
            "EnableTos": true,
            "MountPoints": [
                {
                    "BucketPath": "/",
                    "LocalMountPath": "/mnt/tos",
                    "ReadOnly": false,
                    "BucketName": "ai-models",
                    "Endpoint": "http://tos-cn-beijing.ivolces.com"
                }
            ],
            "Credentials": {
                "AccessKeyId": "TZTJjfewfweiFJIEFLDMFDKFabcd",
                "SecretAccessKey": "FweiffJEFJEWFJWERYTKRVFJlewjfwelFslfjsdflsjdfl=="
            }
        },
        "InitializerSec": 30
    }
}

错误码

当前接口暂无独立错误码，若接口调用返回异常，可参考公共错误码进行故障排查。