ModifyFunctionRule

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.

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.
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.
FunctionId	No	String	Function ID, specifying a function executed when a trigger rule condition is met. If this parameter is not input, the original configuration is maintained.
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 a Rule for an Edge Function

Input Example

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



{
    "ZoneId": "zone-2gqxim9jstab",
    "RuleId": "rule-vnqup0uc",
    "FunctionRuleConditions": [
        {
            "RuleConditions": [
                {
                    "Operator": "equal",
                    "Values": [
                        "/test"
                    ],
                    "Target": "url"
                }
            ]
        }
    ],
    "FunctionId": "ef-1pakhnuy",
    "Remark": "my function"
}

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

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.
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.

1. API Description
2. Input Parameters
3. Output Parameters
4. Example
Example1 Modifying a Rule for an Edge Function
5. Developer Resources
SDK
Command Line Interface
6. Error Code