1. 接口描述
接口请求域名: scf.tencentcloudapi.com 。
该接口根据传入参数更新函数代码。
默认接口请求频率限制:100次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:UpdateFunctionCode。 |
Version | 是 | String | 公共参数,本接口取值:2018-04-16。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
FunctionName | 是 | String | 要修改的函数名称 示例值:test |
Handler | 否 | String | 函数处理方法名称。名称格式支持“文件名称.函数名称”形式(java 名称格式 包名.类名::方法名),文件名称和函数名称之间以"."隔开,文件名称和函数名称要求以字母开始和结尾,中间允许插入字母、数字、下划线和连接符,文件名称和函数名字的长度要求 2-60 个字符 示例值:index.main |
CosBucketName | 否 | String | 对象存储桶名称 示例值:<CosBucketName> |
CosObjectName | 否 | String | 对象存储对象路径 示例值:<CosObjectName> |
ZipFile | 否 | String | 包含函数代码文件及其依赖项的 zip 格式文件,使用该接口时要求将 zip 文件的内容转成 base64 编码,最大支持20M 示例值:<base64> |
Namespace | 否 | String | 函数所属命名空间 示例值:default |
CosBucketRegion | 否 | String | 对象存储的地域,注:北京分为ap-beijing和ap-beijing-1 示例值:ap-beijing |
InstallDependency | 否 | String | 是否自动安装依赖 示例值:FALSE |
EnvId | 否 | String | 函数所属环境 示例值:<函数所属环境> |
Publish | 否 | String | 在更新时是否同步发布新版本,默认为:FALSE,不发布 示例值:FALSE |
Code | 否 | Code | 函数代码 |
CodeSource | 否 | String | 代码来源方式,支持 ZipFile, Cos, Inline 之一 示例值:Cos |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 更新函数代码
输入示例
POST / HTTP/1.1
Host: scf.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: UpdateFunctionCode
<公共请求参数>
{
"CosObjectName": "<CosObjectName>",
"Handler": "index.main",
"CosBucketName": "<CosBucketName>",
"FunctionName": "test"
}
输出示例
{
"Response": {
"RequestId": "eac6b301-a322-493a-8e36-83b295459397"
}
}
5. 开发者资源
腾讯云 API 平台
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。
API Inspector
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。
SDK
云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python: GitHub Gitee
- Tencent Cloud SDK 3.0 for Java: GitHub Gitee
- Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
- Tencent Cloud SDK 3.0 for Go: GitHub Gitee
- Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
- Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
- Tencent Cloud SDK 3.0 for C++: GitHub Gitee
- Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
FailedOperation | 操作失败。 |
FailedOperation.CallRoleFailed | 请求role信息失败。 |
FailedOperation.FunctionStatusError | 函数在部署中,无法做此操作。 |
FailedOperation.OperationConflict | 操作冲突。 |
FailedOperation.UpdateFunctionCode | 当前函数状态无法更新代码,请在状态为正常时更新。 |
InternalError.System | 内部系统错误。 |
InvalidParameter.Payload | 请求参数不合法。 |
InvalidParameterValue | 参数取值错误。 |
InvalidParameterValue.Args | Args 参数值有误。 |
InvalidParameterValue.ArgsList | 容器启动参数取值与规范不符。 |
InvalidParameterValue.Code | Code传入错误。 |
InvalidParameterValue.CodeSecret | CodeSecret传入错误。 |
InvalidParameterValue.CodeSource | CodeSource传入错误。 |
InvalidParameterValue.Command | Command[Entrypoint] 参数值有误。 |
InvalidParameterValue.CommandList | 容器启动命令参数值与规范不符。 |
InvalidParameterValue.Cos | Cos传入错误。 |
InvalidParameterValue.CosBucketName | CosBucketName不符合规范。 |
InvalidParameterValue.CosBucketRegion | CosBucketRegion取值与规范不符,请修正后再试。可参考:https://cloud.tencent.com/document/product/583/17244#Code。 |
InvalidParameterValue.CosObjectName | CosObjectName不符合规范。 |
InvalidParameterValue.Demo | DemoID 对应的函数模板 ,code 参数值有误,请确认后重试。 |
InvalidParameterValue.DemoId | DemoId 不存在。 |
InvalidParameterValue.DnsInfo | 环境变量DNS[OS_NAMESERVER]配置有误。 |
InvalidParameterValue.FunctionName | 函数不存在。 |
InvalidParameterValue.GitBranch | GitBranch不符合规范。 |
InvalidParameterValue.GitDirectory | GitDirectory不符合规范。 |
InvalidParameterValue.GitPassword | GitPassword不符合规范。 |
InvalidParameterValue.GitUrl | GitUrl不符合规范。 |
InvalidParameterValue.GitUserName | GitUserName不符合规范。 |
InvalidParameterValue.Handler | Handler传入错误。 |
InvalidParameterValue.ImageType | ImageType 参数值有误。 |
InvalidParameterValue.ImageUri | imageUri 传入有误。 |
InvalidParameterValue.InlineZipFile | InlineZipFile非法。 |
InvalidParameterValue.Namespace | Namespace参数传入错误。 |
InvalidParameterValue.RegistryId | 企业版镜像实例ID[RegistryId]传值错误。 |
InvalidParameterValue.TempCosObjectName | 非法的TempCosObjectName。 |
InvalidParameterValue.ZipFile | 检测到不是标准的zip文件,请重新压缩后再试。 |
InvalidParameterValue.ZipFileBase64BinasciiError | 压缩文件base64解码失败: Incorrect padding ,请修正后再试。 |
LimitExceeded.ContainerImageAccelerate | 用户开启镜像加速函数版本超限。 |
LimitExceeded.ContainerImageAccelerateQuota | 用户开启镜像加速函数版本超限。 |
ResourceNotFound.Function | 函数不存在。 |
ResourceNotFound.FunctionName | 函数不存在。 |
ResourceNotFound.ImageConfig | 未找到指定的ImageConfig,请创建后再试。 |
ResourceNotFound.Namespace | Namespace不存在。 |
UnauthorizedOperation.CAM | CAM鉴权失败。 |
UnauthorizedOperation.TempCosAppid | TempCos的Appid和请求账户的APPID不一致。 |
UnauthorizedOperation.UpdateFunctionCode | 无法进行此操作。 |
UnsupportedOperation | 操作不支持。 |
UnsupportedOperation.UpdateFunctionCode | 更新函数代码失败。 |