接口功能介绍

查询函数详情

接口约束

无

URI

GET /openapi/v1/functions/*

路径参数

参数	是否必填	参数类型	说明	示例	下级对象
functionName	是	String	函数名称	test

Query参数

参数	是否必填	参数类型	说明	示例	下级对象
qualifier	否	String	函数的版本ID或者别名

请求参数

请求头header参数

参数	是否必填	参数类型	说明	示例	下级对象
regionId	是	String	资源池id	test

请求体body参数
无

响应参数

参数	参数类型	说明	示例	下级对象
statusCode	Integer	状态码,0表示成功，非0表示不成功	0
error	String	错误码	CF_0
message	String	信息
returnObj	Object	返回实体		Data

表 Data

参数	参数类型	说明	示例	下级对象
functionId	String	函数 id
deployInfo	Object	最近一次编译任务的状态信息		DeployInfo
container	Object	容器配置
lifecycle	Object	生命周期配置
log	Object	是否启用日志功能
layers	Object	层配置		Layers
runtime	Object	运行时
code	Object	代码配置
network	Object	网络配置
customContainerConfig	Object	镜像仓库
createType	Integer	创建类型 1：内置运行时 2：自定义运行时 3：自定义镜像	1
ossMount	Object	oss配置
description	String	说明

表 DeployInfo

参数	参数类型	说明	示例	下级对象
taskEnd	Integer	结束时间
errMsg	String	错误说明
creator	String	关联的 userId
id	String	此次更新内部唯一id
status	String	当前代码部署状态
taskBegin	Integer	开始时间

表 Container

参数	参数类型	说明	示例	下级对象
timeZone	String	时区
diskSize	Integer	磁盘规格
maxScale	Integer	并发实例数上限
minScale	Integer	GPU 函数的最小实例数
fastStart	Integer	启动加速
healthCheckConfig	Object	健康检查		HealthCheckConfig
image	String	镜像名
environmentVariables	Object	环境变量		EnvironmentVariables
memorySize	Integer	内存规格
cpu	Integer	CPU规格
runCommand	String	运行命令
listenPort	Integer	监听端口

表 HealthCheckConfig

参数	参数类型	说明	示例	下级对象
failureThreshold	Integer	失败阈值
getPath	String	检查http get path
initialDelaySeconds	Integer	实例初始化后延迟多久开始检查
periodSeconds	Integer	检查周期，秒
successThreshold	Integer	成功阈值
timeoutSeconds	Integer	超时

表 EnvironmentVariables

参数	参数类型	说明	示例	下级对象
failureThreshold	Integer	失败阈值
getPath	String	检查http get path
initialDelaySeconds	Integer	实例初始化后延迟多久开始检查
periodSeconds	Integer	检查周期，秒
successThreshold	Integer	成功阈值
timeoutSeconds	Integer	超时

表 Lifecycle

参数	参数类型	说明	示例	下级对象
initializer	Object	实例初始化		Initializer
preStop	Object	实例初始化		PreStop

表 Initializer

参数	参数类型	说明	示例	下级对象
handler	String	处理方法入口
enable	Boolean	启用
timeout	Integer	超时

表 PreStop

参数	参数类型	说明	示例	下级对象
handler	String	处理方法入口
enable	Boolean	启用
timeout	Integer	超时

表 Log

参数	参数类型	说明	示例	下级对象
logEnabled	Boolean	是否启用日志功能
logAutoConfig	Boolean	是否自动配置
logProjectId	String	日志项目id
logProjectCode	String	日志项目Code
logUnit	String	日志单元名称
logUnitId	String	日志单元id
logProject	String	日志项目名称
logUnitCode	String	日志单元Code
logRuleEnabled	Boolean	启用日志分割规则
logRule	Object	日志切割配置		LogRule

表 LogRule

参数	参数类型	说明	示例	下级对象
ruleCode	String	规则唯一编码
ruleName	String	规则名称
extractMode	Integer	采集类型
collectPolicy	String	采集策略
cuttingMode	String	切割模式
enable	Boolean	是否启用采集规则
unitCode	String	日志单元编码
logPaths	Array of Strings	待采集的日志文件路径列表		LogPaths
firstLinePattern	String	首行正则
customTime	Object	自定义时间戳提取格式		CustomTime
ruleConfig	Object	容器运行参数		RuleConfig
accessType	Integer	接入类型

表 CustomTime

参数	参数类型	说明	示例	下级对象
key	String	key
timeFormat	String	格式化	yyyy-MM-dd HH:mm:ss

表 RuleConfig

参数	参数类型	说明	示例	下级对象
maxPathDepth	Integer	最大正则路径解析深度
blackPaths	Array of Strings	采集路径黑名单		BlackPaths
delimeter	Object	分隔符		Delimeter
regex	Object	正则切割模式		Regex

表 Delimeter

参数	参数类型	说明	示例	下级对象
delimeter	String	分隔符
typeContents	Array of Objects	类型		TypeContents

表 TypeContents

参数	参数类型	说明	示例	下级对象
key	String	key
type	String	类型

表 Regex

参数	参数类型	说明	示例	下级对象
regexStr	String	正则表达式
typeContents	Array of Objects	类型		TypeContents

表 Layers

参数	参数类型	说明	示例	下级对象
layerName	String	层名称
version	Integer	版本
description	String	描述
acl	Integer	acl

表 Runtime

参数	参数类型	说明	示例	下级对象
runtime	String	运行时类型
handleType	String	请求处理程序类型	http
executeTimeout	Integer	执行超时时间
handler	String	函数执行的入口
instanceConcurrency	Integer	实例最大并发度

表 Code

参数	参数类型	说明	示例	下级对象
ossBucketName	String	oss的bucket
ossObjectName	String	oss的name	funcTemplates/python3_event.zip

表 Network

参数	参数类型	说明	示例	下级对象
InternetOutAllow	Boolean	允许函数访问公网
internetInForbid	Boolean	不允许互联网公网访问函数
outVpcId	String	networkId
vpcId	Integer	vpcId
securityGroupName	String	安全组Name
subNetId	String	子网ID
subNetName	String	子网name
enable	Boolean	是否开启VPC
fixedPublicIp	Boolean	固定公网ip
outVpcName	String	vpcName
securityGroupId	String	安全组ID
subNetCidr	String	子网CIDR
accessVpcIds	Array of Strings	允许VPC访问函数		AccessVpcIds

表 CustomContainerConfig

参数	参数类型	说明	示例	下级对象
imageDigest	String	digest 用于指定镜像版本
harborUser	String	镜像仓库用户名，使用 AES 加密
harborPsw	String	镜像仓库密码，使用 AES 加密
gpuEnable	Boolean	是否使用Gpu
gpuEciType	String	GPU ECI 规格
gpuMemorySize	Integer	单位是G
gpuType	String	gpu卡型
image	String	容器镜像地址。

表 OssMount

参数	参数类型	说明	示例	下级对象
ak	String	AK
sk	String	SK
mounts	Array of Objects	挂载		Mounts

表 Mounts

参数	参数类型	说明	示例	下级对象
bucketName	String	bucket名
bucketPath	String	bucket子目录
mountDir	String	挂载本地目录
readOnly	Boolean	是否只读，默认false
accessUrl	String	oss 访问地址，默认地址传递空值就行

表 Dns

参数	参数类型	说明	示例	下级对象
nameServers	Array of Strings	DNS 服务器的 IP 地址列表		NameServers
searches	Array of Strings	DNS 搜索域列表		Searches
options	Object	DNS 解析配置		Options

表 Nas

参数	参数类型	说明	示例	下级对象
nas	Array of Objects	nas		NasSub

表 NasSub

参数	参数类型	说明	示例	下级对象
remoteDir	String	远端挂载目录
sharePath	String	挂载地址
localDir	String	挂载本地目录
sfsName	String	sfs 的名称
sfsUID	String	sfs 的 ID

枚举参数

无

请求示例

请求url

https://{host}/openapi/v1/functions/{functionName}

请求头header

无

请求体body

无

响应示例

{
    "statusCode": 0,
    "message": "",
    "returnObj": {
        "functionId": "8414463971584039",
        "code": {
            "ossBucketName": "",
            "ossObjectName": "funcTemplates/go_http.zip",
            "snapshotOssObjectName": ""
        },
        "container": {
            "image": "faas-huadong1-grey-registry-huadong1.crs-internal.ctyun.cn/faas/go1.x-runtime:1.0",
            "timeZone": "UTC",
            "memorySize": 128,
            "cpu": 0.1,
            "diskSize": 512,
            "runCommand": "Li9ib290c3RyYXAuc2g=",
            "listenPort": 8080,
            "codeDirPath": "/code",
            "logLevel": "",
            "sysLogLevel": "INFO",
            "maxScale": null,
            "minScale": null,
            "fastStart": 0
        },
        "functionName": "probe-vpc",
        "ksvcName": "probe-vpc-fwahopcuhv",
        "description": "",
        "static": null,
        "updateTime": "2024-10-29T14:49:17.183479+08:00",
        "createTime": "2024-10-29T09:10:11.36888+08:00",
        "createType": 1,
        "deployInfo": {
            "creator": "19346",
            "errMsg": "",
            "id": "8448594113780484",
            "status": "success",
            "taskBegin": 1730184554,
            "taskEnd": 1730184557
        },
        "role": "",
        "log": {
            "logEnabled": false,
            "logAutoConfig": false,
            "logProject": "",
            "logProjectId": "",
            "logProjectCode": "",
            "logUnit": "",
            "logUnitId": "",
            "logUnitCode": "",
            "logHostGroup": "",
            "logRuleEnabled": false
        },
        "network": {
            "accessVpcIds": [
            ],
            "enable": true,
            "fixedPublicIp": false,
            "internetInForbid": false,
            "internetOutAllow": false,
            "outVpcId": "vpc-gqyt2ckow0",
            "vpcId": 10593,
            "outVpcName": "vpc-probe",
            "securityGroupId": "sg-5re0xq5clw",
            "securityGroupName": "Default-Security-Group",
            "subNetCidr": "192.168.0.0/24",
            "subNetGatewayIp": "",
            "vcId": "faasgwrule-71ao3j02a3-6350",
            "tunnelIp": "172.16.0.3",
            "faasGwId": "faasgw-gsjvy8kvnr",
            "rulePk": 8448593694350084,
            "subNetId": "subnet-cfvaeaywa1",
            "subNetName": "subnet-probe"
        },
        "dns": {
            "nameServers": null,
            "options": null,
            "searches": null
        },
        "lifecycle": {
            "initializer": {
                "handler": "",
                "timeout": 0,
                "enable": false
            },
            "preStop": {
                "handler": "",
                "timeout": 0,
                "enable": false
            }
        },
        "nas": null,
        "ossMount": {
            "ak": "",
            "mounts": null,
            "sk": ""
        },
        "layers": null,
        "runtime": {
            "executeTimeout": 40,
            "handler": "main",
            "instanceConcurrency": 1,
            "runtime": "go1.x",
            "handleType": "http"
        },
        "customContainerConfig": {
            "harborPsw": "",
            "harborUser": "",
            "image": "",
            "imageDigest": "",
            "gpuEnable": false,
            "gpuEciType": "",
            "gpuMemorySize": 0,
            "gpuType": ""
        }
    }
}

状态码

请参考 状态码

错误码

请参考 错误码