UpdateFunctionCode

Prev Next

search by keyword

Recent Pages

Documentation

Download PDF

Last updated: 2022-01-17 10:20:22

Download PDF

1. API Description

Domain name for API request: scf.tencentcloudapi.com.

This API is used to update the function code based on the input parameters.

A maximum of 100 requests can be initiated per second for this API.

We recommend you to use API Explorer

Try it

API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters

The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.
This document describes the parameters for Signature V1. It's recommended to use the V3 signature, which provides higher security. Note that for Signature V3, the common parameters need to be placed in the HTTP Header. See details.

Parameter Name	Required	Type	Description
Action	Yes	String	Common parameter. The value used for this API: UpdateFunctionCode.
Version	Yes	String	Common parameter. The value used for this API: 2018-04-16.
Region	Yes	String	Common parameter. For more information, please see the list of regions supported by the product.
FunctionName	Yes	String	Name of the function to be modified
Handler	No	String	Function handler name, which is in the `file name.function name` form. Use a period (.) to separate a file name and function name. The file name and function name must start and end with letters and contain 2-60 characters, including letters, digits, underscores (_), and hyphens (-).
CosBucketName	No	String	COS bucket name
CosObjectName	No	String	COS object path
ZipFile	No	String	It contains a function code file and its dependencies in the ZIP format. When you use this API, the ZIP file needs to be encoded with Base64. Up to 20 MB is supported.
Namespace	No	String	Function namespace
CosBucketRegion	No	String	COS region. Note: Beijing includes ap-beijing and ap-beijing-1.
InstallDependency	No	String	Whether to install dependencies automatically
EnvId	No	String	Function environment
Publish	No	String	It specifies whether to synchronously release a new version during the update. The default value is `FALSE`, indicating not to release a new version.
Code	No	Code	Function code
CodeSource	No	String	Code source. Valid values: ZipFile, Cos, Inline

3. Output Parameters

Parameter Name	Type	Description
RequestId	String	The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Updating function code

Input Example

https://scf.tencentcloudapi.com/?Action=UpdateFunctionCode
&FunctionName=test
&Handler=index.main
&CosBucketName=<CosBucketName>
&CosObjectName=<CosObjectName>
&<Common request parameters>

Output Example

{
  "Response": {
    "RequestId": "eac6b301-a322-493a-8e36-83b295459397"
  }
}

5. Developer Resources

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

Command Line Interface

Tencent Cloud CLI 3.0

6. Error Code

The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.

Error Code	Description
FailedOperation	Operation failed.
FailedOperation.FunctionStatusError	Operation failed. The function is deploying.
FailedOperation.OperationConflict	Operation conflict.
FailedOperation.UpdateFunctionCode	You cannot update code in the current function state. Please try again when the state is normal.
InternalError.System	Internal system error.
InvalidParameter.Payload	Invalid request parameter.
InvalidParameterValue	Incorrect parameter value.
InvalidParameterValue.Args	The value of Args is incorrect.
InvalidParameterValue.Code	Code error.
InvalidParameterValue.CodeSecret	CodeSecret error.
InvalidParameterValue.CodeSource	CodeSource error.
InvalidParameterValue.Command	The value of Command[Entrypoint] is incorrect.
InvalidParameterValue.Cos	Cos error.
InvalidParameterValue.CosBucketName	Invalid CosBucketName.
InvalidParameterValue.CosBucketRegion	The value of CosBucketRegion is invalid. Please modify and try again. See: https://tencentcs.com/5jXKFnBW
InvalidParameterValue.CosObjectName	Invalid CosObjectName.
InvalidParameterValue.FunctionName	The function does not exist.
InvalidParameterValue.GitBranch	The format of GitBranch is incorrect.
InvalidParameterValue.GitDirectory	The format of GitDirectory is incorrect.
InvalidParameterValue.GitPassword	The format of GitPassword is incorrect.
InvalidParameterValue.GitUrl	The format of GitUrl is incorrect.
InvalidParameterValue.GitUserName	The format of GitUserName is incorrect.
InvalidParameterValue.Handler	Handler error.
InvalidParameterValue.ImageUri	The input of imageUri is incorrect.
InvalidParameterValue.InlineZipFile	Invalid InlineZipFile.
InvalidParameterValue.Namespace	Namespace error.
InvalidParameterValue.RegistryId	The value Enterprise Edition image ID [RegistryId] is incorrect.
InvalidParameterValue.TempCosObjectName	Invalid TempCosObjectName.
InvalidParameterValue.ZipFile	A non-standard zip file was detected. Please recompress and try again.
InvalidParameterValue.ZipFileBase64BinasciiError	Failed to Base64-decode the compressed file: `Incorrect padding`. Please fix it and try again.
ResourceNotFound.Function	The function does not exist.
ResourceNotFound.FunctionName	The function does not exist.
ResourceNotFound.Namespace	Namespace does not exist.
UnauthorizedOperation.CAM	CAM authentication failed.
UnauthorizedOperation.TempCosAppid	The `Appid` of TempCos is not consistent with the APPID of the request account.
UnauthorizedOperation.UpdateFunctionCode	Operation failed.
UnsupportedOperation	Unsupported operation.

Recent Pages