tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

HandleFunctionRuntimeEnvironment

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

1. API Description

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

This API is used to operate the runtime environment of an edge function. It supports related settings for environment variables.
After the environment variables are set, they can be used in the function code. For details, see Edge Functions Referencing Environment Variables.

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: HandleFunctionRuntimeEnvironment.
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.
Operation Yes String Operation type. Valid values:
  • setEnvironmentVariable: Set an environment variable. If the environment variable exists, it will be modified; otherwise, it will be added.
  • deleteEnvironmentVariable: Delete an environment variable.
  • clearEnvironmentVariable: Clear an environment variable.
  • resetEnvironmentVariable: Reset an environment variable.
    		•
    EnvironmentVariables.N No Array of FunctionEnvironmentVariable Environment variable list. The runtime environment of a function supports up to 64 variables. This parameter is required when the value of Operation is setEnvironmentVariable, deleteEnvironmentVariable, or resetEnvironmentVariable.

    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 Adding Environment Variables

    This example shows you how to add a specified environment variable list to the runtime environment of a function.

    Input Example

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



{
    "ZoneId": "zone-28569s6od5na",
    "FunctionId": "ef-22xxf22",
    "Operation": "setEnvironmentVariable",
    "EnvironmentVariables": [
        {
            "Key": "name",
            "Type": "string",
            "Value": "edgeone"
        }
    ]
}

    Output Example

    {
    "Response": {
        "RequestId": "4dcgtb24-7dc5-46s2-9q3e-95825d53dcs3a"
    }
}

    Example2 Deleting Environment Variables

    This example shows you how to delete a specified environment variable list in the runtime environment of a function.

    Input Example

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



{
    "ZoneId": "zone-28569s6od5na",
    "FunctionId": "ef-22xxf22",
    "Operation": "deleteEnvironmentVariable",
    "EnvironmentVariables": [
        {
            "Key": "name",
            "Value": ""
        }
    ]
}

    Output Example

    {
    "Response": {
        "RequestId": "4dcgtb24-7dc5-46s2-9q3e-95825d53dcs3a"
    }
}

    Example3 Clearing Environment Variables

    Input Example

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



{
    "ZoneId": "zone-28569s6od5na",
    "FunctionId": "ef-22xxf22",
    "Operation": "clearEnvironmentVariable"
}

    Output Example

    {
    "Response": {
        "RequestId": "4dcgtb24-7dc5-46s2-9q3e-95825d53dcs3a"
    }
}

    Example4 Resetting Environment Variables

    This example shows you how to use a new environment variable list to override the existing list in the runtime environment of a function.

    Input Example

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



{
    "ZoneId": "zone-28569s6od5na",
    "FunctionId": "ef-22xxf22",
    "Operation": "resetEnvironmentVariable",
    "EnvironmentVariables": [
        {
            "Key": "new_name",
            "Type": "string",
            "Value": "edgeone_new"
        }
    ]
}

    Output Example

    {
    "Response": {
        "RequestId": "4dcgtb24-7dc5-46s2-9q3e-95825d53dcs3a"
    }
}

    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.LengthExceedsLimit Maximum parameter length exceeded.
    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.
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    Privacy PolicyLegalCookie Policy