tencent cloud

PrevNext

文档反馈

请输入关键字

Recent Pages

文档
文档

DescribeFunctions

最后更新时间：2024-10-11 15:53:14

1. API Description

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

This API is used to query the list of edge functions. It supports filtering by function ID, name, description, and so on.

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: DescribeFunctions.
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.
FunctionIds.N No Array of String Filter by function ID list.
Filters.N No Array of Filter Filter criteria list. There is an AND relationship between different criteria. The maximum number of Filters.Values is 20. The detailed filter criteria are as follows:
  • name: Fuzzy match by [function name].
  • remark: Fuzzy match by [function description].
    		•
    Offset No Integer The offset of paginated query. Default value: 0.
    Limit No Integer Number limit of paginated query. Default value: 20. Maximum value: 200.

    3. Output Parameters

    Parameter Name Type Description
    TotalCount Integer Total number of functions that meet the query condition.
    Functions Array of Function Information of all functions that meet the query condition.
    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 Matching the List of Edge Functions by Name

    Input Example

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



{
    "ZoneId": "zone-293e7s5jne1i",
    "Filters": [
        {
            "Name": "name",
            "Values": [
                "test"
            ]
        }
    ],
    "Offset": 0,
    "Limit": 2
}

    Output Example

    {
    "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"
    }
}

    Example2 Matching the List of Edge Functions by Function ID

    Input Example

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



{
    "ZoneId": "zone-293e7s5jne1i",
    "FunctionIds": [
        "ef-1pakhnuy"
    ],
    "Offset": 0,
    "Limit": 2
}

    Output Example

    {
    "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. 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
    InternalError.ProxyServer An unknown error occurred in the backend server.
    InternalError.RouteError The backend routing address is incorrect.
    InternalError.SystemError Internal system error.
    InvalidParameter.InvalidFilterName Invalid filter field.
    InvalidParameter.LengthExceedsLimit Maximum parameter length exceeded.
    InvalidParameter.TooManyFilterValues Too many filter values.
    InvalidParameter.TooManyFilters Too many filter items.
    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.
    隐私条款服务条款缓存条款