tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

CreateFunctionRule

Last updated: 2024-10-11 15:53:21

1. API Description

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

This API is used to create a trigger rule for an edge function.

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: CreateFunctionRule.
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.
FunctionRuleConditions.N Yes Array of FunctionRuleCondition Rule condition list. There is an OR relationship between different conditions of the same trigger rule.
FunctionId Yes String Function ID, specifying a function executed when a trigger rule condition is met.
Remark No String Rule description, which can contain up to 60 characters.

3. Output Parameters

Parameter Name Type Description
RuleId String Rule ID.
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 Creating a Rule for an Edge Function

Input Example

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



{
    "ZoneId": "zone-293e7s5jne1i",
    "FunctionRuleConditions": [
        {
            "RuleConditions": [
                {
                    "Operator": "equal",
                    "Values": [
                        "/123"
                    ],
                    "Target": "url"
                }
            ]
        }
    ],
    "FunctionId": "ef-1pakhnuy",
    "Remark": "my function rule"
}

Output Example

{
    "Response": {
        "RuleId": "rule-vnqup0uc",
        "RequestId": "aab9a28a-4cce-434d-852f-5442275817aa"
    }
}

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.
LimitExceeded.RuleLimitExceeded The number of rules has reached the limit.
OperationDenied.VersionControlLocked The operation is not allowed because the version management mode is applied.
ResourceUnavailable.FunctionNotFound The function does not exist or does not belong to this account.
ResourceUnavailable.ZoneNotFound The site does not exist or is not belong to this account.
Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
Privacy PolicyLegalCookie Policy