当前内容仅提供英语版本,中文版我们将尽快补充,感谢您的理解。

DescribeFunctionReplicas

1. API Description

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

This API is used to query the replica list of edge functions.

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 NameRequiredTypeDescription
ActionYesStringCommon Params. The value used for this API: DescribeFunctionReplicas.
VersionYesStringCommon Params. The value used for this API: 2022-09-01.
RegionNoStringCommon Params. This parameter is not required.
ZoneIdYesStringZone ID.
FunctionIdYesStringFunction ID.
OffsetNoIntegerThe offset of paginated query. Default value: 0.
LimitNoIntegerNumber limit of paginated query. Default value: 20. Maximum value: 200.
SortByNoStringSorting basis. Valid values:
  • created-on: Creation time.
  • Default sorting is based on the created-on attribute.
    SortOrderNoStringList sort method. Valid values:
  • asc: ascending order;
  • desc: sort in descending order.
  • Default value: asc.
    Filters.NNoArray of AdvancedFilterFiltering Conditions. The maximum of Filters.Values is 20. If this parameter is left empty, it returns all function replicas under the function ID. Detailed filter criteria:
  • replica-name: Filter by function replica name. Fuzzy query is supported.
  • 3. Output Parameters

    Parameter NameTypeDescription
    TotalCountIntegerTotal number of edge function replicas.
    FunctionReplicasArray of FunctionReplicaEdge function replica list.
    RequestIdStringThe 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 Query edge function replica list

    Query the replica list of the edge function with ID ef-crkwnfy0 in the ZoneId zone-3exa7oergn0l.

    Input Example

    POST / HTTP/1.1
    Host: teo.intl.tencentcloudapi.com
    Content-Type: application/json
    X-TC-Action: DescribeFunctionReplicas
    <Common request parameters>
    
    {
        "ZoneId": "zone-3exa7oergn0l",
        "FunctionId": "ef-crkwnfy0",
        "Offset": 0,
        "Limit": 10,
        "SortBy": "created-on",
        "SortOrder": "desc"
    }
    

    Output Example

    {
        "Response": {
            "FunctionReplicas": [
                {
                    "Content": "addEventListener('fetch', e => {\r\n  const response = new Response('Hello World 2!');\r\n  e.respondWith(response);\r\n});",
                    "CreatedOn": "2026-01-19T10:22:55+08:00",
                    "FunctionId": "ef-crkwnfy0",
                    "ModifiedOn": "2026-01-19T11:48:52+08:00",
                    "Remark": "Hello World Replica",
                    "ReplicaName": "Hello-World-Replica"
                }
            ],
            "TotalCount": 1,
            "RequestId": "9fc970ff-64bf-4234-a010-a8a7875f77f7"
        }
    }
    

    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

    There is no error code related to the API business logic. For other error codes, please see Common Error Codes.