tencent cloud

APIs

DocumentationAPIsTencent Cloud EdgeOneEdge Function APIsModifyFunctionComponentBindings

ModifyFunctionComponentBindings

Focus Mode
Font Size
Last updated: 2026-04-13 14:46:08

1. API Description

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

This API is used to modify the binding relationship between edge functions and components, supporting four operation modes: bind, bind-override, unbind, and rebind. By specifying the operation type and component list, you can manage the component binding of 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 Name Required Type Description
Action Yes String Common Params. The value used for this API: ModifyFunctionComponentBindings.
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.
Operation Yes String Operation type. Valid values:
  • bind: bind component;
  • bind-override: Bind a component. If the binding already exists, it is a rebind action; otherwise, it is a bind action.
  • unbind: Unbind a component;
  • rebind: Reset the binding relationship. Clear all existing bindings and set to the passed in bound list. If an empty list is passed in, clear all bindings.

    		•
    FunctionComponentBindings.N Yes Array of FunctionComponentBinding Bound list of function components to operate. When Operation is rebind and an empty list is input, it means to clear ALL bindings.

    3. Output Parameters

    Parameter Name Type Description
    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 Bind an EdgeKV namespace to an edge function

    This example shows you how to add a new EdgeKV namespace binding for the edge function ef-x5tuixcj under site zone-3j1xw7910arp, binding the variable name MY_KV to namespace ns-011.

    Input Example

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

{
    "ZoneId": "zone-3j1xw7910arp",
    "FunctionId": "ef-x5tuixcj",
    "Operation": "bind",
    "FunctionComponentBindings": [
        {
            "Type": "kv_namespace",
            "VariableName": "MY_KV",
            "KVNamespaceParameters": {
                "ZoneId": "zone-3j1xw7910arp",
                "Namespace": "ns-011"
            }
        }
    ]
}

    Output Example

    {
    "Response": {
        "RequestId": "3fe9013c-47a3-4f0c-a660-e5f6e02faba1"
    }
}

    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
    FailedOperation Operation failed.
    InvalidParameter.BindingNotFound Bind variable does not exist.
    InvalidParameter.DuplicateBindingName The bind variable name already exists.
    InvalidParameter.FunctionBindVariableNameConflict The bind name already exists. If needed, please use bind-override.
    InvalidParameter.InvalidOperation Invalid operation type.
    InvalidParameterValue Invalid parameter value.
    ResourceUnavailable.FunctionNotFound The function does not exist or does not belong to this account.
    ResourceUnavailable.NamespaceNotFound KV namespace does not exist.
    Previous Topic: HandleFunctionRuntimeEnvironmentNext Topic: DescribeFunctionComponentBindings

    Help and Support

    Was this page helpful?

    Help us improve! Rate your documentation experience in 5 mins.

    Feedback