CreateFunction

Last updated: 2020-10-23 10:07:33

    1. API Description

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

    This API is used to create a function based on the input parameters.

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

    Note: This API supports Finance regions. If the common parameter Region is a Finance region, a domain name with the Finance region needs to be specified, for example: scf.ap-shanghai-fsi.tencentcloudapi.com

    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.

    Parameter Name Required Type Description
    Action Yes String Common parameter. The value used for this API: CreateFunction.
    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 new function. The name can contain 2 to 60 characters, including English letters, digits, hyphens (-), and underscores (_). The name must start with a letter and cannot end with a hyphen or underscore.
    Code Yes Code Function code. Note: You cannot specify Cos and ZipFile at the same time.
    Handler No String Name of the handler, which is in the 'file name.handler name' form. Use periods (.) to separate a file name and function name. The file name and function name must start and end with a letter and can contain 2 to 60 characters, including letters, digits, hyphens (-), and underscores (_).
    Description No String Function description. It can contain up to 1,000 characters including letters, digits, spaces, commas (,), periods (.), and Chinese characters.
    MemorySize No Integer Memory size available for function during execution. Default value: 128 MB. Value range: 64 or 128-3072 MB in increments of 128 MB
    Timeout No Integer Maximum execution duration of function in seconds. Value range: 1-900 seconds. Default value: 3 seconds
    Environment No Environment Function environment variable
    Runtime No String Function runtime environment. Valid values: Python2.7, Python3.6, Nodejs6.10, Nodejs8.9, Nodejs10.15, Nodejs12.16, PHP5, PHP7, Golang1 and Java8. Default value: Python2.7
    VpcConfig No VpcConfig Function VPC configuration
    Namespace No String Function namespace
    Role No String Role bound to the function
    ClsLogsetId No String CLS Logset ID to which the function logs are shipped
    ClsTopicId No String CLS Topic ID to which the function logs are shipped
    Type No String Function type. The default value is Event. Enter Event if you need to create a trigger function. Enter HTTP if you need to create an HTTP function service.
    CodeSource No String Code source, including ZipFile, Cos, Demo, TempCos, and Git. This field is required if the source is Git.
    Layers.N No Array of LayerVersionSimple List of layer versions to be associate with the function. Layers will be overwritten sequentially in the order in the list.
    DeadLetterConfig No DeadLetterConfig Dead letter queue parameter
    PublicNetConfig No PublicNetConfigIn Public network access configuration
    CfsConfig No CfsConfig File system configuration parameter, which is used for the function to mount the file system
    InitTimeout No Integer Timeout period for function initialization
    Tags.N No Array of Tag Tag parameter of the function. It is an array of key-value pairs.

    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 Creating a Function

    Input Example

    https://scf.tencentcloudapi.com/?Action=CreateFunction
    &FunctionName=<FunctionName>
    &Handler=<function.handler>
    &Code.CosBucketName=<CosBucketName>
    &Code.CosObjectName=<CosObjectName>
    &<common request parameters>

    Output Example

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

    5. Developer Resources

    API Explorer

    This tool allows online call, signature authentication, SDK code generation and quick search of APIs to greatly improve the efficiency of using TencentCloud APIs.

    SDK

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

    Command Line Interface

    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.CreateFunction Operation failed.
    FailedOperation.Namespace The namespace already exists. Please do not create it again.
    InternalError Internal error.
    InternalError.System Internal system error.
    InvalidParameter.Payload Invalid request parameter.
    InvalidParameterValue Incorrect parameter value.
    InvalidParameterValue.Cls Cls error.
    InvalidParameterValue.Code Code error.
    InvalidParameterValue.CodeSecret CodeSecret error.
    InvalidParameterValue.CodeSource CodeSource error.
    InvalidParameterValue.Cos Cos error.
    InvalidParameterValue.CosBucketName Invalid CosBucketName.
    InvalidParameterValue.CosObjectName Invalid CosObjectName.
    InvalidParameterValue.Description Description error.
    InvalidParameterValue.EipConfig EipConfig parameter error.
    InvalidParameterValue.Environment Environment error.
    InvalidParameterValue.FunctionName The function does not exist.
    InvalidParameterValue.Handler Handler error.
    InvalidParameterValue.Layers Layers parameter error.
    InvalidParameterValue.MemorySize MemorySize error.
    InvalidParameterValue.Namespace Namespace error.
    InvalidParameterValue.PublicNetConfig The PublicNetConfig parameter is invalid.
    InvalidParameterValue.Runtime Runtime error.
    InvalidParameterValue.TempCosObjectName Invalid TempCosObjectName.
    InvalidParameterValue.Type Type error.
    InvalidParameterValue.ZipFile A non-standard zip file was detected. Please recompress and try again.
    LimitExceeded.Eip The EIP resource exceeded the limit.
    LimitExceeded.Function If the number of functions exceeds the upper limit, you can apply for an increase by submitting a ticket.
    LimitExceeded.Memory The memory exceeds the upper limit.
    LimitExceeded.Timeout Timeout exceeds the upper limit.
    MissingParameter.Code Failed to import Code.
    MissingParameter.Runtime Runtime is missing.
    ResourceInUse.Function This function already exists.
    ResourceInUse.FunctionName This FunctionName already exists.
    ResourceNotFound.Cmq Cmq does not exist.
    ResourceNotFound.Demo Demo does not exist.
    ResourceNotFound.Layer The layer does not exist.
    ResourceNotFound.Namespace Namespace does not exist.
    ResourceNotFound.Role The role does not exist.
    ResourceNotFound.Vpc The VPC or subnet does not exist.
    ResourceUnavailable.Namespace The Namespace is not available.
    UnauthorizedOperation.CAM CAM authentication failed.
    UnauthorizedOperation.Region Region error.
    UnauthorizedOperation.Role You do not have permissions to access your Cos resources.
    UnauthorizedOperation.TempCosAppid The Appid of TempCos is not consistent with the APPID of the request account.
    UnsupportedOperation Unsupported operation.

    Was this page helpful?

    Was this page helpful?

    • Not at all
    • Not very helpful
    • Somewhat helpful
    • Very helpful
    • Extremely helpful
    Send Feedback
    Help