数据结构

最近更新时间:2020-09-24 08:05:36

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,表示取不到有效值。

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 对象存储桶名称
CosObjectName String 对象存储对象路径
ZipFile String 包含函数代码文件及其依赖项的 zip 格式文件,使用该接口时要求将 zip 文件的内容转成 base64 编码,最大支持20M
CosBucketRegion String 对象存储的地域,地域为北京时需要传入ap-beijing,北京一区时需要传递ap-beijing-1,其他的地域不需要传递。
DemoId String 如果是通过Demo创建的话,需要传入DemoId
TempCosObjectName String 如果是从TempCos创建的话,需要传入TempCosObjectName
GitUrl String Git地址
GitUserName String Git用户名
GitPassword String Git密码
GitPasswordSecret String 加密后的Git密码,一般无需指定
GitBranch String Git分支
GitDirectory String 代码在Git仓库中的路径
GitCommitId String 指定要拉取的版本
GitUserNameSecret String 加密后的Git用户名,一般无需指定

DeadLetterConfig

死信队列参数

被如下接口引用:CreateFunction, GetFunction, UpdateFunctionConfiguration。

名称 类型 必选 描述
Type String 死信队列模式
Name String 死信队列名称
FilterType String 死信队列主题模式的标签形式

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列表

Environment

函数的环境变量参数

被如下接口引用:CreateFunction, GetFunction, UpdateFunctionConfiguration。

名称 类型 必选 描述
Variables Array of Variable 环境变量数组

Filter

描述键值对过滤器,用于条件过滤查询。例如过滤ID、名称、状态等 若存在多个Filter时,Filter间的关系为逻辑与(AND)关系。 若同一个Filter存在多个Values,同一Filter下Values间的关系为逻辑或(OR)关系。

被如下接口引用:ListFunctions, ListTriggers。

名称 类型 必选 描述
Name String 需要过滤的字段。
Values Array of String 字段的过滤值。

Function

函数列表

被如下接口引用:ListFunctions。

名称 类型 描述
ModTime String 修改时间
AddTime String 创建时间
Runtime String 运行时
FunctionName String 函数名称
FunctionId String 函数ID
Namespace String 命名空间
Status String 函数状态
StatusDesc String 函数状态详情
Description String 函数描述
Tags Array of Tag 函数标签
Type String 函数类型,取值为 HTTP 或者 Event

FunctionLog

日志信息

被如下接口引用:GetFunctionLogs。

名称 类型 描述
FunctionName String 函数的名称
RetMsg String 函数执行完成后的返回值
RequestId String 执行该函数对应的requestId
StartTime Timestamp 函数开始执行时的时间点
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,表示取不到有效值。

LayerVersionInfo

层版本信息

被如下接口引用:GetFunction, ListLayerVersions, ListLayers。

名称 类型 描述
CompatibleRuntimes Array of String 版本适用的运行时
注意:此字段可能返回 null,表示取不到有效值。
AddTime String 创建时间
Description String 版本描述
注意:此字段可能返回 null,表示取不到有效值。
LicenseInfo String 许可证信息
注意:此字段可能返回 null,表示取不到有效值。
LayerVersion Integer 版本号
LayerName String 层名称
Status String 层的具体版本当前状态,状态值参考此处

LayerVersionSimple

指定某个Layer版本

被如下接口引用:CreateFunction, UpdateFunctionConfiguration。

名称 类型 必选 描述
LayerName String layer名称
LayerVersion Integer 版本号

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 命名空间创建时间
AddTime Timestamp 命名空间修改时间
Description String 命名空间描述
Name String 命名空间名称
Type String 默认default,TCB表示是小程序云开发创建的

PublicNetConfigIn

公网访问配置

被如下接口引用:CreateFunction, UpdateFunctionConfiguration。

名称 类型 必选 描述
PublicNetStatus String 是否开启公网访问能力取值['DISABLE','ENABLE']
EipConfig EipConfigIn Eip配置

PublicNetConfigOut

公网访问配置

被如下接口引用:GetFunction。

名称 类型 描述
PublicNetStatus String 是否开启公网访问能力取值['DISABLE','ENABLE']
EipConfig EipConfigOut Eip配置

Result

运行函数的返回

被如下接口引用:Invoke。

名称 类型 描述
Log String 表示执行过程中的日志输出,异步调用返回为空
RetMsg String 表示执行函数的返回,异步调用返回为空
ErrMsg String 表示执行函数的错误返回信息,异步调用返回为空
MemUsage Integer 执行函数时的内存大小,单位为Byte,异步调用返回为空
Duration Float 表示执行函数的耗时,单位是毫秒,异步调用返回为空
BillDuration Integer 表示函数的计费耗时,单位是毫秒,异步调用返回为空
FunctionRequestId String 此次函数执行的Id
InvokeResult Integer 0为正确,异步调用返回为空

RoutingConfig

别名的版本路由配置

被如下接口引用:CreateAlias, GetAlias, ListAliases, UpdateAlias。

名称 类型 必选 描述
AdditionalVersionWeights Array of VersionWeight 随机权重路由附加版本
AddtionVersionMatchs Array of VersionMatch 规则路由附加版本

StatusReason

状态原因描述

被如下接口引用:GetFunction。

名称 类型 描述
ErrorCode String 错误码
ErrorMessage String 错误描述

Tag

函数标签

被如下接口引用:CreateFunction, GetFunction, ListFunctions。

名称 类型 必选 描述
Key String 标签的key
Value String 标签的value

Trigger

触发器类型

被如下接口引用:CreateTrigger, GetFunction。

名称 类型 描述
ModTime Timestamp 触发器最后修改时间
Type String 触发器类型
TriggerDesc String 触发器详细配置
TriggerName String 触发器名称
AddTime Timestamp 触发器创建时间
Enable Integer 使能开关
CustomArgument String 客户自定义参数
AvailableStatus String 触发器状态

TriggerInfo

触发器信息

被如下接口引用:ListTriggers。

名称 类型 描述
Enable Integer 使能开关
Qualifier String 函数版本或别名
TriggerName String 触发器名称
Type String 触发器类型
TriggerDesc String 触发器详细配置
AvailableStatus String 触发器是否可用
CustomArgument String 客户自定义参数
注意:此字段可能返回 null,表示取不到有效值。
AddTime Timestamp 触发器创建时间
ModTime Timestamp 触发器最后修改时间

Variable

变量参数

被如下接口引用:CreateFunction, GetFunction, UpdateFunctionConfiguration。

名称 类型 必选 描述
Key String 变量的名称
Value String 变量的值

VersionMatch

带有匹配规则的函数版本

被如下接口引用:CreateAlias, GetAlias, ListAliases, 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 匹配规则要求:
字符串精确匹配

VersionWeight

带有权重的函数版本

被如下接口引用:CreateAlias, GetAlias, ListAliases, UpdateAlias。

名称 类型 必选 描述
Version String 函数版本名称
Weight Float 该版本的权重

VpcConfig

私有网络参数配置

被如下接口引用:CreateFunction, GetFunction, UpdateFunctionConfiguration。

名称 类型 必选 描述
VpcId String 私有网络 的 Id
SubnetId String 子网的 Id
目录