CreateFunction

1. API Description

Domain name for API request: teo.intl.tencentcloudapi.com.

This API is used to create and deploy an edge function to EdgeOne edge nodes.

A maximum of 5 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.

Parameter NameRequiredTypeDescription
ActionYesStringCommon Params. The value used for this API: CreateFunction.
VersionYesStringCommon Params. The value used for this API: 2022-09-01.
RegionNoStringCommon Params. This parameter is not required.
ZoneIdYesStringZone ID.
NameYesStringFunction name, which can contain up to 30 characters, including lowercase letters, digits, and hyphens. It should start and end with a digit or a letter.
ContentYesStringFunction content, which currently only supports JavaScript code. Its maximum size is 5 MB.
RemarkNoStringFunction description, which can contain up to 60 characters.

3. Output Parameters

Parameter NameTypeDescription
FunctionIdStringFunction ID.
RequestIdStringThe unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.

4. Example

Example1 Creating an Edge Function

Input Example

POST / HTTP/1.1
Host: teo.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateFunction
<Common request parameters>



{
    "ZoneId": "zone-293e7s5jne1i",
    "Name": "test-function",
    "Remark": "my test function",
    "Content": "addEventListener('fetch', e => {\r\n  const response = new Response('Hello World!');\r\n  e.respondWith(response);\r\n});"
}

Output Example

{
    "Response": {
        "FunctionId": "ef-1pakhnuy",
        "RequestId": "85caed2d-e16e-4205-a322-1e907e830b55"
    }
}

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

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 CodeDescription
FailedOperationOperation failed.
FailedOperation.FunctionDeployingAnother task is being deployed. Please try again later.
InternalError.SystemErrorInternal system error.
InvalidParameter.BadContentThe function content has a syntax error.
InvalidParameter.BadFunctionNameThe function name does not meet specifications.
InvalidParameter.ContentExceedsLimitThe function content exceeds the size limit.
InvalidParameter.FunctionNameConflictThe function name conflicts with that of another function under this account.
InvalidParameter.LengthExceedsLimitMaximum parameter length exceeded.
LimitExceeded.FunctionLimitExceededThe number of functions has reached the limit.
OperationDenied.VersionControlLockedThe operation is not allowed because the version management mode is applied.
ResourceUnavailable.ZoneNotFoundThe site does not exist or is not belong to this account.
UnauthorizedOperation.CamUnauthorizedCAM is not authorized.