@@ -40,6 +40,7 @@ inputs:
40
40
subnetId : ' ' # 私有网络的Id
41
41
vpcId : ' ' # 子网ID
42
42
apigatewayConf : # api网关配置
43
+ isDisabled : false # 是否禁用自动创建 API 网关功能
43
44
enableCORS : true # 允许跨域
44
45
customDomains : # 自定义域名绑定
45
46
- domain : abc.com # 待绑定的自定义的域名
@@ -71,21 +72,21 @@ inputs:
71
72
72
73
主要的参数
73
74
74
- | 参数名称 | 是否必选 | 默认值 | 描述 |
75
- | ---------------------------------------- | :------: | :-------------: | :------------------------------------------------------------------ |
76
- | runtime | 否 | Nodejs10.15 | 执行环境, 目前支持: Nodejs6.10, Nodejs8.9, Nodejs10.15, Nodejs12.16 |
77
- | region | 否 | ap-guangzhou | 项目部署所在区域,默认广州区 |
78
- | functionName | 否 | | 云函数名称 |
79
- | serviceName | 否 | | API 网关服务名称, 默认创建一个新的服务名称 |
80
- | serviceId | 否 | | API 网关服务 ID,如果存在将使用这个 API 网关服务 |
81
- | src | 否 | ` process.cwd()` | 默认为当前目录, 如果是对象, 配置参数参考 [执行目录](#src-object) |
82
- | layers | 否 | | 云函数绑定的 layer, 配置参数参考 [层配置](#layer) |
83
- | exclude | 否 | | 不包含的文件 |
84
- | include | 否 | | 包含的文件, 如果是相对路径,是相对于 `serverless.yml`的路径 |
85
- | [functionConf](#funtionConf) | 否 | | 函数配置 |
86
- | [apigatewayConf](#apigatewayConf) | 否 | | API 网关配置 |
87
- | [cloudDNSConf](#cloudDNSConf ) | 否 | | DNS 配置 |
88
- | [Region special config](#apigatewayConf ) | 否 | | 指定区配置 |
75
+ | 参数名称 | 是否必选 | 默认值 | 描述 |
76
+ | ------------------------------------ | :------: | :-------------: | :------------------------------------------------------------------ |
77
+ | runtime | 否 | Nodejs10.15 | 执行环境, 目前支持: Nodejs6.10, Nodejs8.9, Nodejs10.15, Nodejs12.16 |
78
+ | region | 否 | ap-guangzhou | 项目部署所在区域,默认广州区 |
79
+ | functionName | 否 | | 云函数名称 |
80
+ | serviceName | 否 | | API 网关服务名称, 默认创建一个新的服务名称 |
81
+ | serviceId | 否 | | API 网关服务 ID,如果存在将使用这个 API 网关服务 |
82
+ | src | 否 | ` process.cwd()` | 默认为当前目录, 如果是对象, 配置参数参考 [执行目录](#执行目录) |
83
+ | layers | 否 | | 云函数绑定的 layer, 配置参数参考 [层配置](#层配置) |
84
+ | exclude | 否 | | 不包含的文件 |
85
+ | include | 否 | | 包含的文件, 如果是相对路径,是相对于 `serverless.yml`的路径 |
86
+ | [functionConf](#函数配置) | 否 | | 函数配置 |
87
+ | [apigatewayConf](#API-网关配置) | 否 | | API 网关配置 |
88
+ | [cloudDNSConf](#DNS-配置 ) | 否 | | DNS 配置 |
89
+ | [Region special config](#指定区配置 ) | 否 | | 指定区配置 |
89
90
90
91
# # 执行目录
91
92
@@ -114,11 +115,11 @@ inputs:
114
115
115
116
# ## 指定区配置
116
117
117
- | 参数名称 | 是否必选 | 类型 | 默认值 | 函数 |
118
- | --------------------------------- | :------ : | ------ | ------ | ------------ |
119
- | [functionConf](#funtionConf) | 否 | Object | | 函数配置 |
120
- | [apigatewayConf](#apigatewayConf ) | 否 | Object | | API 网关配置 |
121
- | [cloudDNSConf](#cloudDNSConf) | 否 | Object | | DNS 配置 |
118
+ | 参数名称 | 是否必选 | 类型 | 默认值 | 函数 |
119
+ | ------------------------------- | :------ : | ------ | ------ | ------------ |
120
+ | [functionConf](#函数配置) | 否 | Object | | 函数配置 |
121
+ | [apigatewayConf](#API-网关配置 ) | 否 | Object | | API 网关配置 |
122
+ | [cloudDNSConf](#DNS-配置) | 否 | Object | | DNS 配置 |
122
123
123
124
# ## 函数配置
124
125
@@ -128,8 +129,8 @@ inputs:
128
129
| ----------- | :------ : | :----: | :----: | :------------------------------------------------------------------------------ |
129
130
| timeout | 否 | Number | 3 | 函数最长执行时间,单位为秒,可选值范围 1-900 秒,默认为 3 秒 |
130
131
| memorySize | 否 | Number | 128 | 函数运行时内存大小,默认为 128M,可选范围 64、128MB-3072MB,并且以 128MB 为阶梯 |
131
- | environment | 否 | Object | | 函数的环境变量, 参考 [环境变量](#environment) |
132
- | vpcConfig | 否 | Object | | 函数的 VPC 配置, 参考 [VPC 配置](#vpcConfig) |
132
+ | environment | 否 | Object | | 函数的环境变量, 参考 [环境变量](#环境变量) |
133
+ | vpcConfig | 否 | Object | | 函数的 VPC 配置, 参考 [VPC 配置](#VPC-配置) |
133
134
134
135
# #### 环境变量
135
136
@@ -150,12 +151,13 @@ inputs:
150
151
| ------------ | :------ : | :------- | :------- | :--------------------------------------------------------------------------------- |
151
152
| protocols | 否 | String[] | ['http'] | 前端请求的类型,如 http,https,http 与 https |
152
153
| environment | 否 | String | release | 发布环境. 目前支持三种发布环境 : test(测试), prepub(预发布) 与 release(发布). |
153
- | usagePlan | 否 | | | 使用计划配置, 参考 [使用计划](#usagePlan) |
154
- | auth | 否 | | | API 密钥配置, 参考 [API 密钥](#auth) |
155
- | customDomain | 否 | Object[] | | 自定义 API 域名配置, 参考 [自定义域名](#customDomain) |
156
- | isDisabled | 否 | Boolean | false | 关闭自动创建 API 网关功能。默认值为否,即默认自动创建 API 网关。 |
154
+ | usagePlan | 否 | | | 使用计划配置, 参考 [使用计划](#使用计划) |
155
+ | auth | 否 | | | API 密钥配置, 参考 [API 密钥](#API-密钥配置) |
156
+ | customDomain | 否 | Object[] | | 自定义 API 域名配置, 参考 [自定义域名](#自定义域名) |
157
+ | enableCORS | 否 | Boolean | `false` | 开启跨域。默认值为否。 |
158
+ | isDisabled | 否 | Boolean | `false` | 关闭自动创建 API 网关功能。默认值为否,即默认自动创建 API 网关。 |
157
159
158
- - 使用计划
160
+ # #### 使用计划
159
161
160
162
参考 : https:# cloud.tencent.com/document/product/628/14947
161
163
@@ -166,7 +168,7 @@ inputs:
166
168
| usagePlanDesc | 否 | String | 用户自定义的使用计划描述 |
167
169
| maxRequestNum | 否 | Int | 请求配额总数,如果为空,将使用-1 作为默认值,表示不开启 |
168
170
169
- - API 密钥配置
171
+ # #### API 密钥配置
170
172
171
173
参考 : https:# cloud.tencent.com/document/product/628/14916
172
174
0 commit comments