You need to enable JavaScript to run this app.
文档中心
函数服务

函数服务

复制全文
下载 pdf
函数
GetRevision
复制全文
下载 pdf
GetRevision
获取函数的目标版本信息,包括当前版本的配置和代码信息。​
请求说明​
  • 请求方式:POST​
  • 请求地址:http://open.volcengineapi.com/?Action=GetRevision&Version=2024-06-06​
调试​
API Explorer
您可以通过 API Explorer 在线发起调用,无需关注签名生成过程,快速获取调用结果。
​
请求参数​
​
参数​
类型​
是否必选​
示例值​
描述​
Action​
String​
是​
GetRevision​
接口名称。当前 API 的名称为 GetRevision。​
Version​
String​
是​
2024-06-06​
接口版本。当前 API 的版本为 2024-06-06。​
FunctionId​
String​
是​
aj******​
函数 ID。​
RevisionNumber​
Integer​
是​
1​
函数版本号。​
​
请求示例​
​
POST http://open.volcengineapi.com/?Action=GetRevision&Version=2024-06-06 HTTP/1.1​
Content-Type: application/json​
{​
"FunctionId": "aj******",​
"RevisionNumber": 1​
}
​
返回参数​
​
参数​
类型​
示例值​
描述​
Id​
String​
nw******​
函数 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​
代码/镜像源。​
SourceLocation​
String​
tos://tos-cn-beijing.volces.com/test.zip​
代码/镜像的来源地址。​
SourceType​
String​
tos​
代码源类型。​
Envs​
Array of EnvVar​
-​
函数环境变量。​
VpcConfig​
Object of VpcConfig​
-​
VPC 配置。​
HealthCheckConfig​
Object of HealthCheckConfig​
-​
健康检查配置。​
CreationTime​
String​
2020-05-20T13:00:55Z​
函数创建时间。​
RevisionCreationTime​
String​
2020-05-20T13:00:55Z​
版本创建时间。​
TlsConfig​
Object of TlsConfig​
-​
函数 TLS 日志配置。​
InstanceType​
String​
nvidia-tesla-l4​
函数实例的实例类型。​
  • 空值:CPU 实例类型。​
  • 非空值:GPU 实例具体类型。​
NasStorage​
Object of NasStorage​
-​
文件存储 NAS 配置。​
TosMountConfig​
Object of TosMountConfig​
-​
TOS 对象存储挂载配置。​
InitializerSec​
Integer​
30​
函数初始化超时配置。​
FunctionType​
String​
sandbox​
函数类型。​
Role​
String​
trn:iam::1400000044:role/VeFaaSDefaultRole​
函数实例绑定 IAM 角色​
AsyncTaskConfig​
Object of AsyncTaskConfig​
{"EnableAsyncTask":true,"MaxRetry":3,"DestinationConfig":{"OnFailure":{"Destination":"http://dummyinstanceid.apigateway-cn-beijing-****.****.com/failure"},"OnSuccess":{"Destination":"http://dummyinstanceid.apigateway-cn-beijing-inner.volceapi.com/success"}}}​
异步任务配置。​
​
EnvVar​
​
参数​
类型​
示例值​
描述​
Key​
String​
business_type​
沙箱实例环境变量的键。​
Value​
String​
free​
沙箱实例环境变量的值。​
​
VpcConfig​
​
参数​
类型​
示例值​
描述​
EnableVpc​
Boolean​
false​
函数是否开启 VPC 访问。参数值:​
  • false:不启用,函数可通过默认网卡访问公网。​
  • true:启用,函数可访问指定 VPC 中的资源。​
VpcId​
String​
vpc-2d73mgm****​
函数所属 VPC 的 ID。​
SubnetIds​
Array of String​
["subnet-mj1l******"]​
函数开启 VPC 访问后,对应的子网 ID。​
SecurityGroupIds​
Array of String​
["sg-3re8ffwjclybk5zsk****"]​
函数开启 VPC 访问后,对应的安全组 ID。​
EnableSharedInternetAccess​
Boolean​
false​
函数访问公网开关。是否通过函数服务的 VPC 共享 NAT 网关,访问公网。参数值:​
  • true:开启,通过默认网卡访问公网。会产生公网出流量费用。​
  • false:关闭,函数无法通过默认网卡访问公网。​
​
HealthCheckConfig​
​
参数​
类型​
示例值​
描述​
EnableHealthCheck​
Boolean​
true​
是否开启健康检查:​
  • true:开启。​
  • false:关闭。​
