DescribeFunctionComponentBindings

1. API Description

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

This API is used to query the component binding list of a specified edge function. It supports pagination and conditional filtering, and returns detailed information such as bound component types, variable names, and configuration parameters. Currently supported bound component types include KV namespace (kv_namespace).

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: DescribeFunctionComponentBindings.
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.
Offset	No	Integer	The offset of paginated query. Default value: 0.
Limit	No	Integer	The limit of paginated query. Default value: 20. Maximum value: 1,000.
Filters.N	No	Array of AdvancedFilter	Filter conditions. The maximum number of Filters.Values is 20. Detailed filter criteria: Name: Filter by the bound variable name. Fuzzy query is supported. type: Filter by binding type. Fuzzy queries are not supported.

3. Output Parameters

Parameter Name	Type	Description
TotalCount	Integer	Total number of eligible functions bound.
FunctionComponentBindings	Array of FunctionComponentBinding	Function component bound list.
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 Querying the Bound List of an Edge Function Component

Query the bound list of components of edge function ef-x5tuixcj in query site zone-3j1xw7910arp, starting from record 0 with 10 records to be returned per page.

Input Example

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

{
    "ZoneId": "zone-3j1xw7910arp",
    "FunctionId": "ef-x5tuixcj",
    "Offset": 0,
    "Limit": 10
}

Output Example

{
    "Response": {
        "FunctionComponentBindings": [
            {
                "KVNamespaceParameters": {
                    "Namespace": "ns-011",
                    "ZoneId": "zone-3j1xw7910arp"
                },
                "Type": "kv_namespace",
                "VariableName": "MY_KV"
            }
        ],
        "TotalCount": 1,
        "RequestId": "34da5ee4-18b8-4d18-9354-907df99d4234"
    }
}

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

Tencent Cloud CLI 3.0

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.
InvalidParameter.InvalidFilterName	Invalid filter field.
InvalidParameterValue	Invalid parameter value.

1. API Description
2. Input Parameters
3. Output Parameters
4. Example
Example1 Querying the Bound List of an Edge Function Component
5. Developer Resources
SDK
Command Line Interface
6. Error Code