最佳实践

数据结构

最近更新时间:2021-09-17 08:12:05

我的收藏

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
InvokeType String 调用类型
Qualifier String 函数版本
Status String 事件状态,RUNNING 表示运行中, FINISHED 表示调用成功, ABORTED 表示调用终止, FAILED 表示调用失败
StartTime String 调用开始时间,格式: "%Y-%m-%d %H:%M:%S.%f"
EndTime String 调用结束时间,格式: "%Y-%m-%d %H:%M:%S.%f"

AsyncTriggerConfig

函数的异步重试配置详情

被如下接口引用:GetFunctionEventInvokeConfig, UpdateFunctionEventInvokeConfig。

名称 类型 必选 描述
RetryConfig Array of RetryConfig 用户错误的异步重试重试配置
MsgTTL Integer 消息保留时间

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)
CosObjectName String 对象存储对象路径
ZipFile String 包含函数代码文件及其依赖项的 zip 格式文件,zip包大小上限为 50MB,使用该接口时要求将 zip 文件的内容转成 base64 编码
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用户名,一般无需指定
ImageConfig ImageConfig 镜像部署时配置TCR镜像信息

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
StatusReasons Array of StatusReason 函数状态失败原因
TotalProvisionedConcurrencyMem Integer 函数所有版本预置并发内存总和
注意:此字段可能返回 null,表示取不到有效值。
ReservedConcurrencyMem Integer 函数并发保留内存
注意:此字段可能返回 null,表示取不到有效值。
AsyncRunEnable String 函数异步属性,取值 TRUE 或者 FALSE
TraceEnable String 异步函数是否开启调用追踪,取值 TRUE 或者 FALSE

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

ImageConfig

TCR镜像信息描述

被如下接口引用:CreateFunction, PublishLayerVersion, UpdateFunctionCode。

名称 类型 必选 描述
ImageType String 镜像仓库类型,个人版或者企业版:personal/enterprise
ImageUri String {domain}/{namespace}/{imageName}:{tag}@{digest}
RegistryId String 用于企业版TCR获取镜像拉取临时凭证,ImageType为"enterprise"时必填
注意:此字段可能返回 null,表示取不到有效值。
EntryPoint String 应用的ENTRYPOINT
注意:此字段可能返回 null,表示取不到有效值。
Command String entrypoint执行命令
注意:此字段可能返回 null,表示取不到有效值。
Args String 命令参数
注意:此字段可能返回 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 版本号

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

NamespaceLimit

命名空间限制

被如下接口引用:GetAccount。

名称 类型 描述
FunctionsCount Integer 函数总数
Trigger TriggerCount Trigger信息
Namespace String Namespace名称
ConcurrentExecutions Integer 并发量
TimeoutLimit Integer Timeout限制
TestModelLimit Integer 测试事件限制
注意:此字段可能返回 null,表示取不到有效值。
InitTimeoutLimit Integer 初始化超时限制
RetryNumLimit Integer 异步重试次数限制
MinMsgTTL Integer 异步重试消息保留时间下限
MaxMsgTTL Integer 异步重试消息保留时间上限

NamespaceUsage

名称空间已使用信息

被如下接口引用:GetAccount。

名称 类型 描述
Functions Array of String 函数数组
Namespace String 命名空间名称
FunctionsCount Integer 命名空间函数个数

PublicNetConfigIn

公网访问配置

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

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

PublicNetConfigOut

公网访问配置

被如下接口引用:GetFunction。

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

Result

运行函数的返回

被如下接口引用:Invoke, InvokeFunction。

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

RetryConfig

异步重试配置

被如下接口引用:GetFunctionEventInvokeConfig, UpdateFunctionEventInvokeConfig。

名称 类型 必选 描述
RetryNum Integer 重试次数

RoutingConfig

别名的版本路由配置

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

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

SearchKey

包含搜索关键字和对应的内容

被如下接口引用:ListNamespaces。

名称 类型 必选 描述
Key String 搜索关键字
Value String 搜索内容

StatusReason

状态原因描述

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

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

Tag

函数标签

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

名称 类型 必选 描述
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 触发器状态
ResourceId String 触发器最小资源ID
BindStatus String 触发器和云函数绑定状态
TriggerAttribute String 触发器类型,双向表示两侧控制台均可操作,单向表示SCF控制台单向创建
Qualifier String 触发器绑定的别名或版本

TriggerCount

TriggerCount描述不同类型触发器的数量

被如下接口引用:GetAccount。

名称 类型 描述
Cos Integer Cos触发器数量
Timer Integer Timer触发器数量
Cmq Integer Cmq触发器数量
Total Integer 触发器总数
Ckafka Integer Ckafka触发器数量
Apigw Integer Apigw触发器数量
Cls Integer Cls触发器数量
Clb Integer Clb触发器数量
Mps Integer Mps触发器数量
Cm Integer Cm触发器数量
Vod Integer Vod触发器数量

TriggerInfo

触发器信息

被如下接口引用:ListTriggers。

名称 类型 描述
Enable Integer 使能开关
Qualifier String 函数版本或别名
TriggerName String 触发器名称
Type String 触发器类型
TriggerDesc String 触发器详细配置
AvailableStatus String 触发器是否可用
CustomArgument String 客户自定义参数
注意:此字段可能返回 null,表示取不到有效值。
AddTime Timestamp 触发器创建时间
ModTime Timestamp 触发器最后修改时间
ResourceId String 触发器最小资源ID
BindStatus String 触发器和云函数绑定状态
TriggerAttribute String 触发器类型,双向表示两侧控制台均可操作,单向表示SCF控制台单向创建

UsageInfo

已使用的信息

被如下接口引用:GetAccount。

名称 类型 描述
NamespacesCount Integer 命名空间个数
Namespace Array of NamespaceUsage 命名空间详情
TotalConcurrencyMem Integer 当前地域用户并发内存配额上限
TotalAllocatedConcurrencyMem Integer 当前地域用户已配置并发内存额度
UserConcurrencyMemLimit Integer 用户实际配置的账号并发配额

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 匹配规则要求:
字符串精确匹配

VersionProvisionedConcurrencyInfo

函数版本的预置并发信息,包括设置预置并发数、已完成预置的并发数和预置任务状态。

被如下接口引用:GetProvisionedConcurrencyConfig。

名称 类型 描述
AllocatedProvisionedConcurrencyNum Integer 设置的预置并发数。
AvailableProvisionedConcurrencyNum Integer 当前已完成预置的并发数。
Status String 预置任务状态,Done表示已完成,InProgress表示进行中,Failed表示部分或全部失败。
StatusReason String 对预置任务状态Status的说明。
Qualifier String 函数版本号

VersionWeight

带有权重的函数版本

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

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

VpcConfig

私有网络参数配置

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

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