ProbeHandler​
Object of ProbeHandler​
-​
健康检查的类型。​
InitialDelaySeconds​
Integer​
5​
首次健康检查前的延迟时间,单位为秒。​
PeriodSeconds​
Integer​
10​
每次健康检查之间的时间间隔,单位为秒。​
TimeoutSeconds​
Integer​
2​
每次健康检查的超时时间,单位为秒。​
FailureThreshold​
Integer​
3​
在判断探测失败之前需要连续失败的次数。​
SuccessThreshold​
Integer​
3​
在判断探测成功之前需要连续成功的次数。​
​
TlsConfig​
​
参数​
类型​
示例值​
描述​
EnableLog​
Boolean​
false​
是否启用日志功能,参数值:​
  • true:开启,函数的 stdout/stderr 日志将被采集至日志服务的指定日志项目和日志主题中。​
  • false:关闭,不采集日志。​
TlsTopicId​
String​
0cd4e4c4-5436-4b05-b39e-****​
TLS 日志主题 ID。​
TlsProjectId​
String​
48f49d74-cd50-4591-a3d0-****​
TLS 日志项目 ID。​
​
NasStorage​
​
参数​
类型​
示例值​
描述​
EnableNas​
Boolean​
false​
是否开启 NAS 存储挂载,参数值:​
  • true:开启,将数据存储至 NAS。​
  • false:不开启。​
NasConfigs​
Array of NasConfig​
-​
NAS 存储配置。​
​
TosMountConfig​
​
参数​
类型​
示例值​
描述​
EnableTos​
Boolean​
false​
是否开启 TOS 存储挂载,参数值:​
  • true:开启,将数据存储至 TOS。​
  • false:不开启。​
