AccessInfo
HTTP域名相关信息
被如下接口引用:GetFunction。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
Host | String | 是 | 域名 |
Vip | String | 是 | VIP |
Alias
函数的版本别名
被如下接口引用:ListAliases。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
FunctionVersion | String | 是 | 别名指向的主版本 |
Name | String | 是 | 别名的名称 |
RoutingConfig | RoutingConfig | 是 | 别名的路由信息 注意:此字段可能返回 null,表示取不到有效值。 |
Description | String | 否 | 描述信息 注意:此字段可能返回 null,表示取不到有效值。 |
AddTime | Timestamp | 否 | 创建时间 注意:此字段可能返回 null,表示取不到有效值。 |
ModTime | Timestamp | 否 | 更新时间 注意:此字段可能返回 null,表示取不到有效值。 |
AsyncEvent
异步事件
被如下接口引用:ListAsyncEvents。
名称 | 类型 | 描述 |
---|---|---|
InvokeRequestId | String | 调用请求id 示例值:xxxx-yyyy-zzzz |
InvokeType | String | 调用类型 示例值:TRIGGER_TIMER |
Qualifier | String | 函数版本 示例值:$LATEST |
Status | String | 事件状态,RUNNING 表示运行中, FINISHED 表示调用成功, ABORTED 表示调用终止, FAILED 表示调用失败 示例值:FINISHED |
StartTime | String | 调用开始时间,格式: "%Y-%m-%d %H:%M:%S.%f" 示例值:2021-01-01 00:00:00.001 |
EndTime | String | 调用结束时间,格式: "%Y-%m-%d %H:%M:%S.%f" 示例值:2021-01-01 00:00:00.002 |
AsyncEventStatus
异步事件状态
被如下接口引用:GetAsyncEventStatus。
名称 | 类型 | 描述 |
---|---|---|
Status | String | 异步事件状态,RUNNING 表示运行中, FINISHED 表示调用成功, ABORTED 表示调用终止, FAILED 表示调用失败。 示例值:RUNNING |
StatusCode | Integer | 请求状态码 示例值:200 |
InvokeRequestId | String | 异步执行请求 Id 示例值:ea7bb7c7-c312-4255-b7dc-b2bf0cfda10e |
AsyncTriggerConfig
函数的异步重试配置详情
被如下接口引用:GetFunctionEventInvokeConfig, UpdateFunctionEventInvokeConfig。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
RetryConfig | Array of RetryConfig | 是 | 用户错误的异步重试重试配置 |
MsgTTL | Integer | 是 | 消息保留时间 |
CertConf
证书配置
被如下接口引用:CreateCustomDomain, GetCustomDomain, ListCustomDomains, UpdateCustomDomain。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
CertificateId | String | 否 | ssl证书ID 注意:此字段可能返回 null,表示取不到有效值。 |
CfsConfig
文件系统(cfs)配置描述
被如下接口引用:CreateFunction, GetFunction, UpdateFunctionConfiguration。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
CfsInsList | Array of CfsInsInfo | 是 | 文件系统信息列表 |
CfsInsInfo
云函数关联的cfs配置信息
被如下接口引用:CreateFunction, GetFunction, UpdateFunctionConfiguration。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
UserId | String | 是 | 用户id |
UserGroupId | String | 是 | 用户组id |
CfsId | String | 是 | 文件系统实例id |
MountInsId | String | 是 | 文件系统挂载点id |
LocalMountDir | String | 是 | 本地挂载点 |
RemoteMountDir | String | 是 | 远程挂载点 |
IpAddress | String | 否 | 文件系统ip,配置 cfs 时无需填写。 注意:此字段可能返回 null,表示取不到有效值。 注意:此字段可能返回 null,表示取不到有效值。 |
MountVpcId | String | 否 | 文件系统所在的私有网络id,配置 cfs 时无需填写。 注意:此字段可能返回 null,表示取不到有效值。 注意:此字段可能返回 null,表示取不到有效值。 |
MountSubnetId | String | 否 | 文件系统所在私有网络的子网id,配置 cfs 时无需填写。 注意:此字段可能返回 null,表示取不到有效值。 注意:此字段可能返回 null,表示取不到有效值。 |
Code
函数代码
被如下接口引用:CreateFunction, PublishLayerVersion, UpdateFunctionCode。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
CosBucketName | String | 否 | 对象存储桶名称(填写存储桶名称自定义部分,不包含-appid) 示例值:BucketName |
CosObjectName | String | 否 | 对象存储中代码包文件路径,以/开头 示例值:ObjectName |
ZipFile | String | 否 | 包含函数代码文件及其依赖项的 zip 格式文件,zip包大小上限为 50MB,使用该接口时要求将 zip 文件的内容转成 base64 编码 示例值:base64编码 |
CosBucketRegion | String | 否 | 对象存储的地域,地域为北京时需要传入ap-beijing,北京一区时需要传递ap-beijing-1,其他的地域不需要传递。 示例值:ap-chongqing |
DemoId | String | 否 | 如果是通过Demo创建的话,需要传入DemoId 示例值:Demo的Id |
TempCosObjectName | String | 否 | 如果是从TempCos创建的话,需要传入TempCosObjectName 示例值:TempCosObjectName |
GitUrl | String | 否 | Git地址。该功能已下线。 示例值:Git地址 |
GitUserName | String | 否 | Git用户名。该功能已下线。 示例值:Git用户名 |
GitPassword | String | 否 | Git密码。该功能已下线。 示例值:Git密码 |
GitPasswordSecret | String | 否 | 加密后的Git密码,一般无需指定。该功能已下线。 示例值:加密后的Git密码 |
GitBranch | String | 否 | Git分支。该功能已下线。 示例值:Git分支 |
GitDirectory | String | 否 | 代码在Git仓库中的路径。该功能已下线。 示例值:代码在Git仓库中的路径 |
GitCommitId | String | 否 | 指定要拉取的版本。该功能已下线。 示例值:Git拉取的版本 |
GitUserNameSecret | String | 否 | 加密后的Git用户名,一般无需指定。该功能已下线。 示例值:加密后的Git用户名 |
ImageConfig | ImageConfig | 否 | 镜像部署时配置TCR镜像信息 示例值:TCR镜像配置 |
DeadLetterConfig
死信队列参数
被如下接口引用:CreateFunction, GetFunction, UpdateFunctionConfiguration。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
Type | String | 是 | 死信队列模式 |
Name | String | 是 | 死信队列名称 |
FilterType | String | 否 | 死信队列主题模式的标签形式 |
DomainInfo
云函数自定义域名详情
被如下接口引用:ListCustomDomains。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
Domain | String | 是 | 域名,不支持泛域名 |
Protocol | String | 否 | 协议,取值范围:HTTP, HTTPS, HTTP&HTTPS |
EndpointsConfig | Array of EndpointsConf | 否 | 路由配置信息 注意:此字段可能返回 null,表示取不到有效值。 |
CertConfig | CertConf | 否 | 证书配置信息,HTTPS协议必传路由配置 注意:此字段可能返回 null,表示取不到有效值。 |
WafConfig | WafConf | 否 | web 应用防火墙配置 注意:此字段可能返回 null,表示取不到有效值。 |
EipConfigIn
公网访问固定ip配置
被如下接口引用:CreateFunction, UpdateFunctionConfiguration。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
EipStatus | String | 是 | Eip开启状态,取值['ENABLE','DISABLE'] |
EipConfigOut
公网访问固定ip配置
被如下接口引用:GetFunction。
名称 | 类型 | 描述 |
---|---|---|
EipStatus | String | 是否是固定IP,["ENABLE","DISABLE"] |
EipAddress | Array of String | IP列表 注意:此字段可能返回 null,表示取不到有效值。 |
EipOutConfig
EipOutConfig
被如下接口引用:GetFunction。
名称 | 类型 | 描述 |
---|---|---|
EipFixed | String | 是否是固定IP,["TRUE","FALSE"] |
Eips | Array of String | IP列表 |
EndpointsConf
后端路由配置信息
被如下接口引用:CreateCustomDomain, GetCustomDomain, ListCustomDomains, UpdateCustomDomain。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
Namespace | String | 是 | 函数命名空间 注意:此字段可能返回 null,表示取不到有效值。 |
FunctionName | String | 是 | 函数名 注意:此字段可能返回 null,表示取不到有效值。 |
Qualifier | String | 是 | 函数别名或版本 注意:此字段可能返回 null,表示取不到有效值。 |
PathMatch | String | 是 | 路径,取值规范:/,/,/xxx,/xxx/a,/xxx/" 注意:此字段可能返回 null,表示取不到有效值。 |
PathRewrite | Array of PathRewriteRule | 否 | 路径重写策略 注意:此字段可能返回 null,表示取不到有效值。 |
Environment
函数的环境变量参数
被如下接口引用:CreateFunction, GetFunction, UpdateFunctionConfiguration。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
Variables | Array of Variable | 否 | 环境变量数组 |
Filter
描述键值对过滤器,用于条件过滤查询。例如过滤ID、名称、状态等
若存在多个Filter时,Filter间的关系为逻辑与(AND)关系。
若同一个Filter存在多个Values,同一Filter下Values间的关系为逻辑或(OR)关系。
被如下接口引用:ListCustomDomains, ListFunctions, ListTriggers。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
Name | String | 是 | 需要过滤的字段。过滤条件数量限制为10。 Name可选值:VpcId, SubnetId, ClsTopicId, ClsLogsetId, Role, CfsId, CfsMountInsId, Eip;Values 长度限制为1。 Name可选值:Status, Runtime, FunctionType, PublicNetStatus, AsyncRunEnable, TraceEnable;Values 长度限制为20。 当 Name = Runtime 时,CustomImage 表示过滤镜像类型函数。 示例值:Status |
Values | Array of String | 是 | 字段的过滤值。 示例值:["Creating", "Updating", "Deleting"] |
Function
函数列表
被如下接口引用:ListFunctions。
名称 | 类型 | 描述 |
---|---|---|
ModTime | String | 修改时间 示例值:2021-01-10 23:49:31 |
AddTime | String | 创建时间 示例值:2021-01-10 23:49:31 |
Runtime | String | 运行时 注意:此字段可能返回 null,表示取不到有效值。 示例值:python2.7 |
FunctionName | String | 函数名称 示例值:helloworld |
FunctionId | String | 函数ID 示例值:lam-functionid |
Namespace | String | 命名空间 示例值:Default |
Status | String | 函数状态,状态值及流转参考此处 示例值:Active |
StatusDesc | String | 函数状态详情 示例值:"" |
Description | String | 函数描述 示例值:"" |
Tags | Array of Tag | 函数标签 示例值:[] |
Type | String | 函数类型,取值为 HTTP 或者 Event 示例值:Event |
StatusReasons | Array of StatusReason | 函数状态失败原因 示例值:"" |
TotalProvisionedConcurrencyMem | Integer | 函数所有版本预置并发内存总和 注意:此字段可能返回 null,表示取不到有效值。 示例值:128000 |
ReservedConcurrencyMem | Integer | 函数并发保留内存 注意:此字段可能返回 null,表示取不到有效值。 示例值:12800 |
AsyncRunEnable | String | 函数异步属性,取值 TRUE 或者 FALSE 示例值:FALSE |
TraceEnable | String | 异步函数是否开启调用追踪,取值 TRUE 或者 FALSE 示例值:FALSE |
FunctionLog
日志信息
被如下接口引用:GetFunctionLogs。
名称 | 类型 | 描述 |
---|---|---|
FunctionName | String | 函数的名称 |
RetMsg | String | 函数执行完成后的返回值 |
RequestId | String | 执行该函数对应的requestId |
StartTime | String | 函数开始执行时的时间点 |
RetCode | Integer | 函数执行结果,如果是 0 表示执行成功,其他值表示失败 |
InvokeFinished | Integer | 函数调用是否结束,如果是 1 表示执行结束,其他值表示调用异常 |
Duration | Float | 函数执行耗时,单位为 ms |
BillDuration | Integer | 函数计费时间,根据 duration 向上取最近的 100ms,单位为ms |
MemUsage | Integer | 函数执行时消耗实际内存大小,单位为 Byte |
Log | String | 函数执行过程中的日志输出 |
Level | String | 日志等级 |
Source | String | 日志来源 |
RetryNum | Integer | 重试次数 |
FunctionVersion
函数版本信息
被如下接口引用:ListVersionByFunction。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
Version | String | 是 | 函数版本名称 示例值:"" |
Description | String | 否 | 版本描述信息 注意:此字段可能返回 null,表示取不到有效值。 示例值:"" |
AddTime | Timestamp | 否 | 创建时间 注意:此字段可能返回 null,表示取不到有效值。 示例值:"" |
ModTime | Timestamp | 否 | 更新时间 注意:此字段可能返回 null,表示取不到有效值。 示例值:"" |
Status | String | 否 | 版本状态 注意:此字段可能返回 null,表示取不到有效值。 示例值:"" |
ImageConfig
TCR镜像信息描述
被如下接口引用:CreateFunction, GetFunction, PublishLayerVersion, UpdateFunctionCode。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
ImageType | String | 是 | 镜像仓库类型,个人版或者企业版:personal/enterprise 示例值:enterprise |
ImageUri | String | 是 | {domain}/{namespace}/{imageName}:{tag}@{digest} 示例值:tcr.tencentcloudcr.com/namespace/test:latest |
RegistryId | String | 否 | 用于企业版TCR获取镜像拉取临时凭证,ImageType为"enterprise"时必填 注意:此字段可能返回 null,表示取不到有效值。 示例值:tcr-xxx |
EntryPoint | String | 否 | 参数已废弃 注意:此字段可能返回 null,表示取不到有效值。 示例值:"entrypoint.sh" |
Command | String | 否 | 容器的启动命令。该参数为可选参数,如果不填写,则默认使用 Dockerfile 中的 Entrypoint。传入规范,填写可运行的指令,例如 python 注意:此字段可能返回 null,表示取不到有效值。 示例值:"" |
Args | String | 否 | 容器的启动参数。该参数为可选参数,如果不填写,则默认使用 Dockerfile 中的 CMD。传入规范,以“空格”作为参数的分割标识,例如 -u app.py 注意:此字段可能返回 null,表示取不到有效值。 示例值:"' |
ContainerImageAccelerate | Boolean | 否 | 镜像加速开关,默认False 注意:此字段可能返回 null,表示取不到有效值。 示例值:False |
ImagePort | Integer | 否 | 镜像函数端口设置,可指定镜像类型 Web Server镜像:9000 Job 镜像:-1 注意:此字段可能返回 null,表示取不到有效值。 默认值:9000 示例值:9000 注意:此字段可能返回 null,表示取不到有效值。 示例值:9000 |
InstanceConcurrencyConfig
多并发执行配置描述
被如下接口引用:CreateFunction, UpdateFunctionConfiguration。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
DynamicEnabled | String | 否 | 是否开启智能动态并发。'FALSE'时是静态并发。''时取消多并发配置。 注意:此字段可能返回 null,表示取不到有效值。 示例值:'FALSE' |
MaxConcurrency | Integer | 否 | 单实例并发数最大值。取值范围 [1,100] 注意:此字段可能返回 null,表示取不到有效值。 示例值:1 |
IntranetConfigIn
内网配置
被如下接口引用:CreateFunction, UpdateFunctionConfiguration。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
IpFixed | String | 是 | 是否开启固定内网IP ENABLE 为开启 DISABLE 为不开启 示例值:ENABLE |
IntranetConfigOut
内网配置
被如下接口引用:GetFunction。
名称 | 类型 | 描述 |
---|---|---|
IpFixed | String | 是否启用固定内网IP ENABLE 为启用 DISABLE 为不启用 示例值:ENABLE |
IpAddress | Array of String | 若已启用固定内网IP,则该字段返回使用的IP列表 注意:此字段可能返回 null,表示取不到有效值。 |
K8SLabel
k8s label
被如下接口引用:CreateNamespace。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
Key | String | 是 | label的名称 示例值:labelkey |
Value | String | 是 | label的值 示例值:labelvalue |
K8SToleration
Kubernetes污点容忍,使用时请注意您的Kubernetes版本所支持的字段情况。
可参考 https://kubernetes.io/zh-cn/docs/concepts/scheduling-eviction/taint-and-toleration/
被如下接口引用:CreateNamespace。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
Key | String | 否 | 匹配的污点名 示例值:key1 |
Operator | String | 否 | 匹配方式,默认值为: Equal 注意:此字段可能返回 null,表示取不到有效值。 示例值:Equal |
Effect | String | 否 | 执行策略 注意:此字段可能返回 null,表示取不到有效值。 示例值:NoExecute |
Value | String | 否 | 匹配的污点值,当Operator为Equal时必填 注意:此字段可能返回 null,表示取不到有效值。 示例值:value1 |
TolerationSeconds | Integer | 否 | 当污点不被容忍时,Pod还能在节点上运行多久 注意:此字段可能返回 null,表示取不到有效值。 示例值:3600 |
LayerVersionInfo
层版本信息
被如下接口引用:GetFunction, ListLayerVersions, ListLayers。
名称 | 类型 | 描述 |
---|---|---|
CompatibleRuntimes | Array of String | 版本适用的运行时 注意:此字段可能返回 null,表示取不到有效值。 |
AddTime | String | 创建时间 |
Description | String | 版本描述 注意:此字段可能返回 null,表示取不到有效值。 |
LicenseInfo | String | 许可证信息 注意:此字段可能返回 null,表示取不到有效值。 |
LayerVersion | Integer | 版本号 |
LayerName | String | 层名称 |
Status | String | 层的具体版本当前状态,状态值参考此处 |
Stamp | String | Stamp 注意:此字段可能返回 null,表示取不到有效值。 |
Tags | Array of Tag | 返回层绑定的标签信息 注意:此字段可能返回 null,表示取不到有效值。 |
LayerVersionSimple
指定某个Layer版本
被如下接口引用:CreateFunction, UpdateFunctionConfiguration。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
LayerName | String | 是 | 绑定的层名称。解绑层需传递空字符串。 示例值:layername |
LayerVersion | Integer | 是 | 绑定或解绑层的版本号。解绑函数版本关联的最后一个层版本时,LayerVersion 填 0。 示例值:1 |
LimitsInfo
限制信息
被如下接口引用:GetAccount。
名称 | 类型 | 描述 |
---|---|---|
NamespacesCount | Integer | 命名空间个数限制 |
Namespace | Array of NamespaceLimit | 命名空间限制信息 |
LogFilter
日志过滤条件,用于区分正确与错误日志
被如下接口引用:GetFunctionLogs。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
RetCode | String | 否 | filter.RetCode的取值有: not0 表示只返回错误日志, is0 表示只返回正确日志, TimeLimitExceeded 返回函数调用发生超时的日志, ResourceLimitExceeded 返回函数调用发生资源超限的日志, UserCodeException 返回函数调用发生用户代码错误的日志, 无输入则返回所有日志。 |
LogSearchContext
日志搜索上下文
被如下接口引用:GetFunctionLogs。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
Offset | String | 是 | 偏移量 |
Limit | Integer | 是 | 日志条数 |
Keyword | String | 否 | 日志关键词 |
Type | String | 否 | 日志类型,支持Application和Platform,默认为Application |
Namespace
命名空间
被如下接口引用:ListNamespaces。
名称 | 类型 | 描述 |
---|---|---|
ModTime | Timestamp | 命名空间创建时间 示例值:0000-00-00 00:00 |
AddTime | Timestamp | 命名空间修改时间 示例值:0000-00-00 00:00 |
Description | String | 命名空间描述 示例值:test |
Name | String | 命名空间名称 示例值:test |
Type | String | 默认default,TCB表示是小程序云开发创建的 示例值:Default |
NamespaceLimit
命名空间限制
被如下接口引用:GetAccount。
名称 | 类型 | 描述 |
---|---|---|
FunctionsCount | Integer | 函数总数 示例值:0 |
Trigger | TriggerCount | Trigger信息 |
Namespace | String | Namespace名称 示例值:"" |
ConcurrentExecutions | Integer | 并发量 示例值:0 |
TimeoutLimit | Integer | Timeout限制 示例值:0 |
TestModelLimit | Integer | 测试事件限制 注意:此字段可能返回 null,表示取不到有效值。 示例值:0 |
InitTimeoutLimit | Integer | 初始化超时限制 示例值:0 |
RetryNumLimit | Integer | 异步重试次数限制 示例值:0 |
MinMsgTTL | Integer | 异步重试消息保留时间下限 示例值:0 |
MaxMsgTTL | Integer | 异步重试消息保留时间上限 示例值:0 |
NamespaceResourceEnv
命名空间资源池配置
被如下接口引用:CreateNamespace。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
TKE | NamespaceResourceEnvTKE | 否 | 基于TKE集群的资源池 注意:此字段可能返回 null,表示取不到有效值。 示例值:x |
NamespaceResourceEnvTKE
基于TKE的资源池选项
被如下接口引用:CreateNamespace。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
ClusterID | String | 是 | 集群ID 示例值:cls-xxxx |
SubnetID | String | 是 | 子网ID 示例值:subnet-xx |
Namespace | String | 是 | 命名空间 示例值:kube-system |
DataPath | String | 否 | 数据存储地址 注意:此字段可能返回 null,表示取不到有效值。 示例值:/var/lib/scf |
NodeSelector | Array of K8SLabel | 否 | node选择器 注意:此字段可能返回 null,表示取不到有效值。 示例值:Key0=a,Value0=x |
Tolerations | Array of K8SToleration | 否 | 污点容忍 注意:此字段可能返回 null,表示取不到有效值。 示例值:Key: "key1" Operator: "Exists" |
Port | Integer | 否 | scf组件将占用的节点端口起始号 注意:此字段可能返回 null,表示取不到有效值。 示例值:38002 |
PodTemplatePatch | String | 否 | yaml格式的pod patch内容,例如 metadata: labels: key: value 注意:此字段可能返回 null,表示取不到有效值。 |
NamespaceUsage
名称空间已使用信息
被如下接口引用:GetAccount。
名称 | 类型 | 描述 |
---|---|---|
Functions | Array of String | 函数数组 示例值:func1 |
Namespace | String | 命名空间名称 示例值:default |
FunctionsCount | Integer | 命名空间函数个数 示例值:1 |
TotalConcurrencyMem | Integer | 命名空间配额总量 注意:此字段可能返回 null,表示取不到有效值。 示例值:0 |
TotalAllocatedConcurrencyMem | Integer | 命名空间并发使用量 注意:此字段可能返回 null,表示取不到有效值。 示例值:0 |
TotalAllocatedProvisionedMem | Integer | 命名空间预置使用量 注意:此字段可能返回 null,表示取不到有效值。 示例值:0 |
PathRewriteRule
路径路由重写规则
被如下接口引用:CreateCustomDomain, GetCustomDomain, UpdateCustomDomain。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
Path | String | 是 | 需要重路由的路径,取值规范:/,/,/xxx,/xxx/a,/xxx/ 注意:此字段可能返回 null,表示取不到有效值。 示例值:/aa/ |
Type | String | 是 | 匹配规,取值范围: WildcardRules 通配符匹配, ExactRules 精确匹配 注意:此字段可能返回 null,表示取不到有效值。 示例值:ExactRules |
Rewrite | String | 是 | 替换值:比如/, /$ 注意:此字段可能返回 null,表示取不到有效值。 示例值:/ |
ProtocolParams
HTTP函数支持其他访问协议的参数
被如下接口引用:CreateFunction, GetFunction, UpdateFunctionConfiguration。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
WSParams | WSParams | 否 | WebSockets协议支持的参数 注意:此字段可能返回 null,表示取不到有效值。 示例值:{ IdleTimeOut: 15 } |
PublicNetConfigIn
公网访问配置
被如下接口引用:CreateFunction, UpdateFunctionConfiguration。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
PublicNetStatus | String | 是 | 是否开启公网访问能力取值['DISABLE','ENABLE'] |
EipConfig | EipConfigIn | 否 | Eip配置 |
PublicNetConfigOut
公网访问配置
被如下接口引用:GetFunction。
名称 | 类型 | 描述 |
---|---|---|
PublicNetStatus | String | 是否开启公网访问能力取值['DISABLE','ENABLE'] |
EipConfig | EipConfigOut | Eip配置 |
RequestStatus
函数运行状态
被如下接口引用:GetRequestStatus。
名称 | 类型 | 描述 |
---|---|---|
FunctionName | String | 函数的名称 示例值:"" |
RetMsg | String | 函数执行完成后的返回值 示例值:"" |
RequestId | String | 查询的请求 id 示例值:"" |
StartTime | String | 请求开始时间 示例值:"" |
RetCode | Integer | 请求执行结果, 0 表示执行成功,1表示运行中,-1 表示执行异常。 示例值:0 |
Duration | Float | 请求运行耗时,单位:ms 示例值:0 |
MemUsage | Float | 请求消耗内存,单位为 MB 示例值:0 |
RetryNum | Integer | 重试次数 示例值:0 |
Result
运行函数的返回
被如下接口引用:Invoke, InvokeFunction。
名称 | 类型 | 描述 |
---|---|---|
Log | String | 表示执行过程中的日志输出,异步调用返回为空 示例值:"" |
RetMsg | String | 表示执行函数的返回,异步调用返回为空 示例值:"hello from scf" |
ErrMsg | String | 表示执行函数的错误返回信息,异步调用返回为空 示例值:" " |
MemUsage | Integer | 执行函数时的内存大小,单位为Byte,异步调用返回为空 示例值:32 |
Duration | Float | 表示执行函数的耗时,单位是毫秒,异步调用返回为空 示例值:100 |
BillDuration | Integer | 表示函数的计费耗时,单位是毫秒,异步调用返回为空 示例值:100 |
FunctionRequestId | String | 此次函数执行的Id 示例值:c2af8a64-c922-4d55-aee0-bd86a5c2cd12 |
InvokeResult | Integer | 请求 Invoke 接口,该参数已弃用。请求 InvokeFunction 接口,该参数值为请求执行状态码。 示例值:200 |
RetryConfig
异步重试配置
被如下接口引用:GetFunctionEventInvokeConfig, UpdateFunctionEventInvokeConfig。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
RetryNum | Integer | 是 | 重试次数 |
RoutingConfig
别名的版本路由配置
其中:随机权重路由附加版本和规则路由附加版本不可以同时配置
被如下接口引用:CreateAlias, GetAlias, ListAliases, UpdateAlias。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
AdditionalVersionWeights | Array of VersionWeight | 否 | 随机权重路由附加版本 示例值:[ { "Version":"1", "Weight":0.01 } ] |
AddtionVersionMatchs | Array of VersionMatch | 否 | 规则路由附加版本 示例值:[ { "Version":"1", "Key":"invoke.headers.User", "Method":"exact", "Expression":"testuser" } ] |
SearchKey
包含搜索关键字和对应的内容
被如下接口引用:ListNamespaces。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
Key | String | 是 | 搜索关键字 |
Value | String | 是 | 搜索内容 |
StatusReason
状态原因描述
被如下接口引用:GetFunction, ListFunctions。
名称 | 类型 | 描述 |
---|---|---|
ErrorCode | String | 错误码 |
ErrorMessage | String | 错误描述 |
Tag
函数标签
被如下接口引用:CreateFunction, GetFunction, ListFunctions, ListLayerVersions, ListLayers, PublishLayerVersion。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
Key | String | 是 | 标签的key |
Value | String | 是 | 标签的value |
TimeInterval
左闭右开时间区间,包括起始时间和结束时间,格式为"%Y-%m-%d %H:%M:%S"
被如下接口引用:ListAsyncEvents。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
Start | String | 是 | 起始时间(包括在内),格式"%Y-%m-%d %H:%M:%S" |
End | String | 是 | 结束时间(不包括在内),格式"%Y-%m-%d %H:%M:%S" |
Trigger
触发器类型
被如下接口引用:CreateTrigger, GetFunction。
名称 | 类型 | 描述 |
---|---|---|
ModTime | Timestamp | 触发器最后修改时间 |
Type | String | 触发器类型 |
TriggerDesc | String | 触发器详细配置 |
TriggerName | String | 触发器名称 |
AddTime | Timestamp | 触发器创建时间 |
Enable | Integer | 使能开关 |
CustomArgument | String | 客户自定义参数 |
AvailableStatus | String | 触发器状态 |
Qualifier | String | 触发器绑定的别名或版本 |
Description | String | 触发器描述 |
TriggerAction
预置定时任务动作
被如下接口引用:GetProvisionedConcurrencyConfig, PutProvisionedConcurrencyConfig。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
TriggerName | String | 是 | 定时预置名称 注意:此字段可能返回 null,表示取不到有效值。 示例值:"" |
TriggerProvisionedConcurrencyNum | Integer | 是 | 定时预置并发数量 注意:此字段可能返回 null,表示取不到有效值。 示例值:0 |
TriggerCronConfig | String | 是 | 设置定时触发器的时间配置,cron表达式。Cron 表达式有七个必需字段,按空格分隔。 注意:此字段可能返回 null,表示取不到有效值。 示例值:"" |
ProvisionedType | String | 否 | 预置类型 Default 注意:此字段可能返回 null,表示取不到有效值。 示例值:"" |
TriggerCount
TriggerCount描述不同类型触发器的数量
被如下接口引用:GetAccount。
名称 | 类型 | 描述 |
---|---|---|
Cos | Integer | Cos触发器数量 示例值:0 |
Timer | Integer | Timer触发器数量 示例值:0 |
Cmq | Integer | Cmq触发器数量 示例值:0 |
Total | Integer | 触发器总数 示例值:0 |
Ckafka | Integer | Ckafka触发器数量 示例值:0 |
Apigw | Integer | Apigw触发器数量 示例值:0 |
Cls | Integer | Cls触发器数量 示例值:0 |
Clb | Integer | Clb触发器数量 示例值:0 |
Mps | Integer | Mps触发器数量 示例值:0 |
Cm | Integer | Cm触发器数量 示例值:0 |
Vod | Integer | Vod触发器数量 示例值:0 |
Eb | Integer | Eb触发器数量 注意:此字段可能返回 null,表示取不到有效值。 示例值:0 |
TriggerInfo
触发器信息
被如下接口引用:ListTriggers。
名称 | 类型 | 描述 |
---|---|---|
Enable | Integer | 使能开关 |
Qualifier | String | 函数版本或别名 |
TriggerName | String | 触发器名称 |
Type | String | 触发器类型 |
TriggerDesc | String | 触发器详细配置 |
AvailableStatus | String | 触发器是否可用 |
CustomArgument | String | 客户自定义参数 注意:此字段可能返回 null,表示取不到有效值。 |
AddTime | Timestamp | 触发器创建时间 |
ModTime | Timestamp | 触发器最后修改时间 |
Description | String | 客户自定义触发器描述 注意:此字段可能返回 null,表示取不到有效值。 |
UsageInfo
已使用的信息
被如下接口引用:GetAccount。
名称 | 类型 | 描述 |
---|---|---|
NamespacesCount | Integer | 命名空间个数 |
Namespace | Array of NamespaceUsage | 命名空间详情 |
TotalConcurrencyMem | Integer | 当前地域用户并发内存配额上限 |
TotalAllocatedConcurrencyMem | Integer | 当前地域用户已配置并发内存额度 |
UserConcurrencyMemLimit | Integer | 用户实际配置的账号并发配额 |
Variable
变量参数
被如下接口引用:CreateFunction, GetFunction, UpdateFunctionConfiguration。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
Key | String | 否 | 变量的名称,不可为空字符 示例值:testKey |
Value | String | 否 | 变量的值,不可为空字符 示例值:testValue |
VersionMatch
带有匹配规则的函数版本
被如下接口引用:CreateAlias, GetAlias, UpdateAlias。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
Version | String | 是 | 函数版本名称 |
Key | String | 是 | 匹配规则的key,调用时通过传key来匹配规则路由到指定版本 header方式: key填写"invoke.headers.User",并在 invoke 调用函数时传参 RoutingKey:{"User":"value"}规则匹配调用 |
Method | String | 是 | 匹配方式。取值范围: range:范围匹配 exact:字符串精确匹配 |
Expression | String | 是 | range 匹配规则要求: 需要为开区间或闭区间描述 (a,b) [a,b],其中 a、b 均为整数 exact 匹配规则要求: 字符串精确匹配 |
VersionProvisionedConcurrencyInfo
函数版本的预置并发信息,包括设置预置并发数、已完成预置的并发数和预置任务状态。
被如下接口引用:GetProvisionedConcurrencyConfig。
名称 | 类型 | 描述 |
---|---|---|
AllocatedProvisionedConcurrencyNum | Integer | 设置的预置并发数。 示例值:0 |
AvailableProvisionedConcurrencyNum | Integer | 当前已完成预置的并发数。 示例值:0 |
Status | String | 预置任务状态,Done表示已完成,InProgress表示进行中,Failed表示部分或全部失败。 示例值:"" |
StatusReason | String | 对预置任务状态Status的说明。 示例值:"" |
Qualifier | String | 函数版本号 示例值:"" |
TriggerActions | Array of TriggerAction | 预置并发定时任务。 注意:此字段可能返回 null,表示取不到有效值。 |
VersionWeight
带有权重的函数版本
被如下接口引用:CreateAlias, GetAlias, UpdateAlias。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
Version | String | 是 | 函数版本名称 |
Weight | Float | 是 | 该版本的权重 |
VpcConfig
私有网络参数配置
被如下接口引用:CreateFunction, GetFunction, UpdateFunctionConfiguration。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
VpcId | String | 否 | 私有网络 的 Id |
SubnetId | String | 否 | 子网的 Id |
WSParams
HTTP函数通过WebSockets协议访问时的参数
被如下接口引用:CreateFunction, GetFunction, UpdateFunctionConfiguration。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
IdleTimeOut | Integer | 否 | 空闲超时时间, 单位秒,默认15s。可配置范围1~1800s。 注意:此字段可能返回 null,表示取不到有效值。 示例值:15 |
WafConf
web应用防火墙配置信息
被如下接口引用:CreateCustomDomain, GetCustomDomain, ListCustomDomains, UpdateCustomDomain。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
WafOpen | String | 否 | web应用防火墙是否打开, 取值范围:OPEN, CLOSE 注意:此字段可能返回 null,表示取不到有效值。 |
WafInstanceId | String | 否 | web应用防火墙实例ID 注意:此字段可能返回 null,表示取不到有效值。 |