tencent cloud

Feedback

ModifyFunction

Last updated: 2024-10-11 15:53:12

1. API Description

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

This API is used to modify an edge function. It supports modifying the function content and description. The function will take effect immediately after modification and redeployment.

A maximum of 20 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 Name Required Type Description
Action Yes String Common Params. The value used for this API: ModifyFunction.
Version Yes String Common Params. The value used for this API: 2022-09-01.
Region No String Common Params. This parameter is not required.
ZoneId Yes String Zone ID.
FunctionId Yes String Function ID.
Remark No String Function description, which can contain up to 60 characters. If this parameter is not input, the original configuration is maintained.
Content No String Function content, which currently only supports JavaScript code. Its maximum size is 5 MB. If this parameter is not input, the original configuration is maintained.

3. Output Parameters

Parameter Name Type Description
RequestId String The 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 Modifying an Edge Function

Input Example

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



{
    "ZoneId": "zone-2gqxim9jstab",
    "FunctionId": "ef-1pakhnuy",
    "Remark": "my function",
    "Content": "addEventListener('fetch', e => {\r\n  const response = new Response('Hello World!');\r\n  e.respondWith(response);\r\n});"
}

Output Example

{
    "Response": {
        "RequestId": "b660855b-a0a7-4cd3-832d-e01fb1b8da93"
    }
}

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 Code Description
FailedOperation Operation failed.
FailedOperation.FunctionDeploying Another task is being deployed. Please try again later.
InternalError.SystemError Internal system error.
InvalidParameter.BadContent The function content has a syntax error.
InvalidParameter.ContentExceedsLimit The function content exceeds the size limit.
InvalidParameter.LengthExceedsLimit Maximum parameter length exceeded.
InvalidParameter.ModifyParametersMissing Modification parameters are missing.
ResourceUnavailable.FunctionNotFound The function does not exist or does not belong to this account.
ResourceUnavailable.ZoneNotFound The site does not exist or is not belong to this account.