接口功能介紹
分頁查詢函數列表
接口約束
無
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
//{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
}
}
}
狀態碼
請參考
錯誤碼
請參考