查询边缘函数列表

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

我的收藏

1. 接口描述

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

查询边缘函数列表,支持函数 ID、函数名称、描述等条件的过滤。

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeFunctions。
Version String 公共参数,本接口取值:2022-09-01。
Region String 公共参数,此参数为可选参数。
ZoneId String 站点 ID。
FunctionIds.N Array of String 按照函数 ID 列表过滤。
Filters.N Array of Filter 过滤条件列表,多个条件为且关系,Filters.Values 的上限为 20。详细的过滤条件如下:
  • name:按照【函数名称】进行模糊匹配。
  • remark:按照【函数描述】进行模糊匹配。
  • Offset Integer 分页查询偏移量。默认值:0。
    Limit Integer 分页查询限制数目。默认值:20,最大值:200。

    3. 输出参数

    参数名称 类型 描述
    TotalCount Integer 符合查询条件的函数总数。
    Functions Array of Function 符合查询条件的所有函数信息。
    RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

    4. 示例

    示例1 根据名称匹配边缘函数列表

    输入示例

    POST / HTTP/1.1
    Host: teo.tencentcloudapi.com
    Content-Type: application/json
    X-TC-Action: DescribeFunctions
    <公共请求参数>
    
    {
        "ZoneId": "zone-293e7s5jne1i",
        "Filters": [
            {
                "Name": "name",
                "Values": [
                    "test"
                ]
            }
        ],
        "Offset": 0,
        "Limit": 2
    }

    输出示例

    {
        "Response": {
            "Functions": [
                {
                    "FunctionId": "ef-1pakhnuy",
                    "ZoneId": "zone-293e7s5jne1i",
                    "Content": "addEventListener('fetch', e => {\r\n  const response = new Response('Hello World!');\r\n  e.respondWith(response);\r\n});",
                    "Name": "test-function",
                    "Remark": "my function",
                    "Domain": "test-function-zone-293e7s5jne1i-123456789.eo-edgefunctions1.com",
                    "CreateTime": "2022-09-19T15:23:25+08:00",
                    "UpdateTime": "2022-09-19T15:27:13+08:00"
                },
                {
                    "FunctionId": "ef-2pakw1uk",
                    "ZoneId": "zone-293e7s5jne1i",
                    "Content": "addEventListener('fetch', e => {\r\n  const response = new Response('Hello World test!');\r\n  e.respondWith(response);\r\n});",
                    "Name": "test-function2",
                    "Remark": "my function 2",
                    "Domain": "test-function-zone-293e7s5jne1i-123456789.eo-edgefunctions1.com",
                    "CreateTime": "2022-09-20T15:23:25+08:00",
                    "UpdateTime": "2022-09-20T15:27:13+08:00"
                }
            ],
            "TotalCount": 17,
            "RequestId": "ab8a61c5-4eef-45af-9384-b071f1922541"
        }
    }

    示例2 根据函数 ID 匹配边缘函数列表

    输入示例

    POST / HTTP/1.1
    Host: teo.tencentcloudapi.com
    Content-Type: application/json
    X-TC-Action: DescribeFunctions
    <公共请求参数>
    
    {
        "ZoneId": "zone-293e7s5jne1i",
        "FunctionIds": [
            "ef-1pakhnuy"
        ],
        "Offset": 0,
        "Limit": 2
    }

    输出示例

    {
        "Response": {
            "Functions": [
                {
                    "FunctionId": "ef-1pakhnuy",
                    "ZoneId": "zone-293e7s5jne1i",
                    "Content": "addEventListener('fetch', e => {\r\n  const response = new Response('Hello World!');\r\n  e.respondWith(response);\r\n});",
                    "Name": "test-function",
                    "Remark": "my function",
                    "Domain": "test-function-zone-293e7s5jne1i-123456789.eo-edgefunctions1.com",
                    "CreateTime": "2022-09-19T15:23:25+08:00",
                    "UpdateTime": "2022-09-19T15:27:13+08:00"
                }
            ],
            "TotalCount": 1,
            "RequestId": "ab8a61c5-4eef-45af-9384-b071f1922541"
        }
    }

    5. 开发者资源

    腾讯云 API 平台

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

    API Inspector

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

    SDK

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

    命令行工具

    6. 错误码

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

    错误码 描述
    InternalError.ProxyServer 后端服务器发生未知错误。
    InternalError.RouteError 后端服务路由地址错误。
    InternalError.SystemError 内部错误-系统错误。
    InvalidParameter.InvalidFilterName 不合法的过滤字段。
    InvalidParameter.LengthExceedsLimit 参数长度超过限制。
    InvalidParameter.TooManyFilterValues 过滤值过多。
    InvalidParameter.TooManyFilters 过滤项过多。
    ResourceUnavailable.FunctionNotFound 函数不存在或不属于该账号。
    ResourceUnavailable.ZoneNotFound 站点不存在或不属于该账号。