tencent cloud

边缘安全加速平台 EO

ModifyFunctionRule

PDF
聚焦模式
字号
最后更新时间: 2026-04-13 14:46:07

1. API Description

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

This API is used to modify a trigger rule for an edge function. It supports modifying rule conditions, execution functions, and description. You can first use the DescribeFunctionRules API to get the RuleId of the rule that needs to be modified, then input the modified rule content. The original rule content will be overwritten.

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: ModifyFunctionRule.
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.
RuleId Yes String Rule ID. you can first use the DescribeFunctionRules API to get the RuleId that needs to be modified, then input the modified rule content. the original rule content will be overwritten.
FunctionRuleConditions.N No Array of FunctionRuleCondition Rule condition list. There is an OR relationship between different conditions of the same trigger rule. If this parameter is not input, the original configuration is maintained.
TriggerType No String Function selection configuration type.
  • Direct: specifies the execution function directly.
  • .
  • Weight: selects the function based on weight ratio.
  • .
  • region: specifies the country/region selection function based on client IP.
  • .
    Specifies the default value as direct when left blank.
    FunctionId No String Specifies the function ID to be executed. this parameter is valid only when TriggerType is direct or left empty.
    RegionMappingSelections.N No Array of FunctionRegionSelection Function selection configuration based on client IP country/region. this parameter is valid only when TriggerType is region and RegionMappingSelections is required. RegionMappingSelections must include at least one configuration with Regions set to Default.
    WeightedSelections.N No Array of FunctionWeightedSelection Weighted function selection configuration. this parameter is valid only when TriggerType is weight and WeightedSelections is required. the sum of all weights in WeightedSelections need to be 100.
    Remark No String Rule description, which can contain up to 60 characters. If this parameter is not input, the original configuration is maintained.

    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 Modifying Edge Function Rule Hit Rules to Execute Specified Function Afterwards

    This example shows you how to modify the function rule rule-vnqup0uc to hit the rule when the request host is www.function.com, use direct to select the target function with ID ef-1pakhnuy.

    Input Example

    POST / HTTP/1.1
    Host: teo.intl.tencentcloudapi.com
    Content-Type: application/json
    X-TC-Action: ModifyFunctionRule
    <Common request parameters>
    
    {
        "ZoneId": "zone-293e7s5jne1i",
        "RuleId": "rule-vnqup0uc",
        "FunctionRuleConditions": [
            {
                "RuleConditions": [
                    {
                        "Operator": "equal",
                        "Values": [
                            "www.function.com"
                        ],
                        "Target": "host"
                    }
                ]
            }
        ],
        "TriggerType": "direct",
        "FunctionId": "ef-1pakhnuy",
        "Remark": "function rule trigger direct"
    }
    

    Output Example

    {
        "Response": {
            "RequestId": "7a1e998f-fa00-4670-8457-ed4b4fe5018a"
        }
    }
    

    Example2 Modifying an Edge Function Rule to Execute Different Functions Based on Client Request Region When Hitting the Rule

    This example shows you how to modify the function rule rule-vnqup0uc. When the Request host is www.function.com, it hits the rule and selects the target function via region (based on the client IP country/region). If the client IP location is Chinese mainland, it executes function ef-1pakhnuy. If the client IP location is other region, it executes function ef-1wekxwnu.

    Input Example

    POST / HTTP/1.1
    Host: teo.intl.tencentcloudapi.com
    Content-Type: application/json
    X-TC-Action: ModifyFunctionRule
    <Common request parameters>
    
    {
        "ZoneId": "zone-293e7s5jne1i",
        "RuleId": "rule-vnqup0uc",
        "FunctionRuleConditions": [
            {
                "RuleConditions": [
                    {
                        "Operator": "equal",
                        "Values": [
                            "www.function.com"
                        ],
                        "Target": "host"
                    }
                ]
            }
        ],
        "TriggerType": "region",
        "RegionMappingSelections": [
            {
                "FunctionId": "ef-1pakhnuy",
                "Regions": [
                    "CN"
                ]
            },
            {
                "FunctionId": "ef-1wekxwnu",
                "Regions": [
                    "Default"
                ]
            }
        ],
        "Remark": "function rule trigger region"
    }
    

    Output Example

    {
        "Response": {
            "RequestId": "7a1e998f-fa00-4670-8457-ed4b4fe5018a"
        }
    }
    

    Example3 Modify Edge Function Rule Hit Rules and Execute Different Functions Based on Customer Set Weight

    This example shows you how to modify function rule rule-vnqup0uc. When the Request host is www.function.com, it hits the rule and selects the target function via weight. There is a 20% probability to execute function ef-1pakhnuy and an 80% probability to execute function ef-1wekxwnu.

    Input Example

    POST / HTTP/1.1
    Host: teo.intl.tencentcloudapi.com
    Content-Type: application/json
    X-TC-Action: ModifyFunctionRule
    <Common request parameters>
    
    {
        "ZoneId": "zone-293e7s5jne1i",
        "RuleId": "rule-vnqup0uc",
        "FunctionRuleConditions": [
            {
                "RuleConditions": [
                    {
                        "Operator": "equal",
                        "Values": [
                            "www.function.com"
                        ],
                        "Target": "host"
                    }
                ]
            }
        ],
        "TriggerType": "weight",
        "WeightedSelections": [
            {
                "FunctionId": "ef-1wekxwnu",
                "Weight": 80
            },
            {
                "FunctionId": "ef-1pakhnuy",
                "Weight": 20
            }
        ],
        "Remark": "function rule trigger weight"
    }
    

    Output Example

    {
        "Response": {
            "RequestId": "7a1e998f-fa00-4670-8457-ed4b4fe5018a"
        }
    }
    

    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.
    FailedOperation.RuleOperationConflict Function rule operations conflict under this site.
    InternalError.SystemError Internal system error.
    InvalidParameter.DuplicateRule Duplicate rules.
    InvalidParameter.InvalidConditions Invalid conditions.
    InvalidParameter.ModifyParametersMissing Modification parameters are missing.
    ResourceUnavailable.FunctionNotFound The function does not exist or does not belong to this account.
    ResourceUnavailable.RuleNotFound The rule does not exist or does not belong to the account.

    帮助和支持

    本页内容是否解决了您的问题?

    填写满意度调查问卷,共创更好文档体验。

    文档反馈