操作边缘函数运行环境

最近更新时间:2024-09-29 11:33:10

我的收藏

1. 接口描述

接口请求域名: teo.tencentcloudapi.com 。

操作边缘函数运行环境,支持环境变量的相关设置。
设置环境变量后,可在函数代码中使用,具体参考 边缘函数引入环境变量

默认接口请求频率限制:20次/秒。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:HandleFunctionRuntimeEnvironment。
Version String 公共参数,本接口取值:2022-09-01。
Region String 公共参数,此参数为可选参数。
ZoneId String 站点 ID。
FunctionId String 函数 ID。
Operation String 操作类型,取值有:
  • setEnvironmentVariable:设置环境变量,当环境变量存在时为修改行为,否则为添加行为;
  • deleteEnvironmentVariable:删除环境变量变量;
  • clearEnvironmentVariable:清空环境变量变量;
  • resetEnvironmentVariable:重置环境变量变量。
  • EnvironmentVariables.N Array of FunctionEnvironmentVariable 环境变量列表,函数运行环境最多支持 64 个变量。当 Operation 取值为 setEnvironmentVariable、deleteEnvironmentVariable、resetEnvironmentVariable 时必填。

    3. 输出参数

    参数名称 类型 描述
    RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

    4. 示例

    示例1 添加环境变量

    添加指定的环境变量列表到函数运行环境中。

    输入示例

    POST / HTTP/1.1
    Host: teo.tencentcloudapi.com
    Content-Type: application/json
    X-TC-Action: HandleFunctionRuntimeEnvironment
    <公共请求参数>
    
    {
        "ZoneId": "zone-28569s6od5na",
        "FunctionId": "ef-22xxf22",
        "Operation": "setEnvironmentVariable",
        "EnvironmentVariables": [
            {
                "Key": "name",
                "Type": "string",
                "Value": "edgeone"
            }
        ]
    }

    输出示例

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

    示例2 删除环境变量

    删除函数运行环境中的指定环境变量列表。

    输入示例

    POST / HTTP/1.1
    Host: teo.tencentcloudapi.com
    Content-Type: application/json
    X-TC-Action: HandleFunctionRuntimeEnvironment
    <公共请求参数>
    
    {
        "ZoneId": "zone-28569s6od5na",
        "FunctionId": "ef-22xxf22",
        "Operation": "deleteEnvironmentVariable",
        "EnvironmentVariables": [
            {
                "Key": "name",
                "Value": ""
            }
        ]
    }

    输出示例

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

    示例3 清空环境变量

    输入示例

    POST / HTTP/1.1
    Host: teo.tencentcloudapi.com
    Content-Type: application/json
    X-TC-Action: HandleFunctionRuntimeEnvironment
    <公共请求参数>
    
    {
        "ZoneId": "zone-28569s6od5na",
        "FunctionId": "ef-22xxf22",
        "Operation": "clearEnvironmentVariable"
    }

    输出示例

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

    示例4 重置环境变量

    在函数的运行环境中,使用新的环境变量列表覆盖已有的列表。

    输入示例

    POST / HTTP/1.1
    Host: teo.tencentcloudapi.com
    Content-Type: application/json
    X-TC-Action: HandleFunctionRuntimeEnvironment
    <公共请求参数>
    
    {
        "ZoneId": "zone-28569s6od5na",
        "FunctionId": "ef-22xxf22",
        "Operation": "resetEnvironmentVariable",
        "EnvironmentVariables": [
            {
                "Key": "new_name",
                "Type": "string",
                "Value": "edgeone_new"
            }
        ]
    }

    输出示例

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

    5. 开发者资源

    腾讯云 API 平台

    腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

    API Inspector

    用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

    SDK

    云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

    命令行工具

    6. 错误码

    以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码

    错误码 描述
    FailedOperation 操作失败。
    FailedOperation.FunctionDeploying 有其他任务正在部署中,请稍后重试。
    InternalError.SystemError 内部错误-系统错误。
    InvalidParameter.LengthExceedsLimit 参数长度超过限制。
    ResourceUnavailable.FunctionNotFound 函数不存在或不属于该账号。
    ResourceUnavailable.ZoneNotFound 站点不存在或不属于该账号。