tencent cloud

All product documents
APIs
DocumentationAPIsEvent BridgeEvent Rule APIsCreateRule
CreateRule
Last updated: 2023-12-12 16:26:01
CreateRule
Last updated: 2023-12-12 16:26:01

1. API Description

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

This API is used to create an event rule.

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: CreateRule.
Version Yes String Common Params. The value used for this API: 2021-04-16.
Region No String Common Params. This parameter is not required for this API.
EventPattern Yes String See Event Pattern.
EventBusId Yes String Event bus ID.
RuleName Yes String Event bus name, which can contain 2–60 letters, digits, underscores, and hyphens and must start with a letter and end with a digit or letter
Enable No Boolean Switch.
Description No String Event bus description, which can contain up to 200 characters of any type

3. Output Parameters

Parameter Name Type Description
RuleId String Event rule ID
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Creating a Filter Rule

Input Example

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

{
    "EventBusId": "eb-anao4i7q",
    "Description": "rule-test1",
    "Enable": true,
    "EventPattern": "{\n  \"source\": [\n    \"ckafka.cloud.tencent\"\n  ]\n}",
    "RuleName": "rule-test1"
}

Output Example

{
    "Response": {
        "RuleId": "rule-xxxxxxx",
        "RequestId": "xxxxxxxxxxxxxxxxxxx"
    }
}

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.TagResource Failed to bind the tag
FailedOperation.TagResourceAllocateQuotas Failed to apply for more tag quota
InvalidParameterValue.DeadLetterConfig The dead letter queue parameter is invalid. Please check and try again.
InvalidParameterValue.Description The Description value does not conform to the specification. Please fix it and try again.
InvalidParameterValue.EventPattern The EventPattern value does not conform to the specification. Please fix it and try again.
InvalidParameterValue.RuleName The RuleName value does not conform to the specification. Please fix it and try again.
InvalidParameterValue.Tags Incorrect tag parameter
InvalidParameterValue.Type The Type value does not conform to the specification. Please fix it and try again.
LimitExceeded.Rule The Rule quantity has reached the upper limit. You can submit a ticket to increase it.
ResourceNotFound The resource does not exist.
ResourceNotFound.EventBus The specified event bus was not found. Please create it and try again.
ResourceNotFound.Tag The specified tag is not found.
Was this page helpful?
You can also Contact Sales or Submit a Ticket for help.
Yes
No

Feedback

Contact Us

Contact our sales team or business advisors to help your business.

Contact Us
Technical Support

Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

Submit a Ticket
7x24 Phone Support