接口功能介绍
分页查询函数列表
接口约束
无
URI
GET /openapi/v1/functions
路径参数
无
Query参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|
pageIndex | 否 | Integer | 页码,默认为1 | 1 | |
pageSize | 否 | Integer | 分页大小,默认为10 | 10 | |
search | 否 | String | 模糊查询的关键字,默认为空 | | |
请求参数
请求头header参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|
regionId | 是 | String | 资源池id | bb9fdb42056f11eda1610242ac110002 | |
请求体body参数
无
响应参数
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|
statusCode | Integer | 状态码。0表示成功,其他值表示失败 | 0 | |
code | String | 错误码。CF_0表示成功,其他值表示失败 | CF_0 | |
message | String | 错误描述信息 | | |
returnObj | Object | 返回实体 | | ReturnObj |
表 ReturnObj | | | | |
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|
data | Array of Objects | 分页数据 | | Data |
pagination | Object | 分页信息 | | Pagination |
表 Pagination | | | | |
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|
pageIndex | Integer | 页码 | 1 | |
pageSize | Integer | 每页大小 | 10 | |
total | Integer | 总记录数 | 2 | |
表 Data | | | | |
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|
functionId | String | 函数 id | | |
deployInfo | Object | 最近一次函数构建的状态信息 | | DeployInfo |
container | Object | 容器配置 | | Container |
lifecycle | Object | 生命周期配置 | | Lifecycle |
log | Object | 是否启用日志功能 | | Log |
layers | Array of Objects | 层配置 | | Layers |
runtime | Object | 运行时 | | Runtime |
network | Object | 网络配置 | | Network |
customContainerConfig | Object | 自定义镜像配置 | | CustomContainerConfig |
serverlessGpuConfig | Object | gpu函数配置 | | ServerlessGpuConfig |
createType | Integer | 创建类型 1:内置运行时2:自定义运行时3:自定义镜像 | 1 | |
ossMount | Object | zos挂载配置 | | OssMount |
functionName | String | 函数名 | func01 | |
description | String | 说明 | | |
role | String | 角色 | | CtyunFcDefaultDelegateRole |
dns | Object | DNS配置 | | Dns |
nas | Object | NAS配置 | | Nas |
表 DeployInfo | | | | |
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|
taskEnd | Integer | 结束时间 | | |
errMsg | String | 错误说明 | | |
creator | String | 关联的userId | | |
id | String | 此次更新内部唯一id | | |
status | String | 当前代码部署状态 | | |
taskBegin | Integer | 开始时间 | | |
表 Container | | | | |
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|
timeZone | String | 时区 | UTC | |
diskSize | Integer | 磁盘规格(Mb) | 512 | |
maxScale | Integer | 并发实例数上限 | 1 | |
fastStart | Integer | 启动加速, 默认为0, 1(表示使用启动加速) | 1 | |
healthCheckConfig | Object | 健康检查 | | HealthCheckConfig |
environmentVariables | Object | 环境变量 | | EnvironmentVariables |
memorySize | Integer | 内存规格(Mb) | 128 | |
cpu | Double | CPU规格(vCPU) | 0.1 | |
runCommand | String | 函数服务启动命令 | python3 my_server.py | |
listenPort | Integer | 监听端口 | 8080 | |
表 EnvironmentVariables | | | | |
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|
key01 | String | 键值对01 | val01 | |
key02 | String | 键值对02 | val02 | |
表 HealthCheckConfig | | | | |
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|
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 0表示自定义层,1表示官方公共层 | | |
表 Runtime | | | | |
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|
runtime | String | 运行时类型 | | |
handleType | String | 请求处理程序类型 | http | |
executeTimeout | Integer | 执行超时时间 | | |
handler | String | 函数执行的入口 | | |
instanceConcurrency | Integer | 实例最大并发度 | | |
表 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访问函数 | | |
表 CustomContainerConfig | | | | |
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|
imageDigest | String | digest 用于指定镜像版本 | | |
image | String | 容器镜像地址 | | |
instanceId | String | crs 实例 id | | |
表 ServerlessGpuConfig | | | | |
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|
gpuEnable | Boolean | 是否使用Gpu | true | |
gpuEciType | String | GPU ECI 规格 | p8a.12xlarge.4 | |
gpuMemorySize | Integer | 单位是G | 32 | |
gpuType | String | gpu卡型 | A10 | |
gpuProvisionCount | Integer | 配置的预留实例数量 | 1 | |
表 OssMount | | | | |
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|
mounts | Array of Objects | zos挂载参数 | | Mounts |
表 Mounts | | | | |
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|
bucketName | String | bucket名 | | |
bucketPath | String | bucket子目录 | | |
mountDir | String | 挂载本地目录 | | |
readOnly | Boolean | 是否只读,默认false | | |
accessUrl | String | oss 访问地址 | | |
表 Dns | | | | |
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|
nameServers | Array of Strings | DNS 服务器的 IP 地址列表 | [8.8.x.x] | |
searches | Array of Strings | DNS 搜索域列表 | [ns1.svc.cluster-domain.example] | |
options | Object | DNS 解析配置 | | Option |
表 Option | | | | |
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|
ndots | String | 键值对01 | 2 | |
表 Nas | | | | |
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|
nas | Array of Objects | nas | | NasItem |
表 NasItem | | | | |
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|
remoteDir | String | 远端挂载目录 | | |
sharePath | String | 挂载地址 | | |
localDir | String | 挂载本地目录 | | |
sfsName | String | sfs 的名称 | | |
sfsUID | String | sfs 的 ID | | |
枚举参数
无
请求示例
请求url
https://{host}/openapi/v1/functions
请求头header
regionId: bb9fdb42056f11eda1610242ac110002
请求体body
无
响应示例
{
"statusCode": 0,
"code": "CF_0",
"message": "",
"returnObj": {
"data": [
{
"functionId": "554296661518xxxxx",
"container": {
"timeZone": "UTC",
"memorySize": 128,
"cpu": 0.1,
"diskSize": 512,
"runCommand": "./bootstrap.sh",
"listenPort": 8080,
"fastStart": 0
},
"code": {
"ossBucketName": "bucket-a123",
"ossObjectName": "funcTemplates/python3_event.zip"
},
"functionName": "func01",
"description": "create function test",
"updateTime": "2025-09-18T17:24:15.639374+08:00",
"createTime": "2025-09-18T17:24:15.617995+08:00",
"createType": 1,
"deployInfo": {
"creator": "411xx",
"errMsg": "",
"id": "554296661854xxxxx",
"status": "building",
"taskBegin": 1758187455,
"taskEnd": 0
},
"runtime": {
"executeTimeout": 40,
"handler": "index.handler",
"instanceConcurrency": 1,
"runtime": "python3.9",
"handleType": "event"
}
},{
"functionId": "127534661518xxxxx",
"container": {
"timeZone": "UTC",
"memorySize": 128,
"cpu": 0.1,
"diskSize": 512,
"runCommand": "./bootstrap.sh",
"listenPort": 8080,
"fastStart": 0
},
"code": {
"ossBucketName": "bucket-a123",
"ossObjectName": "funcTemplates/python3_http.zip"
},
"functionName": "func02",
"description": "create function test",
"updateTime": "2025-09-18T17:24:15.639374+08:00",
"createTime": "2025-09-18T17:24:15.617995+08:00",
"createType": 1,
"deployInfo": {
"creator": "411xx",
"errMsg": "",
"id": "127534661518xxxxx",
"status": "building",
"taskBegin": 1758187455,
"taskEnd": 0
},
"runtime": {
"executeTimeout": 40,
"handler": "index.handler",
"instanceConcurrency": 1,
"runtime": "python3.9",
"handleType": "http"
}
}
],
"pagination": {
"pageIndex": 1,
"pageSize": 10,
"total": 2
}
}
}
状态码
请参考 状态码
错误码
请参考 错误码