tencent cloud

Event Bridge

Release Notes and Announcements
Release Notes
[July 19, 2024] Solution to CLS Billing Issues for EB Topics
User Tutorial
Product Introduction
Overview
Basic Concepts
Strengths
Use Cases
Limits
Purchase Guide
Billing Overview
Product Pricing
Overdue Payments and Service Suspension
Getting Started
Activating EventBridge
Quickly Delivering Custom Events
Quickly Configuring Cloud Monitor Event Alarm Push
Quickly Configuring Cloud Monitor Event Alarm Push
Event Source
Overview
Tencent Cloud Service Event Source
Event Structure
Connector
Event
Event Structure
Custom Event
Tencent Cloud Service Event
Event Bus
Overview
Creating Event Bus
Managing Event Bus
Linkage Tracing
Event Rule
Overview
Event Pattern
Creating Event Rule
Managing Event Rule
Configuring Data Conversion
Event Target
SCF Target
CLS Log Target
Message Push Target
CKafka Target
Practical Tutorial
Migrating Event Alarm
Real-Time Oceanus Alarm Message Push
Automatic Backup and Restart of Exceptional CVM Instance
Planning a EventBridge-based Midplatform for a Retail Business
API Documentation
History
Introduction
API Category
Making API Requests
Delivery Target APIs
Event Bus APIs
Event Rule APIs
Event Connector APIs
Data Transformer APIs
Event Storage APIs
Data Types
Error Codes
FAQs
Concept
Alarm
Billing
Contact Us
EB Policy
Privacy Policy
Data Processing And Security Agreement

CheckRule

PDF
Focus Mode
Font Size
Last updated: 2026-03-26 22:25:50

1. API Description

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

This API is used to check a 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: CheckRule.
Version Yes String Common Params. The value used for this API: 2021-04-16.
Region Yes String Common Params. For more information, please see the list of regions supported by the product. This API only supports: ap-beijing, ap-chengdu, ap-chongqing, ap-guangzhou, ap-hongkong, ap-shanghai, ap-singapore, na-siliconvalley.
Event Yes String Event Information
EventPattern Yes String EventPattern Information

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 Checking rules

Input Example

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

{}

Output Example

{
    "Response": {
        "RequestId": "eac6b301-a322-493a-8e36-83b295459397"
    }
}

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.ErrorFilter The rule does not match with the event. Please modify and try again.
InternalError Internal error.
InternalError.System Service error. Please try again. If the problem persists, please submit a ticket.
InternalError.UnknownInternalError Unknown error.
InvalidParameter Parameter error.
InvalidParameterValue.InvalidFilterRule Invalid event mode format. Please check and try again.
InvalidParameterValue.InvalidPattern Invalid matching rules. Please check and try again.

Help and Support

Was this page helpful?

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

Feedback