{ "name": "scf", "display_name": "云函数", "description": "介绍如何使用API对云函数计算进行操作，包括层管理、函数、触发器等。", "domain": "compute", "api_version": "2018-04-16", "endpoint": "scf.tencentcloudapi.com", "actions": [ { "name": "CopyFunction", "description": "复制一个函数，您可以选择将复制出的新函数放置在特定的Region和Namespace。 注：本接口**不会**复制函数的以下对象或属性： 1. 函数的触发器 2. 除了$LATEST以外的其它版本 3. 函数配置的日志投递到的CLS目标。 如有需要，您可以在复制后手动配置新函数。", "status": "online", "parameters": [ { "name": "FunctionName", "type": "string", "required": true, "description": "要复制的函数的名称", "example": "myfunc" }, { "name": "NewFunctionName", "type": "string", "required": true, "description": "新函数的名称", "example": "newfunc" }, { "name": "Namespace", "type": "string", "required": false, "description": "要复制的函数所在的命名空间，默认为default", "example": "default" }, { "name": "TargetNamespace", "type": "string", "required": false, "description": "将函数复制到的命名空间，默认为default", "example": "otherns" }, { "name": "Description", "type": "string", "required": false, "description": "新函数的描述", "example": "a new function" }, { "name": "TargetRegion", "type": "string", "required": false, "description": "要将函数复制到的地域，不填则默认为当前地域", "example": "ap-shanghai" }, { "name": "Override", "type": "boolean", "required": false, "description": "如果目标Namespace下已有同名函数，是否覆盖，默认为否 （注意：如果选择覆盖，会导致同名函数被删除，请慎重操作） TRUE：覆盖同名函数 FALSE：不覆盖同名函数", "example": "FALSE" }, { "name": "CopyConfiguration", "type": "boolean", "required": false, "description": "是否复制函数的属性，包括环境变量、内存、超时、函数描述、标签、VPC等，默认为是。 TRUE：复制函数配置 FALSE：不复制函数配置", "example": "TRUE" } ], "required": [ "FunctionName", "NewFunctionName" ] }, { "name": "CreateAlias", "description": "为某个函数版本创建一个别名，您可以使用别名来标记特定的函数版本，如DEV/RELEASE版本，也可以随时修改别名指向的版本。 一个别名必须指向一个主版本，此外还可以同时指向一个附加版本。调用函数时指定特定的别名，则请求会被发送到别名指向的版本上，您可以配置请求发送到主版本和附加版本的比例。", "status": "online", "parameters": [ { "name": "Name", "type": "string", "required": true, "description": "别名的名称，在函数级别中唯一，只能包含字母、数字、'_'和‘-’，且必须以字母开头，长度限制为1-64", "example": "TestAlias" }, { "name": "FunctionName", "type": "string", "required": true, "description": "函数名称", "example": "TestFunction" }, { "name": "FunctionVersion", "type": "string", "required": true, "description": "别名指向的主版本", "example": "$LATEST" }, { "name": "Namespace", "type": "string", "required": false, "description": "函数所在的命名空间", "example": "default" }, { "name": "RoutingConfig", "type": "object", "required": false, "description": "别名的路由信息，需要为别名指定附加版本时，必须提供此参数； 附加版本指的是：除主版本 FunctionVersion 外，为此别名再指定一个函数可正常使用的版本； 这里附加版本中的 Version 值 不能是别名指向的主版本； 要注意的是：如果想要某个版本的流量全部指向这个别名，不需配置此参数； 目前一个别名最多只能指定一个附加版本", "example": "{ \t\"AdditionalVersionWeights\":[ \t{ \t\t\"Version\":\"2\", \t\t\"Weight\":0.01 \t} \t] }", "children": [ { "name": "AdditionalVersionWeights", "type": "array", "required": false, "description": "随机权重路由附加版本", "example": "[ \t{ \"Version\":\"1\", \"Weight\":0.01 } ]", "item_type": "object", "children": [ { "name": "Version", "type": "string", "required": true, "description": "函数版本名称", "example": "1" }, { "name": "Weight", "type": "float", "required": true, "description": "该版本的权重", "example": "0.8" } ] }, { "name": "AddtionVersionMatchs", "type": "array", "required": false, "description": "规则路由附加版本", "example": "[ \t{ \t \"Version\":\"1\", \t \"Key\":\"invoke.headers.User\", \t \"Method\":\"exact\", \t \"Expression\":\"testuser\" \t} ]", "item_type": "object", "children": [ { "name": "Version", "type": "string", "required": true, "description": "函数版本名称", "example": "1" }, { "name": "Key", "type": "string", "required": true, "description": "匹配规则的key，调用时通过传key来匹配规则路由到指定版本 header方式： key填写\"invoke.headers.User\"，并在 invoke 调用函数时传参 RoutingKey：{\"User\":\"value\"}规则匹配调用", "example": "invoke.headers.User" }, { "name": "Method", "type": "string", "required": true, "description": "匹配方式。取值范围： range：范围匹配 exact：字符串精确匹配", "example": "exact" }, { "name": "Expression", "type": "string", "required": true, "description": "range 匹配规则要求： 需要为开区间或闭区间描述 (a,b) [a,b]，其中 a、b 均为整数 exact 匹配规则要求： 字符串精确匹配", "example": "testuser" } ] } ] }, { "name": "Description", "type": "string", "required": false, "description": "别名的描述信息", "example": "a alias1" } ], "required": [ "Name", "FunctionName", "FunctionVersion" ] }, { "name": "CreateCustomDomain", "description": "创建自定义域名", "status": "online", "parameters": [ { "name": "Domain", "type": "string", "required": true, "description": "域名，不支持泛域名", "example": "www.xxx.com" }, { "name": "Protocol", "type": "string", "required": true, "description": "协议，取值范围：HTTP, HTTPS, HTTP\u0026HTTPS", "example": "HTTP" }, { "name": "EndpointsConfig", "type": "array", "required": true, "description": "路由配置", "example": "无", "item_type": "object", "children": [ { "name": "Namespace", "type": "string", "required": true, "description": "函数命名空间", "example": "default" }, { "name": "FunctionName", "type": "string", "required": true, "description": "函数名", "example": "function-demo" }, { "name": "Qualifier", "type": "string", "required": true, "description": "函数别名或版本", "example": "$DEFAULT" }, { "name": "PathMatch", "type": "string", "required": true, "description": "路径,取值规范：/，/*，/xxx，/xxx/a，/xxx/*\"", "example": "/*" }, { "name": "PathRewrite", "type": "array", "required": false, "description": "路径重写策略 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "object", "children": [ { "name": "Path", "type": "string", "required": true, "description": "需要重路由的路径，取值规范：/，/*，/xxx，/xxx/a，/xxx/*", "example": "/aa/" }, { "name": "Type", "type": "string", "required": true, "description": "匹配规，取值范围： WildcardRules 通配符匹配， ExactRules 精确匹配", "example": "ExactRules" }, { "name": "Rewrite", "type": "string", "required": true, "description": "替换值：比如/, /$", "example": "/$1" } ] } ] }, { "name": "CertConfig", "type": "object", "required": false, "description": "证书配置信息，有使用HTTPS协议时候必须传", "example": "无", "children": [ { "name": "CertificateId", "type": "string", "required": false, "description": "ssl证书ID", "example": "Hz4OcOUn" } ] }, { "name": "WafConfig", "type": "object", "required": false, "description": "web 应用防火墙配置", "example": "无", "children": [ { "name": "WafOpen", "type": "string", "required": false, "description": "web应用防火墙是否打开， 取值范围:OPEN, CLOSE", "example": "OPEN" }, { "name": "WafInstanceId", "type": "string", "required": false, "description": "web应用防火墙实例ID", "example": "waf_2kzh3vlq0u" } ] }, { "name": "Tags", "type": "array", "required": false, "description": "标签", "example": "无", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": true, "description": "标签的key", "example": "运营部门" }, { "name": "Value", "type": "string", "required": true, "description": "标签的value", "example": "xxx产品中心" } ] } ], "required": [ "Domain", "Protocol", "EndpointsConfig" ] }, { "name": "CreateFunction", "description": "该接口根据传入参数创建新的函数。", "status": "online", "parameters": [ { "name": "FunctionName", "type": "string", "required": true, "description": "创建的函数名称，函数名称支持26个英文字母大小写、数字、连接符和下划线，第一个字符只能以字母开头，最后一个字符不能为连接符或者下划线，名称长度2-60", "example": "helloworld" }, { "name": "Code", "type": "object", "required": true, "description": "函数代码. 注意：不能同时指定Cos、ZipFile或 DemoId。", "example": "无", "children": [ { "name": "CosBucketName", "type": "string", "required": false, "description": "对象存储桶名称（填写存储桶名称自定义部分，不包含-appid）", "example": "BucketName" }, { "name": "CosObjectName", "type": "string", "required": false, "description": "对象存储中代码包文件路径，以/开头", "example": "ObjectName" }, { "name": "ZipFile", "type": "string", "required": false, "description": "包含函数代码文件及其依赖项的 zip 格式文件，zip包大小上限为 50MB，使用该接口时要求将 zip 文件的内容转成 base64 编码", "example": "base64编码" }, { "name": "CosBucketRegion", "type": "string", "required": false, "description": "对象存储的地域，地域为北京时需要传入ap-beijing,北京一区时需要传递ap-beijing-1，其他的地域不需要传递。", "example": "ap-chongqing" }, { "name": "DemoId", "type": "string", "required": false, "description": "如果是通过Demo创建的话，需要传入DemoId", "example": "Demo的Id" }, { "name": "TempCosObjectName", "type": "string", "required": false, "description": "如果是从TempCos创建的话，需要传入TempCosObjectName", "example": "TempCosObjectName" }, { "name": "GitUrl", "type": "string", "required": false, "description": "Git地址。该功能已下线。", "example": "Git地址" }, { "name": "GitUserName", "type": "string", "required": false, "description": "Git用户名。该功能已下线。", "example": "Git用户名" }, { "name": "GitPassword", "type": "string", "required": false, "description": "Git密码。该功能已下线。", "example": "Git密码" }, { "name": "GitPasswordSecret", "type": "string", "required": false, "description": "加密后的Git密码，一般无需指定。该功能已下线。", "example": "加密后的Git密码" }, { "name": "GitBranch", "type": "string", "required": false, "description": "Git分支。该功能已下线。", "example": "Git分支" }, { "name": "GitDirectory", "type": "string", "required": false, "description": "代码在Git仓库中的路径。该功能已下线。", "example": "代码在Git仓库中的路径" }, { "name": "GitCommitId", "type": "string", "required": false, "description": "指定要拉取的版本。该功能已下线。", "example": "Git拉取的版本" }, { "name": "GitUserNameSecret", "type": "string", "required": false, "description": "加密后的Git用户名，一般无需指定。该功能已下线。", "example": "加密后的Git用户名" }, { "name": "ImageConfig", "type": "object", "required": false, "description": "镜像部署时配置TCR镜像信息", "example": "TCR镜像配置", "children": [ { "name": "ImageType", "type": "string", "required": true, "description": "镜像仓库类型，个人版或者企业版：personal/enterprise", "example": "enterprise" }, { "name": "ImageUri", "type": "string", "required": true, "description": "{domain}/{namespace}/{imageName}:{tag}@{digest}", "example": "tcr.tencentcloudcr.com/namespace/test:latest" }, { "name": "RegistryId", "type": "string", "required": false, "description": "用于企业版TCR获取镜像拉取临时凭证，ImageType为\"enterprise\"时必填 注意：此字段可能返回 null，表示取不到有效值。", "example": "tcr-xxx" }, { "name": "EntryPoint", "type": "string", "required": false, "description": "该参数即将下线，不推荐用户使用 注意：此字段可能返回 null，表示取不到有效值。", "example": "\"entrypoint.sh\"" }, { "name": "Command", "type": "string", "required": false, "description": "容器的启动命令。该参数为可选参数，如果不填写，则默认使用 Dockerfile 中的 Entrypoint。传入规范，填写可运行的指令，例如 python 注意：此字段可能返回 null，表示取不到有效值。", "example": "python" }, { "name": "Args", "type": "string", "required": false, "description": "容器的启动参数。该参数为可选参数，如果不填写，则默认使用 Dockerfile 中的 CMD。传入规范，以“空格”作为参数的分割标识，例如 -u app.py 注意：此字段可能返回 null，表示取不到有效值。", "example": " -u app.py" }, { "name": "ContainerImageAccelerate", "type": "boolean", "required": false, "description": "镜像加速开关，默认False 注意：此字段可能返回 null，表示取不到有效值。", "example": "false" }, { "name": "ImagePort", "type": "integer", "required": false, "description": "镜像函数端口设置，可指定镜像类型 Web Server镜像：9000 Job 镜像：-1 注意：此字段可能返回 null，表示取不到有效值。 默认值：9000 示例值：9000 注意：此字段可能返回 null，表示取不到有效值。", "example": "9000" } ] } ] }, { "name": "Handler", "type": "string", "required": false, "description": "函数处理方法名称，名称格式支持 \"文件名称.方法名称\" 形式（java 名称格式 包名.类名::方法名），文件名称和函数名称之间以\".\"隔开，文件名称和函数名称要求以字母开始和结尾，中间允许插入字母、数字、下划线和连接符，文件名称和函数名字的长度要求是 2-60 个字符", "example": "index.main_handler" }, { "name": "Description", "type": "string", "required": false, "description": "函数描述,最大支持 1000 个英文字母、数字、空格、逗号、换行符和英文句号，支持中文", "example": "hello world!" }, { "name": "MemorySize", "type": "integer", "required": false, "description": "函数运行时内存大小，默认为 128M，可选范围 64、128MB-3072MB，并且以 128MB 为阶梯", "example": "128" }, { "name": "Timeout", "type": "integer", "required": false, "description": "函数最长执行时间，单位为秒，可选值范围 1-900 秒，默认为 3 秒", "example": "3" }, { "name": "Environment", "type": "object", "required": false, "description": "函数的环境变量", "example": "无", "children": [ { "name": "Variables", "type": "array", "required": false, "description": "环境变量数组", "example": "无", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": false, "description": "变量的名称，不可为空字符", "example": "testKey" }, { "name": "Value", "type": "string", "required": false, "description": "变量的值，不可为空字符", "example": "testValue" } ] } ] }, { "name": "Runtime", "type": "string", "required": false, "description": "函数运行环境，默认Python2.7 目前支持的运行环境： - Python2.7 - Python3.6 - Python3.7 - Python3.9 - Python3.10 - Nodejs6.10 - Nodejs8.9 - Nodejs10.15 - Nodejs12.16 - Nodejs14.18 - Nodejs16.13 - Nodejs18.15 - Php5.6 - Php7(7.2版本) - Php7.4 - Php8.0 - Go1 - Java8 - CustomRuntime", "example": "Python3.6" }, { "name": "VpcConfig", "type": "object", "required": false, "description": "函数的私有网络配置", "example": "无", "children": [ { "name": "VpcId", "type": "string", "required": false, "description": "私有网络 的 Id", "example": "vpc-xxxxxxxx" }, { "name": "SubnetId", "type": "string", "required": false, "description": "子网的 Id", "example": "subnet-xxxxxxx" } ] }, { "name": "Namespace", "type": "string", "required": false, "description": "函数所属命名空间", "example": "default" }, { "name": "Role", "type": "string", "required": false, "description": "函数绑定的角色", "example": "SCF_ExecuteRole" }, { "name": "InstallDependency", "type": "string", "required": false, "description": "[在线依赖安装](https://cloud.tencent.com/document/product/583/37920)，TRUE 表示安装，默认值为 FALSE。仅支持 Node.js 函数。", "example": "FALSE" }, { "name": "ClsLogsetId", "type": "string", "required": false, "description": "函数日志投递到的CLS LogsetID", "example": "abcd-xcxcf-xcxvv" }, { "name": "ClsTopicId", "type": "string", "required": false, "description": "函数日志投递到的CLS TopicID", "example": "cvfd-dfsf-xcvcx" }, { "name": "Type", "type": "string", "required": false, "description": "函数类型，默认值为Event，创建触发器函数请填写Event，创建HTTP函数级服务请填写HTTP", "example": "Event" }, { "name": "CodeSource", "type": "string", "required": false, "description": "CodeSource 代码来源，支持ZipFile, Cos, Demo 其中之一", "example": "ZipFile" }, { "name": "Layers", "type": "array", "required": false, "description": "函数要关联的Layer版本列表，Layer会按照在列表中顺序依次覆盖。", "example": "无", "item_type": "object", "children": [ { "name": "LayerName", "type": "string", "required": true, "description": "绑定的层名称。解绑层需传递空字符串。", "example": "layername" }, { "name": "LayerVersion", "type": "integer", "required": true, "description": "绑定或解绑层的版本号。解绑函数版本关联的最后一个层版本时，LayerVersion 填 0。", "example": "1" } ] }, { "name": "DeadLetterConfig", "type": "object", "required": false, "description": "死信队列参数", "example": "无", "children": [ { "name": "Type", "type": "string", "required": true, "description": "死信队列模式", "example": "CMQ-QUEUE" }, { "name": "Name", "type": "string", "required": true, "description": "死信队列名称", "example": "cmq-test-queue" }, { "name": "FilterType", "type": "string", "required": false, "description": "死信队列主题模式的标签形式", "example": "暂无使用" } ] }, { "name": "PublicNetConfig", "type": "object", "required": false, "description": "公网访问配置", "example": "无", "children": [ { "name": "PublicNetStatus", "type": "string", "required": true, "description": "是否开启公网访问能力取值['DISABLE','ENABLE']", "example": "DISABLE" }, { "name": "EipConfig", "type": "object", "required": false, "description": "Eip配置", "example": "{\"EipStatus\":\"DISABLE\"}", "children": [ { "name": "EipStatus", "type": "string", "required": true, "description": "Eip开启状态，取值['ENABLE','DISABLE']", "example": "DISABLE" } ] } ] }, { "name": "CfsConfig", "type": "object", "required": false, "description": "文件系统配置参数，用于云函数挂载文件系统", "example": "无", "children": [ { "name": "CfsInsList", "type": "array", "required": true, "description": "文件系统信息列表", "item_type": "object", "children": [ { "name": "UserId", "type": "string", "required": true, "description": "用户id", "example": "10000" }, { "name": "UserGroupId", "type": "string", "required": true, "description": "用户组id", "example": "10000" }, { "name": "CfsId", "type": "string", "required": true, "description": "文件系统实例id", "example": "cfs-xxxxxxxx" }, { "name": "MountInsId", "type": "string", "required": true, "description": "文件系统挂载点id", "example": "cfs-xxxxxxxx" }, { "name": "LocalMountDir", "type": "string", "required": true, "description": "本地挂载点", "example": "/mnt/" }, { "name": "RemoteMountDir", "type": "string", "required": true, "description": "远程挂载点", "example": "/remotedir" }, { "name": "IpAddress", "type": "string", "required": false, "description": "文件系统ip，配置 cfs 时无需填写。 注意：此字段可能返回 null，表示取不到有效值。 注意：此字段可能返回 null，表示取不到有效值。", "example": "10.0.0.3" }, { "name": "MountVpcId", "type": "string", "required": false, "description": "文件系统所在的私有网络id，配置 cfs 时无需填写。 注意：此字段可能返回 null，表示取不到有效值。 注意：此字段可能返回 null，表示取不到有效值。", "example": "vpc-xxxxxxxx" }, { "name": "MountSubnetId", "type": "string", "required": false, "description": "文件系统所在私有网络的子网id，配置 cfs 时无需填写。 注意：此字段可能返回 null，表示取不到有效值。 注意：此字段可能返回 null，表示取不到有效值。", "example": "subnet-xxxxxxxx" } ] } ] }, { "name": "InitTimeout", "type": "integer", "required": false, "description": "函数初始化超时时间，默认 65s，镜像部署函数默认 90s。", "example": "3" }, { "name": "Tags", "type": "array", "required": false, "description": "函数 Tag 参数，以键值对数组形式传入", "example": "无", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": true, "description": "标签的key", "example": "运营部门" }, { "name": "Value", "type": "string", "required": true, "description": "标签的value", "example": "xxx产品中心" } ] }, { "name": "AsyncRunEnable", "type": "string", "required": false, "description": "是否开启异步属性，TRUE 为开启，FALSE为关闭", "example": "FALSE" }, { "name": "TraceEnable", "type": "string", "required": false, "description": "是否开启事件追踪，TRUE 为开启，FALSE为关闭", "example": "FALSE" }, { "name": "AutoDeployClsTopicIndex", "type": "string", "required": false, "description": "是否自动创建cls索引，TRUE 为开启，FALSE为关闭", "example": "FALSE" }, { "name": "AutoCreateClsTopic", "type": "string", "required": false, "description": "是否自动创建cls主题，TRUE 为开启，FALSE为关闭", "example": "FALSE" }, { "name": "ProtocolType", "type": "string", "required": false, "description": "HTTP函数支持的访问协议。当前支持WebSockets协议，值为WS", "example": "WS" }, { "name": "ProtocolParams", "type": "object", "required": false, "description": "HTTP函数配置ProtocolType访问协议，当前协议可配置的参数", "example": "无", "children": [ { "name": "WSParams", "type": "object", "required": false, "description": "WebSockets协议支持的参数 注意：此字段可能返回 null，表示取不到有效值。", "example": "{ IdleTimeOut: 15 }", "children": [ { "name": "IdleTimeOut", "type": "integer", "required": false, "description": "空闲超时时间, 单位秒，默认15s。可配置范围1~1800s。 注意：此字段可能返回 null，表示取不到有效值。", "example": "15" } ] } ] }, { "name": "InstanceConcurrencyConfig", "type": "object", "required": false, "description": "单实例多并发配置。只支持Web函数。", "example": "无", "children": [ { "name": "DynamicEnabled", "type": "string", "required": false, "description": "是否开启智能动态并发。'FALSE'时是静态并发。''时取消多并发配置。 注意：此字段可能返回 null，表示取不到有效值。", "example": "'FALSE'" }, { "name": "MaxConcurrency", "type": "integer", "required": false, "description": "单实例并发数最大值。取值范围 [1,100] 注意：此字段可能返回 null，表示取不到有效值。", "example": "1" }, { "name": "InstanceIsolationEnabled", "type": "string", "required": false, "description": "安全隔离开关", "example": "'FALSE'" }, { "name": "Type", "type": "string", "required": false, "description": "基于会话：Session-Based ， 或者基于请求：Request-Based，二选一", "example": "Session-Based" }, { "name": "MixNodeConfig", "type": "array", "required": false, "description": "动态并发参数", "example": "无", "item_type": "object", "children": [ { "name": "NodeSpec", "type": "string", "required": false, "description": "GPU机型名", "example": "gpu-dsdfsd" }, { "name": "Num", "type": "integer", "required": false, "description": "并发个数", "example": "1" } ] }, { "name": "SessionConfig", "type": "object", "required": false, "description": "会话配置参数", "example": "无", "children": [ { "name": "SessionSource", "type": "string", "required": false, "description": "session 来源，三选一：'HEADER', 'COOKIE', 'QUERY_STRING'", "example": "HEADER" }, { "name": "SessionName", "type": "string", "required": false, "description": "session 名称，以字母开头，非首字母可包含数字、字母、下划线、中划线，长度5-40个字符", "example": "x-test-" }, { "name": "MaximumConcurrencySessionPerInstance", "type": "integer", "required": false, "description": "最大并发会话数", "example": "1" }, { "name": "MaximumTTLInSeconds", "type": "integer", "required": false, "description": "生命周期", "example": "1800" }, { "name": "MaximumIdleTimeInSeconds", "type": "integer", "required": false, "description": "空闲时长", "example": "1800" }, { "name": "SessionPath", "type": "string", "required": false, "description": "session 对应的路径信息", "example": "/mcp" }, { "name": "IdleTimeoutStrategy", "type": "string", "required": false, "description": "自动销毁 FATAL、自动暂停PAUSE， 只有启动安全隔离的时候才会有", "example": "FATAL" } ] } ] }, { "name": "DnsCache", "type": "string", "required": false, "description": "是否开启Dns缓存能力。只支持EVENT函数。默认为FALSE，TRUE 为开启，FALSE为关闭", "example": "FALSE" }, { "name": "IntranetConfig", "type": "object", "required": false, "description": "内网访问配置", "example": "无", "children": [ { "name": "IpFixed", "type": "string", "required": true, "description": "是否开启固定内网IP ENABLE 为开启 DISABLE 为不开启", "example": "ENABLE" } ] } ], "required": [ "FunctionName", "Code" ] }, { "name": "CreateNamespace", "description": "该接口根据传入的参数创建命名空间。", "status": "online", "parameters": [ { "name": "Namespace", "type": "string", "required": true, "description": "命名空间名称", "example": "ns1" }, { "name": "Description", "type": "string", "required": false, "description": "命名空间描述", "example": "a namespace" }, { "name": "ResourceEnv", "type": "object", "required": false, "description": "资源池配置", "example": "无", "children": [ { "name": "TKE", "type": "object", "required": false, "description": "基于TKE集群的资源池 注意：此字段可能返回 null，表示取不到有效值。", "example": "x", "children": [ { "name": "ClusterID", "type": "string", "required": true, "description": "集群ID", "example": "cls-xxxx" }, { "name": "SubnetID", "type": "string", "required": true, "description": "子网ID", "example": "subnet-xx" }, { "name": "Namespace", "type": "string", "required": true, "description": "命名空间", "example": "kube-system" }, { "name": "DataPath", "type": "string", "required": false, "description": "数据存储地址 注意：此字段可能返回 null，表示取不到有效值。", "example": "/var/lib/scf" }, { "name": "NodeSelector", "type": "array", "required": false, "description": "node选择器 注意：此字段可能返回 null，表示取不到有效值。", "example": "Key0=a,Value0=x", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": true, "description": "label的名称", "example": "labelkey" }, { "name": "Value", "type": "string", "required": true, "description": "label的值", "example": "labelvalue" } ] }, { "name": "Tolerations", "type": "array", "required": false, "description": "污点容忍 注意：此字段可能返回 null，表示取不到有效值。", "example": "Key: \"key1\" Operator: \"Exists\"", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": false, "description": "匹配的污点名", "example": "key1" }, { "name": "Operator", "type": "string", "required": false, "description": "匹配方式，默认值为: Equal 注意：此字段可能返回 null，表示取不到有效值。", "example": "Equal" }, { "name": "Effect", "type": "string", "required": false, "description": "执行策略 注意：此字段可能返回 null，表示取不到有效值。", "example": "NoExecute" }, { "name": "Value", "type": "string", "required": false, "description": "匹配的污点值，当Operator为Equal时必填 注意：此字段可能返回 null，表示取不到有效值。", "example": "value1" }, { "name": "TolerationSeconds", "type": "integer", "required": false, "description": "当污点不被容忍时，Pod还能在节点上运行多久 注意：此字段可能返回 null，表示取不到有效值。", "example": "3600" } ] }, { "name": "Port", "type": "integer", "required": false, "description": "scf组件将占用的节点端口起始号 注意：此字段可能返回 null，表示取不到有效值。", "example": "38002" }, { "name": "PodTemplatePatch", "type": "string", "required": false, "description": "yaml格式的pod patch内容，例如 metadata: labels: key: value 注意：此字段可能返回 null，表示取不到有效值。", "example": "metadata: labels: key: value" } ] }, { "name": "OFFLINE", "type": "boolean", "required": false, "description": "近离线计算类型的命名空间", "example": "true" } ] } ], "required": [ "Namespace" ] }, { "name": "CreateTrigger", "description": "该接口根据参数输入设置新的触发方式。", "status": "online", "parameters": [ { "name": "FunctionName", "type": "string", "required": true, "description": "新建触发器绑定的函数名称", "example": "FunctionName" }, { "name": "TriggerName", "type": "string", "required": true, "description": "新建触发器名称。如果是定时触发器，名称支持英文字母、数字、连接符和下划线，最长100个字符；如果是cos触发器，需要是对应cos存储桶适用于XML API的访问域名(例如:5401-5ff414-12345.cos.ap-shanghai.myqcloud.com);如果是其他触发器，见具体触发器绑定参数的说明", "example": "TriggerName" }, { "name": "Type", "type": "string", "required": true, "description": "触发器类型，目前支持 cos 、cls 、 timer、 ckafka、http类型。创建函数 URL 请使用 http 类型，参考[创建函数 URL ](https://cloud.tencent.com/document/product/583/100227#33bbbda4-9131-48a6-ac37-ac62ffe01424)。创建 cls 触发器请参考[CLS 创建投递 SCF 任务](https://cloud.tencent.com/document/product/614/61096)。", "example": "timer" }, { "name": "TriggerDesc", "type": "string", "required": false, "description": "触发器对应的参数，可见具体[触发器描述说明](https://cloud.tencent.com/document/product/583/39901)", "example": "*/2****" }, { "name": "Namespace", "type": "string", "required": false, "description": "函数的命名空间", "example": "default" }, { "name": "Qualifier", "type": "string", "required": false, "description": "触发器所生效的版本或别名，建议填写 [$DEFAULT](https://cloud.tencent.com/document/product/583/36149#.E9.BB.98.E8.AE.A4.E5.88.AB.E5.90.8D)方便后续进行版本的灰度发布，默认为 $LATEST。", "example": "$DEFAULT" }, { "name": "Enable", "type": "string", "required": false, "description": "触发器的初始是能状态 OPEN表示开启 CLOSE表示关闭", "example": "1" }, { "name": "CustomArgument", "type": "string", "required": false, "description": "用户自定义参数，仅支持timer触发器", "example": "CustomArgument" }, { "name": "Description", "type": "string", "required": false, "description": "触发器描述", "example": "A trigger" } ], "required": [ "FunctionName", "TriggerName", "Type" ] }, { "name": "DeleteAlias", "description": "删除一个函数版本的别名", "status": "online", "parameters": [ { "name": "FunctionName", "type": "string", "required": true, "description": "函数名称", "example": "\u003cFunctionName\u003e" }, { "name": "Name", "type": "string", "required": true, "description": "别名的名称", "example": "\u003cAliasName\u003e" }, { "name": "Namespace", "type": "string", "required": false, "description": "函数所在的命名空间", "example": "\u003cNamespace\u003e" } ], "required": [ "FunctionName", "Name" ] }, { "name": "DeleteCustomDomain", "description": "删除自定义域名", "status": "online", "parameters": [ { "name": "Domain", "type": "string", "required": false, "description": "域名", "example": "www.demo.com" } ], "required": [] }, { "name": "DeleteFunction", "description": "该接口根据传入参数删除函数。", "status": "online", "parameters": [ { "name": "FunctionName", "type": "string", "required": true, "description": "要删除的函数名称", "example": "\u003cFunctionName\u003e" }, { "name": "Namespace", "type": "string", "required": false, "description": "函数所属命名空间", "example": "default" }, { "name": "Qualifier", "type": "string", "required": false, "description": "填写需要删除的版本号，不填默认删除函数下全部版本。", "example": "$LATEST" } ], "required": [ "FunctionName" ] }, { "name": "DeleteFunctionVersion", "description": "该接口根据传入参数删除函数的指定版本。", "status": "online", "parameters": [ { "name": "FunctionName", "type": "string", "required": true, "description": "要删除的函数名称", "example": "test_function" }, { "name": "Qualifier", "type": "string", "required": true, "description": "填写需要删除的版本号", "example": "1" }, { "name": "Namespace", "type": "string", "required": false, "description": "函数所属命名空间", "example": "default" }, { "name": "ForceDelete", "type": "string", "required": false, "description": "强制删除标记，传true会直接删除容器，并强制关闭还在执行中的函数", "example": "true" } ], "required": [ "FunctionName", "Qualifier" ] }, { "name": "DeleteLayerVersion", "description": "删除指定层的指定版本，被删除的版本无法再关联到函数上，但不会影响正在引用这个层的函数。", "status": "online", "parameters": [ { "name": "LayerName", "type": "string", "required": true, "description": "层名称", "example": "layer-1" }, { "name": "LayerVersion", "type": "integer", "required": true, "description": "版本号", "example": "v1" } ], "required": [ "LayerName", "LayerVersion" ] }, { "name": "DeleteNamespace", "description": "该接口根据传入的参数删除命名空间。", "status": "online", "parameters": [ { "name": "Namespace", "type": "string", "required": true, "description": "命名空间名称", "example": "namespace1" } ], "required": [ "Namespace" ] }, { "name": "DeleteProvisionedConcurrencyConfig", "description": "删除函数版本的预置并发配置。", "status": "online", "parameters": [ { "name": "FunctionName", "type": "string", "required": true, "description": "需要删除预置并发的函数的名称", "example": "functionName1" }, { "name": "Qualifier", "type": "string", "required": true, "description": "函数的版本号", "example": "1" }, { "name": "Namespace", "type": "string", "required": false, "description": "函数所属命名空间，默认为default", "example": "namespace1" } ], "required": [ "FunctionName", "Qualifier" ] }, { "name": "DeleteReservedConcurrencyConfig", "description": "删除函数的最大独占配额配置。", "status": "online", "parameters": [ { "name": "FunctionName", "type": "string", "required": true, "description": "需要删除最大独占配额的函数的名称", "example": "functionName1" }, { "name": "Namespace", "type": "string", "required": false, "description": "函数所属命名空间，默认为default", "example": "default" } ], "required": [ "FunctionName" ] }, { "name": "DeleteTrigger", "description": "该接口根据参数传入删除已有的触发方式。", "status": "online", "parameters": [ { "name": "FunctionName", "type": "string", "required": true, "description": "函数的名称", "example": "ledDummyAPITest" }, { "name": "TriggerName", "type": "string", "required": true, "description": "要删除的触发器名称", "example": "trigger_name" }, { "name": "Type", "type": "string", "required": true, "description": "要删除的触发器类型，目前只支持 timer、ckafka 、apigw 、cls 、cos 、cmq 、http 类型", "example": "timer" }, { "name": "Namespace", "type": "string", "required": false, "description": "函数所属命名空间", "example": "default" }, { "name": "TriggerDesc", "type": "string", "required": false, "description": "如果删除的触发器类型为 COS 触发器，该字段为必填值，存放 JSON 格式的数据 {\"event\":\"cos:ObjectCreated:*\"}，数据内容和 SetTrigger 接口中该字段的格式相同；如果删除的触发器类型为定时触发器或 CMQ 触发器，可以不指定该字段", "example": "{\"event\":\"cos:ObjectCreated:*\"}" }, { "name": "Qualifier", "type": "string", "required": false, "description": "要删除的触发器实际所指向的版本或别名，默认值为 $LATEST", "example": "$LATEST" } ], "required": [ "FunctionName", "TriggerName", "Type" ] }, { "name": "GetAccount", "description": "获取账户信息", "status": "online", "parameters": [], "required": [] }, { "name": "GetAlias", "description": "获取别名的详细信息，包括名称、描述、版本、路由信息等。", "status": "online", "parameters": [ { "name": "FunctionName", "type": "string", "required": true, "description": "函数名称", "example": "functionName1" }, { "name": "Name", "type": "string", "required": true, "description": "别名的名称", "example": "alias1" }, { "name": "Namespace", "type": "string", "required": false, "description": "函数所在的命名空间", "example": "ns1" } ], "required": [ "FunctionName", "Name" ] }, { "name": "GetAsyncEventStatus", "description": "获取函数异步执行事件状态，事件状态保留 3 * 24 小时（从事件完成开始计时）。", "status": "online", "parameters": [ { "name": "InvokeRequestId", "type": "string", "required": true, "description": "异步执行请求 id", "example": "ea7bb7c7-c312-4255-b7dc-b2bf0cfda10e" } ], "required": [ "InvokeRequestId" ] }, { "name": "GetCustomDomain", "description": "查看云函数自定义域名详情", "status": "online", "parameters": [ { "name": "Domain", "type": "string", "required": false, "description": "域名", "example": "www.demo.com" } ], "required": [] }, { "name": "GetFunction", "description": "该接口获取某个函数的详细信息，包括名称、代码、处理方法、关联触发器和超时时间等字段。", "status": "online", "parameters": [ { "name": "FunctionName", "type": "string", "required": false, "description": "需要获取详情的函数名称，ResourceId和FunctionName只能传一个", "example": "\u003cFunctionName\u003e" }, { "name": "Qualifier", "type": "string", "required": false, "description": "函数的版本号 默认值: $LATEST", "example": "$LATEST" }, { "name": "Namespace", "type": "string", "required": false, "description": "函数所属命名空间 默认值: default", "example": "default" }, { "name": "ShowCode", "type": "string", "required": false, "description": "是否显示代码, TRUE表示显示代码，FALSE表示不显示代码,大于1M的入口文件不会显示", "example": "TRUE" } ], "required": [] }, { "name": "GetFunctionAddress", "description": "该接口用于获取函数代码包的下载地址。", "status": "online", "parameters": [ { "name": "FunctionName", "type": "string", "required": true, "description": "函数的名称", "example": "\u003cFunctionName\u003e" }, { "name": "Qualifier", "type": "string", "required": false, "description": "函数的版本", "example": "$LATEST" }, { "name": "Namespace", "type": "string", "required": false, "description": "函数的命名空间", "example": "default" } ], "required": [ "FunctionName" ] }, { "name": "GetFunctionEventInvokeConfig", "description": "获取函数异步重试配置，包括重试次数和消息保留时间", "status": "online", "parameters": [ { "name": "FunctionName", "type": "string", "required": true, "description": "函数名称", "example": "Unzip-1609933864" }, { "name": "Namespace", "type": "string", "required": false, "description": "函数所属命名空间，默认为default", "example": "default" }, { "name": "Qualifier", "type": "string", "required": false, "description": "函数版本，默认为$LATEST", "example": "$LATEST" } ], "required": [ "FunctionName" ] }, { "name": "GetFunctionLogs", "description": "该接口根据指定的日志查询条件返回函数运行日志。该接口已下线，查询函数请求运行的返回信息，请使用 [GetRequestStatus](https://cloud.tencent.com/document/product/583/65348)。查询函数运行日志，请参考[日志检索教程](https://cloud.tencent.com/document/product/583/52637)。", "status": "online", "parameters": [ { "name": "FunctionName", "type": "string", "required": false, "description": "函数的名称。 - 为保证[获取函数运行日志](https://cloud.tencent.com/document/product/583/18583)接口`GetFunctionLogs`兼容性，输入参数`FunctionName`仍为非必填项，但建议填写该参数，否则可能导致日志获取失败。 - 函数关联日志服务后，建议使用[日志服务](https://cloud.tencent.com/document/product/614/16875)相关接口以获得最佳日志检索体验。", "example": "helloworld-demo" }, { "name": "Offset", "type": "integer", "required": false, "description": "数据的偏移量，Offset+Limit不能大于10000", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "返回数据的长度，Offset+Limit不能大于10000", "example": "20" }, { "name": "Order", "type": "string", "required": false, "description": "以升序还是降序的方式对日志进行排序，可选值 desc和 asc", "example": "desc" }, { "name": "OrderBy", "type": "string", "required": false, "description": "根据某个字段排序日志,支持以下字段：function_name, duration, mem_usage, start_time", "example": "function_name" }, { "name": "Filter", "type": "object", "required": false, "description": "日志过滤条件。可用来区分正确和错误日志，filter.RetCode=not0 表示只返回错误日志，filter.RetCode=is0 表示只返回正确日志，不传，则返回所有日志", "example": "not0", "children": [ { "name": "RetCode", "type": "string", "required": false, "description": "filter.RetCode的取值有： not0 表示只返回错误日志， is0 表示只返回正确日志， TimeLimitExceeded 返回函数调用发生超时的日志， ResourceLimitExceeded 返回函数调用发生资源超限的日志， UserCodeException 返回函数调用发生用户代码错误的日志， 无输入则返回所有日志。", "example": "is0" } ] }, { "name": "Namespace", "type": "string", "required": false, "description": "函数的命名空间", "example": "default" }, { "name": "Qualifier", "type": "string", "required": false, "description": "函数的版本", "example": "$LATEST" }, { "name": "FunctionRequestId", "type": "string", "required": false, "description": "执行该函数对应的requestId", "example": "d1922633-55cf-443a-a6cc-0788ce93df06" }, { "name": "StartTime", "type": "string", "required": false, "description": "查询的具体日期，例如：2017-05-16 20:00:00，只能与endtime相差一天之内", "example": "2017-05-16 20:00:00" }, { "name": "EndTime", "type": "string", "required": false, "description": "查询的具体日期，例如：2017-05-16 20:59:59，只能与startTime相差一天之内", "example": "2017-05-16 20:59:59" }, { "name": "SearchContext", "type": "object", "required": false, "description": "该字段已下线", "example": "无", "children": [ { "name": "Offset", "type": "string", "required": true, "description": "偏移量", "example": "0" }, { "name": "Limit", "type": "integer", "required": true, "description": "日志条数", "example": "100" }, { "name": "Keyword", "type": "string", "required": false, "description": "日志关键词", "example": "Some Keyword" }, { "name": "Type", "type": "string", "required": false, "description": "日志类型，支持Application和Platform，默认为Application", "example": "Application" } ] } ], "required": [] }, { "name": "GetLayerVersion", "description": "获取层版本详细信息，包括用于下载层中文件的链接。", "status": "online", "parameters": [ { "name": "LayerName", "type": "string", "required": true, "description": "层名称", "example": "layer-name1" }, { "name": "LayerVersion", "type": "integer", "required": true, "description": "版本号", "example": "lv" } ], "required": [ "LayerName", "LayerVersion" ] }, { "name": "GetProvisionedConcurrencyConfig", "description": "获取函数或函数某一版本的预置并发详情。", "status": "online", "parameters": [ { "name": "FunctionName", "type": "string", "required": true, "description": "需要获取预置并发详情的函数名称。", "example": "funcName1" }, { "name": "Namespace", "type": "string", "required": false, "description": "函数所在的命名空间，默认为default。", "example": "default" }, { "name": "Qualifier", "type": "string", "required": false, "description": "函数版本号，不传则返回函数所有版本的预置并发信息。", "example": "1" } ], "required": [ "FunctionName" ] }, { "name": "GetRequestStatus", "description": "该接口根据指定的查询条件返回函数单个请求运行状态。", "status": "online", "parameters": [ { "name": "FunctionName", "type": "string", "required": true, "description": "函数名称", "example": "hello" }, { "name": "FunctionRequestId", "type": "string", "required": true, "description": "需要查询状态的请求 id", "example": "a63607c3-581f-4be9-8c4b-631c75909f07" }, { "name": "Namespace", "type": "string", "required": false, "description": "函数的所在的命名空间", "example": "default" }, { "name": "StartTime", "type": "string", "required": false, "description": "查询的开始时间，例如：2017-05-16 20:00:00，不填默认为当前时间 - 15min", "example": "2017-05-16 20:00:00" }, { "name": "EndTime", "type": "string", "required": false, "description": "查询的结束时间，例如：2017-05-16 20:59:59。StartTime 为空时，EndTime 默认为当前时间；StartTime 有值时，需要同时传 EndTime。EndTime 需要晚于 StartTime。", "example": "2017-05-16 20:59:59" } ], "required": [ "FunctionName", "FunctionRequestId" ] }, { "name": "GetReservedConcurrencyConfig", "description": "获取函数的最大独占配额详情。", "status": "online", "parameters": [ { "name": "FunctionName", "type": "string", "required": true, "description": "需要获取最大独占配额详情的函数名称。", "example": "functionName1" }, { "name": "Namespace", "type": "string", "required": false, "description": "函数所在的命名空间，默认为default。", "example": "default" } ], "required": [ "FunctionName" ] }, { "name": "Invoke", "description": "该接口用于运行函数。", "status": "online", "parameters": [ { "name": "FunctionName", "type": "string", "required": true, "description": "函数名称", "example": "helloworld" }, { "name": "InvocationType", "type": "string", "required": false, "description": "同步调用请使用[同步 Invoke 调用接口](https://cloud.tencent.com/document/product/583/58400) 或填写同步调用参数 RequestResponse ，建议使用同步调用接口以获取最佳性能；异步调用填写 Event；默认为同步。接口超时时间为 300s，更长超时时间请使用异步调用。", "example": "RequestResponse" }, { "name": "Qualifier", "type": "string", "required": false, "description": "触发函数的版本号或别名，默认值为 $LATEST", "example": "$LATEST" }, { "name": "ClientContext", "type": "string", "required": false, "description": "运行函数时的参数，以json格式传入，同步调用最大支持 6MB，异步调用最大支持 128 KB。该字段信息对应函数 [event 入参](https://cloud.tencent.com/document/product/583/9210#.E5.87.BD.E6.95.B0.E5.85.A5.E5.8F.82.3Ca-id.3D.22input.22.3E.3C.2Fa.3E)。", "example": "{\\\"key\\\":\\\"value\\\"}" }, { "name": "LogType", "type": "string", "required": false, "description": "异步调用该字段返回为空。", "example": "Tail" }, { "name": "Namespace", "type": "string", "required": false, "description": "命名空间", "example": "default" }, { "name": "RoutingKey", "type": "string", "required": false, "description": "函数灰度流量控制调用，以json格式传入，例如{\"k\":\"v\"}，注意kv都需要是字符串类型，最大支持的参数长度是1024字节", "example": "{\\\"key\\\":\\\"value\\\"}" } ], "required": [ "FunctionName" ] }, { "name": "InvokeFunction", "description": "SCF同步调用函数接口。", "status": "online", "parameters": [ { "name": "FunctionName", "type": "string", "required": true, "description": "函数名称", "example": "helloworld" }, { "name": "Qualifier", "type": "string", "required": false, "description": "触发函数的版本号或别名，默认值为$DEFAULT", "example": "$LATEST" }, { "name": "Event", "type": "string", "required": false, "description": "运行函数时的参数，以json格式传入，最大支持的参数长度是 6MB。该字段信息对应函数 [event 入参](https://cloud.tencent.com/document/product/583/9210#.E5.87.BD.E6.95.B0.E5.85.A5.E5.8F.82.3Ca-id.3D.22input.22.3E.3C.2Fa.3E)。", "example": "{\\\"key\\\":\\\"value\\\"}" }, { "name": "LogType", "type": "string", "required": false, "description": "返回值会包含4KB的日志，可选值为None和Tail，默认值为None。当该值为Tail时，返回参数中的Log字段会包含对应的函数执行日志", "example": "Tail" }, { "name": "Namespace", "type": "string", "required": false, "description": "命名空间，不填默认为 default", "example": "default" }, { "name": "RoutingKey", "type": "string", "required": false, "description": "函数灰度流量控制调用，以json格式传入，例如{\"k\":\"v\"}，注意kv都需要是字符串类型，最大支持的参数长度是1024字节", "example": "{\\\"key\\\":\\\"value\\\"}" } ], "required": [ "FunctionName" ] }, { "name": "ListAliases", "description": "返回一个函数下的全部别名，可以根据特定函数版本过滤。", "status": "online", "parameters": [ { "name": "FunctionName", "type": "string", "required": true, "description": "函数名称", "example": "functionName1" }, { "name": "Namespace", "type": "string", "required": false, "description": "函数所在的命名空间", "example": "default" }, { "name": "FunctionVersion", "type": "string", "required": false, "description": "如果提供此参数，则只返回与该函数版本有关联的别名", "example": "1" }, { "name": "Offset", "type": "string", "required": false, "description": "数据偏移量，默认值为 0", "example": "0" }, { "name": "Limit", "type": "string", "required": false, "description": "返回数据长度，默认值为 20", "example": "10" } ], "required": [ "FunctionName" ] }, { "name": "ListAsyncEvents", "description": "拉取函数异步事件列表", "status": "online", "parameters": [ { "name": "FunctionName", "type": "string", "required": true, "description": "函数名称", "example": "helloworld" }, { "name": "Namespace", "type": "string", "required": false, "description": "命名空间", "example": "default" }, { "name": "Qualifier", "type": "string", "required": false, "description": "过滤条件，函数版本", "example": "$LATEST" }, { "name": "InvokeType", "type": "array", "required": false, "description": "过滤条件，调用类型列表", "example": "[COS]", "item_type": "string" }, { "name": "Status", "type": "array", "required": false, "description": "过滤条件，事件状态列表", "example": "RUNNING", "item_type": "string" }, { "name": "StartTimeInterval", "type": "object", "required": false, "description": "过滤条件，开始执行时间左闭右开区间", "example": "无", "children": [ { "name": "Start", "type": "string", "required": true, "description": "起始时间（包括在内），格式\"%Y-%m-%d %H:%M:%S\"", "example": "2024-12-14 00:00:00" }, { "name": "End", "type": "string", "required": true, "description": "结束时间（不包括在内），格式\"%Y-%m-%d %H:%M:%S\"", "example": "2024-12-14 01:00:00" } ] }, { "name": "EndTimeInterval", "type": "object", "required": false, "description": "过滤条件，结束执行时间左闭右开区间", "example": "无", "children": [ { "name": "Start", "type": "string", "required": true, "description": "起始时间（包括在内），格式\"%Y-%m-%d %H:%M:%S\"", "example": "2024-12-14 00:00:00" }, { "name": "End", "type": "string", "required": true, "description": "结束时间（不包括在内），格式\"%Y-%m-%d %H:%M:%S\"", "example": "2024-12-14 01:00:00" } ] }, { "name": "Order", "type": "string", "required": false, "description": "可选值 ASC 和 DESC，默认 DESC", "example": "DESC" }, { "name": "Orderby", "type": "string", "required": false, "description": "可选值 StartTime 和 EndTime，默认值 StartTime", "example": "StartTime" }, { "name": "Offset", "type": "integer", "required": false, "description": "数据偏移量，默认值为 0", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "返回数据长度，默认值为 20，最大值 100", "example": "20" }, { "name": "InvokeRequestId", "type": "string", "required": false, "description": "过滤条件，事件调用请求id", "example": "5f825fd3-a59d-4879-aa28-3ac967c128885f825fd3-a59d-4879-aa28-3ac9" } ], "required": [ "FunctionName" ] }, { "name": "ListCustomDomains", "description": "遍历域名列表信息", "status": "online", "parameters": [ { "name": "Offset", "type": "integer", "required": false, "description": "偏移量，默认0", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "容量，默认20", "example": "10" }, { "name": "OrderBy", "type": "string", "required": false, "description": "取值范围：AddTime，ModTime， 默认AddTime", "example": "AddTime" }, { "name": "Order", "type": "string", "required": false, "description": "取值范围：DESC, ASC 默认DESC", "example": "DESC" }, { "name": "Filters", "type": "array", "required": false, "description": "过滤条件", "example": "无", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "需要过滤的字段。过滤条件数量限制为10。 Name可选值：VpcId, SubnetId, ClsTopicId, ClsLogsetId, Role, CfsId, CfsMountInsId, Eip；Values 长度限制为1。 Name可选值：Status, Runtime, FunctionType, PublicNetStatus, AsyncRunEnable, TraceEnable；Values 长度限制为20。 当 Name = Runtime 时，CustomImage 表示过滤镜像类型函数。", "example": "Status" }, { "name": "Values", "type": "array", "required": true, "description": "字段的过滤值。", "example": "[\"Creating\", \"Updating\", \"Deleting\"]", "item_type": "string" } ] } ], "required": [] }, { "name": "ListFunctions", "description": "该接口根据传入的查询参数返回相关函数信息。", "status": "online", "parameters": [ { "name": "Order", "type": "string", "required": false, "description": "以升序还是降序的方式返回结果，可选值 ASC 和 DESC", "example": "ASC" }, { "name": "Orderby", "type": "string", "required": false, "description": "根据哪个字段进行返回结果排序,支持以下字段：AddTime, ModTime, FunctionName", "example": "ModTime" }, { "name": "Offset", "type": "integer", "required": false, "description": "数据偏移量，默认值为 0", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "返回数据长度，默认值为 20", "example": "2" }, { "name": "SearchKey", "type": "string", "required": false, "description": "支持FunctionName模糊匹配", "example": "hello-world" }, { "name": "Namespace", "type": "string", "required": false, "description": "命名空间", "example": "default" }, { "name": "Description", "type": "string", "required": false, "description": "函数描述，支持模糊搜索", "example": "function1" }, { "name": "Filters", "type": "array", "required": false, "description": "`过滤特定属性或者有特定标签的函数。` - 传值方式 key-value 进行传值 例如：\"Filters\": [{ \"Name\": \"Status\", \"Values\": [\"CreateFailed\",\"Creating\"]}, {\"Name\": \"Type\",\"Values\": [\"HTTP\"]}]上述条件的函数是，函数状态为创建失败或者创建中，且函数类型为 HTTP 函数 - `如果通过标签进行过滤：`Filter 中 Name 字段需要以 `tag-` 起始，`-` 后跟着标签名称，`Values` 指定对应的标签值 示例值：\"Filters\": [{\"Name\":\"tag-dmte...", "example": "[{\"Name\":\"Status\",\"Values\":[\"CreateFailed\",\"Creating\"]}]", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "需要过滤的字段。过滤条件数量限制为10。 Name可选值：VpcId, SubnetId, ClsTopicId, ClsLogsetId, Role, CfsId, CfsMountInsId, Eip；Values 长度限制为1。 Name可选值：Status, Runtime, FunctionType, PublicNetStatus, AsyncRunEnable, TraceEnable；Values 长度限制为20。 当 Name = Runtime 时，CustomImage 表示过滤镜像类型函数。", "example": "Status" }, { "name": "Values", "type": "array", "required": true, "description": "字段的过滤值。", "example": "[\"Creating\", \"Updating\", \"Deleting\"]", "item_type": "string" } ] } ], "required": [] }, { "name": "ListLayerVersions", "description": "返回指定层的全部版本的信息", "status": "online", "parameters": [ { "name": "LayerName", "type": "string", "required": true, "description": "层名称", "example": "layer-name1" }, { "name": "CompatibleRuntime", "type": "array", "required": false, "description": "适配的运行时", "example": "Nodejs16.13", "item_type": "string" } ], "required": [ "LayerName" ] }, { "name": "ListLayers", "description": "返回全部层的列表，其中包含了每个层最新版本的信息，可以通过适配运行时进行过滤。", "status": "online", "parameters": [ { "name": "CompatibleRuntime", "type": "string", "required": false, "description": "适配的运行时", "example": "Nodejs16.13" }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移位置", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "查询数目限制", "example": "10" }, { "name": "SearchKey", "type": "string", "required": false, "description": "查询key，模糊匹配名称", "example": "\u003cSearchKey\u003e" } ], "required": [] }, { "name": "ListNamespaces", "description": "列出命名空间列表", "status": "online", "parameters": [ { "name": "Limit", "type": "integer", "required": false, "description": "返回数据长度，默认值为 20", "example": "10" }, { "name": "Offset", "type": "integer", "required": false, "description": "数据的偏移量，默认值为 0", "example": "0" }, { "name": "Orderby", "type": "string", "required": false, "description": "根据哪个字段进行返回结果排序,支持以下字段：Name,Updatetime", "example": "Name" }, { "name": "Order", "type": "string", "required": false, "description": "以升序还是降序的方式返回结果，可选值 ASC 和 DESC", "example": "DESC" }, { "name": "SearchKey", "type": "array", "required": false, "description": "关键字匹配搜索，Key 可选值为 Namespace 和 Description，多个搜索条件之间是与的关系", "example": "{\"Key\":\"Namespace\":Value:\"ns1\"}", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": true, "description": "搜索关键字", "example": "SearchKey1" }, { "name": "Value", "type": "string", "required": true, "description": "搜索内容", "example": "SearchKeyValue" } ] } ], "required": [] }, { "name": "ListTriggers", "description": "获取函数触发器列表", "status": "online", "parameters": [ { "name": "FunctionName", "type": "string", "required": true, "description": "函数名称", "example": "function-demo" }, { "name": "Namespace", "type": "string", "required": false, "description": "命名空间，默认是default", "example": "default" }, { "name": "Offset", "type": "integer", "required": false, "description": "数据偏移量，默认值为 0", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "返回数据长度，默认值为 20", "example": "1" }, { "name": "OrderBy", "type": "string", "required": false, "description": "根据哪个字段进行返回结果排序,支持以下字段：add_time，mod_time，默认mod_time", "example": "add_time" }, { "name": "Order", "type": "string", "required": false, "description": "以升序还是降序的方式返回结果，可选值 ASC 和 DESC，默认DESC", "example": "ASC" }, { "name": "Filters", "type": "array", "required": false, "description": "* Qualifier: 函数版本，别名 * TriggerName: 函数触发器名称 * Description: 函数触发器描述", "example": "Qualifier: $LATEST", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "需要过滤的字段。过滤条件数量限制为10。 Name可选值：VpcId, SubnetId, ClsTopicId, ClsLogsetId, Role, CfsId, CfsMountInsId, Eip；Values 长度限制为1。 Name可选值：Status, Runtime, FunctionType, PublicNetStatus, AsyncRunEnable, TraceEnable；Values 长度限制为20。 当 Name = Runtime 时，CustomImage 表示过滤镜像类型函数。", "example": "Status" }, { "name": "Values", "type": "array", "required": true, "description": "字段的过滤值。", "example": "[\"Creating\", \"Updating\", \"Deleting\"]", "item_type": "string" } ] } ], "required": [ "FunctionName" ] }, { "name": "ListVersionByFunction", "description": "该接口根据传入的参数查询函数的版本。", "status": "online", "parameters": [ { "name": "FunctionName", "type": "string", "required": true, "description": "函数名", "example": "functionName1" }, { "name": "Namespace", "type": "string", "required": false, "description": "函数所在命名空间", "example": "default" }, { "name": "Offset", "type": "integer", "required": false, "description": "数据偏移量，默认值为 0", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "返回数据长度，默认值为 20", "example": "10" }, { "name": "Order", "type": "string", "required": false, "description": "以升序还是降序的方式返回结果，可选值 ASC 和 DESC", "example": "DESC" }, { "name": "OrderBy", "type": "string", "required": false, "description": "根据哪个字段进行返回结果排序,支持以下字段：AddTime, ModTime", "example": "ModTime" } ], "required": [ "FunctionName" ] }, { "name": "PublishLayerVersion", "description": "使用给定的zip文件或cos对象创建一个层的新版本，每次使用相同的层的名称调用本接口，都会生成一个新版本。", "status": "online", "parameters": [ { "name": "LayerName", "type": "string", "required": true, "description": "层名称，支持26个英文字母大小写、数字、连接符和下划线，第一个字符只能以字母开头，最后一个字符不能为连接符或者下划线，名称长度1-64", "example": "layer-name1" }, { "name": "CompatibleRuntimes", "type": "array", "required": true, "description": "层适用的运行时，可多选，可选的值对应函数的 Runtime 可选值。", "example": "Python2.7", "item_type": "string" }, { "name": "Content", "type": "object", "required": true, "description": "层的文件来源或文件内容", "example": "无", "children": [ { "name": "CosBucketName", "type": "string", "required": false, "description": "对象存储桶名称（填写存储桶名称自定义部分，不包含-appid）", "example": "BucketName" }, { "name": "CosObjectName", "type": "string", "required": false, "description": "对象存储中代码包文件路径，以/开头", "example": "ObjectName" }, { "name": "ZipFile", "type": "string", "required": false, "description": "包含函数代码文件及其依赖项的 zip 格式文件，zip包大小上限为 50MB，使用该接口时要求将 zip 文件的内容转成 base64 编码", "example": "base64编码" }, { "name": "CosBucketRegion", "type": "string", "required": false, "description": "对象存储的地域，地域为北京时需要传入ap-beijing,北京一区时需要传递ap-beijing-1，其他的地域不需要传递。", "example": "ap-chongqing" }, { "name": "DemoId", "type": "string", "required": false, "description": "如果是通过Demo创建的话，需要传入DemoId", "example": "Demo的Id" }, { "name": "TempCosObjectName", "type": "string", "required": false, "description": "如果是从TempCos创建的话，需要传入TempCosObjectName", "example": "TempCosObjectName" }, { "name": "GitUrl", "type": "string", "required": false, "description": "Git地址。该功能已下线。", "example": "Git地址" }, { "name": "GitUserName", "type": "string", "required": false, "description": "Git用户名。该功能已下线。", "example": "Git用户名" }, { "name": "GitPassword", "type": "string", "required": false, "description": "Git密码。该功能已下线。", "example": "Git密码" }, { "name": "GitPasswordSecret", "type": "string", "required": false, "description": "加密后的Git密码，一般无需指定。该功能已下线。", "example": "加密后的Git密码" }, { "name": "GitBranch", "type": "string", "required": false, "description": "Git分支。该功能已下线。", "example": "Git分支" }, { "name": "GitDirectory", "type": "string", "required": false, "description": "代码在Git仓库中的路径。该功能已下线。", "example": "代码在Git仓库中的路径" }, { "name": "GitCommitId", "type": "string", "required": false, "description": "指定要拉取的版本。该功能已下线。", "example": "Git拉取的版本" }, { "name": "GitUserNameSecret", "type": "string", "required": false, "description": "加密后的Git用户名，一般无需指定。该功能已下线。", "example": "加密后的Git用户名" }, { "name": "ImageConfig", "type": "object", "required": false, "description": "镜像部署时配置TCR镜像信息", "example": "TCR镜像配置", "children": [ { "name": "ImageType", "type": "string", "required": true, "description": "镜像仓库类型，个人版或者企业版：personal/enterprise", "example": "enterprise" }, { "name": "ImageUri", "type": "string", "required": true, "description": "{domain}/{namespace}/{imageName}:{tag}@{digest}", "example": "tcr.tencentcloudcr.com/namespace/test:latest" }, { "name": "RegistryId", "type": "string", "required": false, "description": "用于企业版TCR获取镜像拉取临时凭证，ImageType为\"enterprise\"时必填 注意：此字段可能返回 null，表示取不到有效值。", "example": "tcr-xxx" }, { "name": "EntryPoint", "type": "string", "required": false, "description": "该参数即将下线，不推荐用户使用 注意：此字段可能返回 null，表示取不到有效值。", "example": "\"entrypoint.sh\"" }, { "name": "Command", "type": "string", "required": false, "description": "容器的启动命令。该参数为可选参数，如果不填写，则默认使用 Dockerfile 中的 Entrypoint。传入规范，填写可运行的指令，例如 python 注意：此字段可能返回 null，表示取不到有效值。", "example": "python" }, { "name": "Args", "type": "string", "required": false, "description": "容器的启动参数。该参数为可选参数，如果不填写，则默认使用 Dockerfile 中的 CMD。传入规范，以“空格”作为参数的分割标识，例如 -u app.py 注意：此字段可能返回 null，表示取不到有效值。", "example": " -u app.py" }, { "name": "ContainerImageAccelerate", "type": "boolean", "required": false, "description": "镜像加速开关，默认False 注意：此字段可能返回 null，表示取不到有效值。", "example": "false" }, { "name": "ImagePort", "type": "integer", "required": false, "description": "镜像函数端口设置，可指定镜像类型 Web Server镜像：9000 Job 镜像：-1 注意：此字段可能返回 null，表示取不到有效值。 默认值：9000 示例值：9000 注意：此字段可能返回 null，表示取不到有效值。", "example": "9000" } ] } ] }, { "name": "Description", "type": "string", "required": false, "description": "层的版本的描述", "example": "a layer desc" }, { "name": "LicenseInfo", "type": "string", "required": false, "description": "层的软件许可证", "example": "\u003cLicenseInfo\u003e" }, { "name": "Tags", "type": "array", "required": false, "description": "层Tag 参数，以键值对数组形式传入", "example": "无", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": true, "description": "标签的key", "example": "运营部门" }, { "name": "Value", "type": "string", "required": true, "description": "标签的value", "example": "xxx产品中心" } ] } ], "required": [ "LayerName", "CompatibleRuntimes", "Content" ] }, { "name": "PublishVersion", "description": "该接口用于用户发布新版本函数。", "status": "online", "parameters": [ { "name": "FunctionName", "type": "string", "required": true, "description": "发布函数的名称", "example": "\u003cFunctionName\u003e" }, { "name": "Description", "type": "string", "required": false, "description": "函数的描述", "example": "\u003cDescription\u003e" }, { "name": "Namespace", "type": "string", "required": false, "description": "函数的命名空间", "example": "default" } ], "required": [ "FunctionName" ] }, { "name": "PutProvisionedConcurrencyConfig", "description": "设置函数某一非$LATEST版本的预置并发。", "status": "online", "parameters": [ { "name": "FunctionName", "type": "string", "required": true, "description": "需要设置预置并发的函数的名称", "example": "functionName1" }, { "name": "Qualifier", "type": "string", "required": true, "description": "函数的版本号，注：$LATEST版本不支持预置并发", "example": "1" }, { "name": "VersionProvisionedConcurrencyNum", "type": "integer", "required": true, "description": "预置并发数量，注：所有版本的预置并发数总和存在上限限制，当前的上限是：函数最大并发配额 - 100", "example": "10" }, { "name": "Namespace", "type": "string", "required": false, "description": "函数所属命名空间，默认为default", "example": "default" }, { "name": "TriggerActions", "type": "array", "required": false, "description": "定时预置任务", "example": "[{\"TriggerName\":\"timer-1\",\"ProvisionedType\":\"Default\",\"TriggerProvisionedConcurrencyNum\":1,\"TriggerCronConfig\":\"30 42 15 20 12 * 2024\"}]", "item_type": "object", "children": [ { "name": "TriggerName", "type": "string", "required": true, "description": "定时预置名称", "example": "timer-1" }, { "name": "TriggerProvisionedConcurrencyNum", "type": "integer", "required": true, "description": "定时预置并发数量", "example": "1" }, { "name": "TriggerCronConfig", "type": "string", "required": true, "description": "设置定时触发器的时间配置，cron表达式。Cron 表达式有七个必需字段，按空格分隔。", "example": "30 42 15 20 12 * 2024" }, { "name": "ProvisionedType", "type": "string", "required": false, "description": "预置类型 Default 注意：此字段可能返回 null，表示取不到有效值。", "example": "Default" } ] }, { "name": "ProvisionedType", "type": "string", "required": false, "description": "预置类型， 静态预置：Default 动态追踪并发利用率指标预置：ConcurrencyUtilizationTracking 预置类型二选一，设置静态预置时可以设置VersionProvisionedConcurrencyNum。 动态利用率预置可以设置TrackingTarget，MinCapacity，MaxCapacity，保持向后兼容性此时VersionProvisionedConcurrencyNum设置为0.", "example": "ConcurrencyUtilizationTracking" }, { "name": "TrackingTarget", "type": "float", "required": false, "description": "指标追踪的并发利用率。设置范围(0,1)", "example": "0" }, { "name": "MinCapacity", "type": "integer", "required": false, "description": "缩容时的最小值, 最小值为1", "example": "0" }, { "name": "MaxCapacity", "type": "integer", "required": false, "description": "扩容时的最大值", "example": "0" } ], "required": [ "FunctionName", "Qualifier", "VersionProvisionedConcurrencyNum" ] }, { "name": "PutReservedConcurrencyConfig", "description": "设置函数最大独占配额", "status": "online", "parameters": [ { "name": "FunctionName", "type": "string", "required": true, "description": "需要设置最大独占配额的函数的名称", "example": "functionName1" }, { "name": "ReservedConcurrencyMem", "type": "integer", "required": true, "description": "函数最大独占配额，注：函数的最大独占配额内存总和上限：用户总并发内存配额 - 12800", "example": "12800" }, { "name": "Namespace", "type": "string", "required": false, "description": "函数所属命名空间，默认为default", "example": "default" } ], "required": [ "FunctionName", "ReservedConcurrencyMem" ] }, { "name": "PutTotalConcurrencyConfig", "description": "修改账号并发限制配额", "status": "online", "parameters": [ { "name": "TotalConcurrencyMem", "type": "integer", "required": true, "description": "账号并发内存配额，注：账号并发内存配额下限：用户已用并发内存总额 + 12800", "example": "128000" }, { "name": "Namespace", "type": "string", "required": false, "description": "命名空间，默认为default", "example": "default" } ], "required": [ "TotalConcurrencyMem" ] }, { "name": "TerminateAsyncEvent", "description": "终止正在运行中的函数异步事件", "status": "online", "parameters": [ { "name": "FunctionName", "type": "string", "required": true, "description": "函数名称", "example": "helloworld" }, { "name": "InvokeRequestId", "type": "string", "required": true, "description": "终止的调用请求id", "example": "5f825fd3-a59d-4879-aa28-3ac967c128885f825fd3-a59d-4879-aa28-3ac9" }, { "name": "Namespace", "type": "string", "required": false, "description": "命名空间", "example": "default" }, { "name": "GraceShutdown", "type": "boolean", "required": false, "description": "true，向指定请求[发送 SIGTERM 终止信号](https://cloud.tencent.com/document/product/583/63969#.E5.8F.91.E9.80.81.E7.BB.88.E6.AD.A2.E4.BF.A1.E5.8F.B7]， ，默认值为 false。", "example": "false" } ], "required": [ "FunctionName", "InvokeRequestId" ] }, { "name": "UpdateAlias", "description": "更新别名的配置", "status": "online", "parameters": [ { "name": "FunctionName", "type": "string", "required": true, "description": "函数名称", "example": "TestFunction" }, { "name": "Name", "type": "string", "required": true, "description": "别名的名称", "example": "TestAlias" }, { "name": "FunctionVersion", "type": "string", "required": true, "description": "别名指向的主版本", "example": "$LATEST" }, { "name": "Namespace", "type": "string", "required": false, "description": "函数所在的命名空间", "example": "default" }, { "name": "RoutingConfig", "type": "object", "required": false, "description": "别名的路由信息，需要为别名指定附加版本时，必须提供此参数； 附加版本指的是：除主版本 FunctionVersion 外，为此别名再指定一个函数可正常使用的版本； 这里附加版本中的 Version 值 不能是别名指向的主版本； 要注意的是：如果想要某个版本的流量全部指向这个别名，不需配置此参数； 目前一个别名最多只能指定一个附加版本", "example": "无", "children": [ { "name": "AdditionalVersionWeights", "type": "array", "required": false, "description": "随机权重路由附加版本", "example": "[ \t{ \"Version\":\"1\", \"Weight\":0.01 } ]", "item_type": "object", "children": [ { "name": "Version", "type": "string", "required": true, "description": "函数版本名称", "example": "1" }, { "name": "Weight", "type": "float", "required": true, "description": "该版本的权重", "example": "0.8" } ] }, { "name": "AddtionVersionMatchs", "type": "array", "required": false, "description": "规则路由附加版本", "example": "[ \t{ \t \"Version\":\"1\", \t \"Key\":\"invoke.headers.User\", \t \"Method\":\"exact\", \t \"Expression\":\"testuser\" \t} ]", "item_type": "object", "children": [ { "name": "Version", "type": "string", "required": true, "description": "函数版本名称", "example": "1" }, { "name": "Key", "type": "string", "required": true, "description": "匹配规则的key，调用时通过传key来匹配规则路由到指定版本 header方式： key填写\"invoke.headers.User\"，并在 invoke 调用函数时传参 RoutingKey：{\"User\":\"value\"}规则匹配调用", "example": "invoke.headers.User" }, { "name": "Method", "type": "string", "required": true, "description": "匹配方式。取值范围： range：范围匹配 exact：字符串精确匹配", "example": "exact" }, { "name": "Expression", "type": "string", "required": true, "description": "range 匹配规则要求： 需要为开区间或闭区间描述 (a,b) [a,b]，其中 a、b 均为整数 exact 匹配规则要求： 字符串精确匹配", "example": "testuser" } ] } ] }, { "name": "Description", "type": "string", "required": false, "description": "别名的描述", "example": "a alias desc" } ], "required": [ "FunctionName", "Name", "FunctionVersion" ] }, { "name": "UpdateCustomDomain", "description": "更新自定义域名相关配置", "status": "online", "parameters": [ { "name": "Domain", "type": "string", "required": true, "description": "自定义域名", "example": "www.demo.com" }, { "name": "Protocol", "type": "string", "required": false, "description": "协议，取值范围：HTTP, HTTPS, HTTP\u0026HTTPS", "example": "HTTP" }, { "name": "CertConfig", "type": "object", "required": false, "description": "证书配置信息，HTTPS协议必穿", "example": "无", "children": [ { "name": "CertificateId", "type": "string", "required": false, "description": "ssl证书ID", "example": "Hz4OcOUn" } ] }, { "name": "WafConfig", "type": "object", "required": false, "description": "web 应用防火墙配置", "example": "无", "children": [ { "name": "WafOpen", "type": "string", "required": false, "description": "web应用防火墙是否打开， 取值范围:OPEN, CLOSE", "example": "OPEN" }, { "name": "WafInstanceId", "type": "string", "required": false, "description": "web应用防火墙实例ID", "example": "waf_2kzh3vlq0u" } ] }, { "name": "EndpointsConfig", "type": "array", "required": false, "description": "路由配置", "example": "无", "item_type": "object", "children": [ { "name": "Namespace", "type": "string", "required": true, "description": "函数命名空间", "example": "default" }, { "name": "FunctionName", "type": "string", "required": true, "description": "函数名", "example": "function-demo" }, { "name": "Qualifier", "type": "string", "required": true, "description": "函数别名或版本", "example": "$DEFAULT" }, { "name": "PathMatch", "type": "string", "required": true, "description": "路径,取值规范：/，/*，/xxx，/xxx/a，/xxx/*\"", "example": "/*" }, { "name": "PathRewrite", "type": "array", "required": false, "description": "路径重写策略 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "object", "children": [ { "name": "Path", "type": "string", "required": true, "description": "需要重路由的路径，取值规范：/，/*，/xxx，/xxx/a，/xxx/*", "example": "/aa/" }, { "name": "Type", "type": "string", "required": true, "description": "匹配规，取值范围： WildcardRules 通配符匹配， ExactRules 精确匹配", "example": "ExactRules" }, { "name": "Rewrite", "type": "string", "required": true, "description": "替换值：比如/, /$", "example": "/$1" } ] } ] } ], "required": [ "Domain" ] }, { "name": "UpdateFunctionCode", "description": "该接口根据传入参数更新函数代码。", "status": "online", "parameters": [ { "name": "FunctionName", "type": "string", "required": true, "description": "要修改的函数名称", "example": "functionName1" }, { "name": "Handler", "type": "string", "required": false, "description": "函数处理方法名称。名称格式支持“文件名称.函数名称”形式（java 名称格式 包名.类名::方法名），文件名称和函数名称之间以\".\"隔开，文件名称和函数名称要求以字母开始和结尾，中间允许插入字母、数字、下划线和连接符，文件名称和函数名字的长度要求 2-60 个字符", "example": "index.main" }, { "name": "CosBucketName", "type": "string", "required": false, "description": "对象存储桶名称", "example": "\u003cCosBucketName\u003e" }, { "name": "CosObjectName", "type": "string", "required": false, "description": "对象存储对象路径", "example": "\u003cCosObjectName\u003e" }, { "name": "ZipFile", "type": "string", "required": false, "description": "包含函数代码文件及其依赖项的 zip 格式文件，使用该接口时要求将 zip 文件的内容转成 base64 编码，最大支持20M", "example": "\u003cbase64\u003e" }, { "name": "Namespace", "type": "string", "required": false, "description": "函数所属命名空间", "example": "default" }, { "name": "CosBucketRegion", "type": "string", "required": false, "description": "对象存储的地域，注：北京分为ap-beijing和ap-beijing-1", "example": "ap-beijing" }, { "name": "InstallDependency", "type": "string", "required": false, "description": "是否自动安装依赖", "example": "FALSE" }, { "name": "EnvId", "type": "string", "required": false, "description": "函数所属环境", "example": "\u003c函数所属环境\u003e" }, { "name": "Publish", "type": "string", "required": false, "description": "在更新时是否同步发布新版本，默认为：FALSE，不发布", "example": "FALSE" }, { "name": "Code", "type": "object", "required": false, "description": "函数代码", "example": "无", "children": [ { "name": "CosBucketName", "type": "string", "required": false, "description": "对象存储桶名称（填写存储桶名称自定义部分，不包含-appid）", "example": "BucketName" }, { "name": "CosObjectName", "type": "string", "required": false, "description": "对象存储中代码包文件路径，以/开头", "example": "ObjectName" }, { "name": "ZipFile", "type": "string", "required": false, "description": "包含函数代码文件及其依赖项的 zip 格式文件，zip包大小上限为 50MB，使用该接口时要求将 zip 文件的内容转成 base64 编码", "example": "base64编码" }, { "name": "CosBucketRegion", "type": "string", "required": false, "description": "对象存储的地域，地域为北京时需要传入ap-beijing,北京一区时需要传递ap-beijing-1，其他的地域不需要传递。", "example": "ap-chongqing" }, { "name": "DemoId", "type": "string", "required": false, "description": "如果是通过Demo创建的话，需要传入DemoId", "example": "Demo的Id" }, { "name": "TempCosObjectName", "type": "string", "required": false, "description": "如果是从TempCos创建的话，需要传入TempCosObjectName", "example": "TempCosObjectName" }, { "name": "GitUrl", "type": "string", "required": false, "description": "Git地址。该功能已下线。", "example": "Git地址" }, { "name": "GitUserName", "type": "string", "required": false, "description": "Git用户名。该功能已下线。", "example": "Git用户名" }, { "name": "GitPassword", "type": "string", "required": false, "description": "Git密码。该功能已下线。", "example": "Git密码" }, { "name": "GitPasswordSecret", "type": "string", "required": false, "description": "加密后的Git密码，一般无需指定。该功能已下线。", "example": "加密后的Git密码" }, { "name": "GitBranch", "type": "string", "required": false, "description": "Git分支。该功能已下线。", "example": "Git分支" }, { "name": "GitDirectory", "type": "string", "required": false, "description": "代码在Git仓库中的路径。该功能已下线。", "example": "代码在Git仓库中的路径" }, { "name": "GitCommitId", "type": "string", "required": false, "description": "指定要拉取的版本。该功能已下线。", "example": "Git拉取的版本" }, { "name": "GitUserNameSecret", "type": "string", "required": false, "description": "加密后的Git用户名，一般无需指定。该功能已下线。", "example": "加密后的Git用户名" }, { "name": "ImageConfig", "type": "object", "required": false, "description": "镜像部署时配置TCR镜像信息", "example": "TCR镜像配置", "children": [ { "name": "ImageType", "type": "string", "required": true, "description": "镜像仓库类型，个人版或者企业版：personal/enterprise", "example": "enterprise" }, { "name": "ImageUri", "type": "string", "required": true, "description": "{domain}/{namespace}/{imageName}:{tag}@{digest}", "example": "tcr.tencentcloudcr.com/namespace/test:latest" }, { "name": "RegistryId", "type": "string", "required": false, "description": "用于企业版TCR获取镜像拉取临时凭证，ImageType为\"enterprise\"时必填 注意：此字段可能返回 null，表示取不到有效值。", "example": "tcr-xxx" }, { "name": "EntryPoint", "type": "string", "required": false, "description": "该参数即将下线，不推荐用户使用 注意：此字段可能返回 null，表示取不到有效值。", "example": "\"entrypoint.sh\"" }, { "name": "Command", "type": "string", "required": false, "description": "容器的启动命令。该参数为可选参数，如果不填写，则默认使用 Dockerfile 中的 Entrypoint。传入规范，填写可运行的指令，例如 python 注意：此字段可能返回 null，表示取不到有效值。", "example": "python" }, { "name": "Args", "type": "string", "required": false, "description": "容器的启动参数。该参数为可选参数，如果不填写，则默认使用 Dockerfile 中的 CMD。传入规范，以“空格”作为参数的分割标识，例如 -u app.py 注意：此字段可能返回 null，表示取不到有效值。", "example": " -u app.py" }, { "name": "ContainerImageAccelerate", "type": "boolean", "required": false, "description": "镜像加速开关，默认False 注意：此字段可能返回 null，表示取不到有效值。", "example": "false" }, { "name": "ImagePort", "type": "integer", "required": false, "description": "镜像函数端口设置，可指定镜像类型 Web Server镜像：9000 Job 镜像：-1 注意：此字段可能返回 null，表示取不到有效值。 默认值：9000 示例值：9000 注意：此字段可能返回 null，表示取不到有效值。", "example": "9000" } ] } ] }, { "name": "CodeSource", "type": "string", "required": false, "description": "代码来源方式，支持 ZipFile, Cos, Inline 之一", "example": "Cos" } ], "required": [ "FunctionName" ] }, { "name": "UpdateFunctionConfiguration", "description": "该接口根据传入参数更新函数配置。", "status": "online", "parameters": [ { "name": "FunctionName", "type": "string", "required": true, "description": "要修改的函数名称", "example": "\u003cFunctionName\u003e" }, { "name": "Description", "type": "string", "required": false, "description": "函数描述。最大支持 1000 个英文字母、数字、空格、逗号和英文句号，支持中文", "example": "\u003cDescription\u003e" }, { "name": "MemorySize", "type": "integer", "required": false, "description": "函数运行时内存大小，默认为 128 M，可选范64M、128 M-3072 M，以 128MB 为阶梯。", "example": "128" }, { "name": "Timeout", "type": "integer", "required": false, "description": "函数最长执行时间，单位为秒，可选值范 1-900 秒，默认为 3 秒", "example": "3" }, { "name": "Runtime", "type": "string", "required": false, "description": "函数运行环境，创建时指定，目前不支持修改。", "example": "Python3.6" }, { "name": "Environment", "type": "object", "required": false, "description": "函数的环境变量", "example": "无", "children": [ { "name": "Variables", "type": "array", "required": false, "description": "环境变量数组", "example": "无", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": false, "description": "变量的名称，不可为空字符", "example": "testKey" }, { "name": "Value", "type": "string", "required": false, "description": "变量的值，不可为空字符", "example": "testValue" } ] } ] }, { "name": "Namespace", "type": "string", "required": false, "description": "函数所属命名空间 默认值: default", "example": "default" }, { "name": "VpcConfig", "type": "object", "required": false, "description": "函数的私有网络配置", "example": "无", "children": [ { "name": "VpcId", "type": "string", "required": false, "description": "私有网络 的 Id", "example": "vpc-xxxxxxxx" }, { "name": "SubnetId", "type": "string", "required": false, "description": "子网的 Id", "example": "subnet-xxxxxxx" } ] }, { "name": "Role", "type": "string", "required": false, "description": "函数绑定的角色", "example": "SCF_ExecuteRole" }, { "name": "InstallDependency", "type": "string", "required": false, "description": "[在线依赖安装](https://cloud.tencent.com/document/product/583/37920)，TRUE 表示安装，默认值为 FALSE。仅支持 Node.js 函数。", "example": "FALSE" }, { "name": "ClsLogsetId", "type": "string", "required": false, "description": "日志投递到的cls日志集ID", "example": "fsdfs-sfdsdfsd-sdfsdf" }, { "name": "ClsTopicId", "type": "string", "required": false, "description": "日志投递到的cls Topic ID", "example": "fsdfs-sfdsdfsd-sdfsdf" }, { "name": "Publish", "type": "string", "required": false, "description": "在更新时是否同步发布新版本，默认为：FALSE，不发布新版本", "example": "FALSE" }, { "name": "L5Enable", "type": "string", "required": false, "description": "是否开启L5访问能力，TRUE 为开启，FALSE为关闭", "example": "FALSE" }, { "name": "Layers", "type": "array", "required": false, "description": "函数要关联的层版本列表，层的版本会按照在列表中顺序依次覆盖。", "example": "无", "item_type": "object", "children": [ { "name": "LayerName", "type": "string", "required": true, "description": "绑定的层名称。解绑层需传递空字符串。", "example": "layername" }, { "name": "LayerVersion", "type": "integer", "required": true, "description": "绑定或解绑层的版本号。解绑函数版本关联的最后一个层版本时，LayerVersion 填 0。", "example": "1" } ] }, { "name": "DeadLetterConfig", "type": "object", "required": false, "description": "函数关联的死信队列信息", "example": "无", "children": [ { "name": "Type", "type": "string", "required": true, "description": "死信队列模式", "example": "CMQ-QUEUE" }, { "name": "Name", "type": "string", "required": true, "description": "死信队列名称", "example": "cmq-test-queue" }, { "name": "FilterType", "type": "string", "required": false, "description": "死信队列主题模式的标签形式", "example": "暂无使用" } ] }, { "name": "PublicNetConfig", "type": "object", "required": false, "description": "公网访问配置", "example": "无", "children": [ { "name": "PublicNetStatus", "type": "string", "required": true, "description": "是否开启公网访问能力取值['DISABLE','ENABLE']", "example": "DISABLE" }, { "name": "EipConfig", "type": "object", "required": false, "description": "Eip配置", "example": "{\"EipStatus\":\"DISABLE\"}", "children": [ { "name": "EipStatus", "type": "string", "required": true, "description": "Eip开启状态，取值['ENABLE','DISABLE']", "example": "DISABLE" } ] } ] }, { "name": "CfsConfig", "type": "object", "required": false, "description": "文件系统配置入参，用于云函数绑定CFS文件系统", "example": "无", "children": [ { "name": "CfsInsList", "type": "array", "required": true, "description": "文件系统信息列表", "item_type": "object", "children": [ { "name": "UserId", "type": "string", "required": true, "description": "用户id", "example": "10000" }, { "name": "UserGroupId", "type": "string", "required": true, "description": "用户组id", "example": "10000" }, { "name": "CfsId", "type": "string", "required": true, "description": "文件系统实例id", "example": "cfs-xxxxxxxx" }, { "name": "MountInsId", "type": "string", "required": true, "description": "文件系统挂载点id", "example": "cfs-xxxxxxxx" }, { "name": "LocalMountDir", "type": "string", "required": true, "description": "本地挂载点", "example": "/mnt/" }, { "name": "RemoteMountDir", "type": "string", "required": true, "description": "远程挂载点", "example": "/remotedir" }, { "name": "IpAddress", "type": "string", "required": false, "description": "文件系统ip，配置 cfs 时无需填写。 注意：此字段可能返回 null，表示取不到有效值。 注意：此字段可能返回 null，表示取不到有效值。", "example": "10.0.0.3" }, { "name": "MountVpcId", "type": "string", "required": false, "description": "文件系统所在的私有网络id，配置 cfs 时无需填写。 注意：此字段可能返回 null，表示取不到有效值。 注意：此字段可能返回 null，表示取不到有效值。", "example": "vpc-xxxxxxxx" }, { "name": "MountSubnetId", "type": "string", "required": false, "description": "文件系统所在私有网络的子网id，配置 cfs 时无需填写。 注意：此字段可能返回 null，表示取不到有效值。 注意：此字段可能返回 null，表示取不到有效值。", "example": "subnet-xxxxxxxx" } ] } ] }, { "name": "InitTimeout", "type": "integer", "required": false, "description": "函数初始化执行超时时间", "example": "15" }, { "name": "ProtocolParams", "type": "object", "required": false, "description": "HTTP函数配置ProtocolType访问协议，当前协议可配置的参数", "example": "无", "children": [ { "name": "WSParams", "type": "object", "required": false, "description": "WebSockets协议支持的参数 注意：此字段可能返回 null，表示取不到有效值。", "example": "{ IdleTimeOut: 15 }", "children": [ { "name": "IdleTimeOut", "type": "integer", "required": false, "description": "空闲超时时间, 单位秒，默认15s。可配置范围1~1800s。 注意：此字段可能返回 null，表示取不到有效值。", "example": "15" } ] } ] }, { "name": "InstanceConcurrencyConfig", "type": "object", "required": false, "description": "单实例多并发配置。只支持Web函数。", "example": "无", "children": [ { "name": "DynamicEnabled", "type": "string", "required": false, "description": "是否开启智能动态并发。'FALSE'时是静态并发。''时取消多并发配置。 注意：此字段可能返回 null，表示取不到有效值。", "example": "'FALSE'" }, { "name": "MaxConcurrency", "type": "integer", "required": false, "description": "单实例并发数最大值。取值范围 [1,100] 注意：此字段可能返回 null，表示取不到有效值。", "example": "1" }, { "name": "InstanceIsolationEnabled", "type": "string", "required": false, "description": "安全隔离开关", "example": "'FALSE'" }, { "name": "Type", "type": "string", "required": false, "description": "基于会话：Session-Based ， 或者基于请求：Request-Based，二选一", "example": "Session-Based" }, { "name": "MixNodeConfig", "type": "array", "required": false, "description": "动态并发参数", "example": "无", "item_type": "object", "children": [ { "name": "NodeSpec", "type": "string", "required": false, "description": "GPU机型名", "example": "gpu-dsdfsd" }, { "name": "Num", "type": "integer", "required": false, "description": "并发个数", "example": "1" } ] }, { "name": "SessionConfig", "type": "object", "required": false, "description": "会话配置参数", "example": "无", "children": [ { "name": "SessionSource", "type": "string", "required": false, "description": "session 来源，三选一：'HEADER', 'COOKIE', 'QUERY_STRING'", "example": "HEADER" }, { "name": "SessionName", "type": "string", "required": false, "description": "session 名称，以字母开头，非首字母可包含数字、字母、下划线、中划线，长度5-40个字符", "example": "x-test-" }, { "name": "MaximumConcurrencySessionPerInstance", "type": "integer", "required": false, "description": "最大并发会话数", "example": "1" }, { "name": "MaximumTTLInSeconds", "type": "integer", "required": false, "description": "生命周期", "example": "1800" }, { "name": "MaximumIdleTimeInSeconds", "type": "integer", "required": false, "description": "空闲时长", "example": "1800" }, { "name": "SessionPath", "type": "string", "required": false, "description": "session 对应的路径信息", "example": "/mcp" }, { "name": "IdleTimeoutStrategy", "type": "string", "required": false, "description": "自动销毁 FATAL、自动暂停PAUSE， 只有启动安全隔离的时候才会有", "example": "FATAL" } ] } ] }, { "name": "DnsCache", "type": "string", "required": false, "description": "是否开启Dns缓存能力。只支持EVENT函数。默认为FALSE，TRUE 为开启，FALSE为关闭", "example": "FALSE" }, { "name": "IntranetConfig", "type": "object", "required": false, "description": "内网访问配置", "example": "无", "children": [ { "name": "IpFixed", "type": "string", "required": true, "description": "是否开启固定内网IP ENABLE 为开启 DISABLE 为不开启", "example": "ENABLE" } ] }, { "name": "IgnoreSysLog", "type": "boolean", "required": false, "description": "忽略系统日志上报", "example": "false" } ], "required": [ "FunctionName" ] }, { "name": "UpdateFunctionEventInvokeConfig", "description": "更新函数的异步重试配置，包括重试次数和消息保留时间", "status": "online", "parameters": [ { "name": "AsyncTriggerConfig", "type": "object", "required": true, "description": "异步重试配置信息", "example": "无", "children": [ { "name": "RetryConfig", "type": "array", "required": true, "description": "用户错误的异步重试重试配置", "example": "{\"MsgTTL\":21600,\"RetryConfig\":[{\"RetryNum\":2}]}", "item_type": "object", "children": [ { "name": "RetryNum", "type": "integer", "required": true, "description": "重试次数", "example": "2" } ] }, { "name": "MsgTTL", "type": "integer", "required": true, "description": "消息保留时间", "example": "2" } ] }, { "name": "FunctionName", "type": "string", "required": true, "description": "函数名称", "example": "FunctionName" }, { "name": "Namespace", "type": "string", "required": false, "description": "函数所属命名空间，默认为default", "example": "default" } ], "required": [ "AsyncTriggerConfig", "FunctionName" ] }, { "name": "UpdateNamespace", "description": "更新命名空间", "status": "online", "parameters": [ { "name": "Namespace", "type": "string", "required": true, "description": "命名空间名称", "example": "test01" }, { "name": "Description", "type": "string", "required": true, "description": "命名空间描述", "example": "fdsgfds" } ], "required": [ "Namespace", "Description" ] }, { "name": "UpdateTrigger", "description": "支持触发器配置更新。 默认接口请求频率限制：20次/秒 注意：目前只支持timer触发器和ckafka触发器更新！ timer触发器和ckafka触发器支持更新字段有：Enable、TriggerDesc、Description、CustomArgument。 timer触发器TriggerDesc支持5段式和7段式的更新。 ckafka触发器TriggerDesc支持Retry、MaxMsgNum、TimeOut参数更新，不传值表示原值不变，传值不能为空。 Enable 触发器开启或关闭，传参为OPEN为开启，CLO...", "status": "online", "parameters": [ { "name": "FunctionName", "type": "string", "required": true, "description": "函数名称", "example": "FuncName" }, { "name": "TriggerName", "type": "string", "required": true, "description": "触发器名称", "example": "TriggerName" }, { "name": "Type", "type": "string", "required": true, "description": "触发器类型，目前只支持timer、ckafka、http三种类型", "example": "timer" }, { "name": "Enable", "type": "string", "required": false, "description": "触发器开启或关闭，传参为OPEN为开启，CLOSE为关闭", "example": "OPEN" }, { "name": "Qualifier", "type": "string", "required": false, "description": "触发器创建时所指向的函数版本或别名，默认为 $LATEST", "example": "$DEFAULT" }, { "name": "Namespace", "type": "string", "required": false, "description": "函数的命名空间，默认值为default", "example": "default" }, { "name": "TriggerDesc", "type": "string", "required": false, "description": "TriggerDesc参数", "example": "*/1 * * * * * *" }, { "name": "Description", "type": "string", "required": false, "description": "触发器描述", "example": "some description" }, { "name": "CustomArgument", "type": "string", "required": false, "description": "用户附加信息", "example": "custom information" } ], "required": [ "FunctionName", "TriggerName", "Type" ] }, { "name": "UpdateTriggerStatus", "description": "更新触发器状态的值", "status": "online", "parameters": [ { "name": "Enable", "type": "string", "required": true, "description": "触发器的初始是能状态OPEN表示开启 CLOSE表示关闭", "example": "CLOSE" }, { "name": "FunctionName", "type": "string", "required": true, "description": "函数名称", "example": "function-demo" }, { "name": "TriggerName", "type": "string", "required": true, "description": "触发器名称", "example": "SCF-timer-1735218857" }, { "name": "Type", "type": "string", "required": true, "description": "触发器类型，触发器类型，目前只支持 timer、 cos 、 ckafka三种类型", "example": "timer" }, { "name": "Qualifier", "type": "string", "required": false, "description": "触发器在创建时所指向的触发别名或版本，默认值为$LATEST", "example": "$LATEST" }, { "name": "Namespace", "type": "string", "required": false, "description": "函数所在的命名空间，默认值为default", "example": "default" }, { "name": "TriggerDesc", "type": "string", "required": false, "description": "如果更新的触发器类型为 COS 触发器，该字段为必填值，存放 JSON 格式的数据 {\"event\":\"cos:ObjectCreated:*\"}，数据内容和 SetTrigger 接口中该字段的格式相同；如果更新的触发器类型为定时触发器或 CMQ 触发器，可以不指定该字段", "example": "\t 0 0 0 */1 * * *" } ], "required": [ "Enable", "FunctionName", "TriggerName", "Type" ] } ] }