Credentials​
Object of Credentials​
-​
开启 TOS 存储挂载后,需要提供具有 TOS 域名访问权限的访问密钥(AK/SK)。​
MountPoints​
Array of TosMountPoint​
-​
开启 TOS 存储挂载后需要提供 TOS 存储配置列表。最多不超过 5 个。​
​
AsyncTaskConfig​
​
参数​
类型​
示例值​
描述​
MaxRetry​
Integer​
3​
异步任务失败重试次数,可选择值为 0~3。​
EnableAsyncTask​
Boolean​
true​
是否开启异步任务。​
DestinationConfig​
Object of DestinationConfig​
-​
异步任务回调目标配置。​
​
ProbeHandler​
​
参数​
类型​
示例值​
描述​
HTTPGet​
Object of HTTPGetAction​
-​
使用 HTTP 协议进行存活探测。​
TCPSocket​
Object of TCPSocketAction​
-​
使用 TCP 协议进行存活探测。​
​
NasConfig​
​
参数​
类型​
示例值​
描述​
Gid​
Long​
1000​
文件系统中的用户组,暂时不支持自定义。如果提供该参数,参数值必须和函数 run user gid 保持一致,取值为:1000。​
Uid​
Long​
1000​
文件系统中的用户,暂时不支持自定义。如果提供该参数,参数值必须和函数 run user uid 保持一致,取值为:1000。​
RemotePath​
String​
/​
文件系统远端目录。长度 1~128 个字符,只能以“/”开头,支持大小写字母、数字和特殊字符(- . _ ~ / : @ = + ? #)。​
FileSystemId​
String​
enas-cns******​
NAS 文件系统 ID。​
MountPointId​
String​
mount-63******​
NAS 挂载点 ID。​
LocalMountPath​
String​
/mnt/nas​
函数本地挂载目录。长度 1~128 个字符,只能以“/”开头,支持大小写字母、数字和特殊字符(- . _ ~ / : @ = + ? #)。​
​
Credentials​
​
参数​
类型​
示例值​
描述​
AccessKeyId​
String​
******​
火山引擎账号的 AccessKey ID(AK)。获取方式,请参见 访问密钥使用指南。​
SecretAccessKey​
String​
******​
火山引擎账号的 Secret Access Key(SK)。获取方式,请参见 访问密钥使用指南。​
​
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​
函数本地挂载目录。​
​
DestinationConfig​
​
参数​
类型​
示例值​
描述​
OnFailure​
Object of Destination​
-​
任务执行成功时,回调目标配置。​
OnSuccess​
Object of Destination​
-​
任务执行失败时,回调目标配置。​
​
HTTPGetAction​
​
参数​
类型​
示例值​
描述​
Path​
String​
/hello​
访问 HTTP 服务器的路径。​
Port​
Integer​
8080​
要访问的端口号或端口名称。​
  • 数字必须在 1 到 65535 范围内。​
  • 名称必须是 IANA_SVC_NAME。​
Scheme​
String​
HTTP​
用于连接主机的协议方案,支持以下取值:​
  • HTTP:使用 HTTP 协议。​
  • HTTPS:使用 HTTPS 协议。​
  • TCP:使用 TCP 协议。​
  • 默认值为 HTTP。​
HTTPHeaders​
Array of HTTPHeader​
-​
请求中设置的自定义头。HTTP 允许重复的头。​
​
TCPSocketAction​
​
参数​
类型​
示例值​
描述​
Port​
Integer​
8080​
要访问的端口号或端口名称。​
  • 数字必须在 1 到 65535 范围内。​
  • 名称必须是 IANA_SVC_NAME。​
​
Destination​
​
参数​
类型​
示例值​
描述​
Destination​
String​
http://dummyinstanceid.apigateway-cn-beijing-****.volceapi.com​
具体回调目标,取值设置为空("")表示禁用该回调。​
​
HTTPHeader​
​
参数​
类型​
示例值​
描述​
Name​
String​
Content-Type​
HTTP Header 名称。​
Value​
String​
application/json​
HTTP Header 值。​
​
返回示例​
​
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": "nw******",​
"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": "business_type",​
"Value": "free"​
}​
],​
"VpcConfig": {​
"VpcId": "vpc-2d73mgm****",​
"EnableVpc": false,​
"SubnetIds": [​
"subnet-mj1l******"​
],​
"SecurityGroupIds": [​
"sg-3re8ffwjclybk5zsk****"​
],​
"EnableSharedInternetAccess": true​
},​
"HealthCheckConfig": {​
"ProbeHandler": {​
"HTTPGet": {​
"Path": "/hello ",​
"Port": 8080,​
"Scheme": "HTTP",​
"HTTPHeaders": [​
{​
"Name": "Content-Type",​
"Value": "application/json"​
}​
]​
},​
"TCPSocket": {​
"Port": 8080​
}​
},​
"PeriodSeconds": 10,​
"TimeoutSeconds": 2,​
"FailureThreshold": 3,​
"SuccessThreshold": 3,​
"EnableHealthCheck": true,​
"InitialDelaySeconds": 5​
},​
"CreationTime": "2020-05-20T13:00:55Z",​
"RevisionCreationTime": "2020-05-20T13:00:55Z",​
"TlsConfig": {​
"EnableLog": false,​
"TlsTopicId": "0cd4e4c4-5436-4b05-b39e-****",​
"TlsProjectId": "48f49d74-cd50-4591-a3d0-****"​
},​
"InstanceType": "nvidia-tesla-l4",​
"NasStorage": {​
"EnableNas": false,​
"NasConfigs": [​
{​
"Gid": 1000,​
"Uid": 1000,​
"RemotePath": "/",​
"FileSystemId": "enas-cns******",​
"MountPointId": "mount-63******",​
"LocalMountPath": "/mnt/nas"​
}​
]​
},​
"TosMountConfig": {​
"EnableTos": false,​
"Credentials": {​
"AccessKeyId": "******",​
"SecretAccessKey": "******"​
},​
"MountPoints": [​
{​
"Endpoint": "http://tos-cn-beijing.ivolces.com",​
"ReadOnly": true,​
"BucketName": "ai-model",​
"BucketPath": "/",​
"LocalMountPath": "/mnt/tos"​
}​
]​
},​
"InitializerSec": 30,​
"FunctionType": "",​
"Role": "trn:iam::1400000044:role/VeFaaSDefaultRole",​
"AsyncTaskConfig": {​
"EnableAsyncTask": true,​
"MaxRetry": 3,​
"DestinationConfig": {​
"OnFailure": {​
"Destination": "http://dummyinstanceid.apigateway-cn-beijing-****.****.com/failure"​
},​
"OnSuccess": {​
"Destination": "http://dummyinstanceid.apigateway-cn-beijing-****.****.com/success"​
}​
}​
}​
}​
}
​
错误码​
当前接口暂无独立错误码,若接口调用返回异常,可参考 公共错误码进行故障排查。​
最近更新时间:2025.12.30 18:10:06
这个页面对您有帮助吗?
有用
有用
无用
无用