有奖捉虫:办公协同&微信生态&物联网文档专题 HOT

1. 接口描述

接口请求域名: eb.tencentcloudapi.com 。

创建事件规则

默认接口请求频率限制:20次/秒。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:CreateRule。
Version String 公共参数,本接口取值:2021-04-16。
Region String 公共参数,详见产品支持的 地域列表
EventPattern String 参考:事件模式
示例值:{   "detail": {     "source-ip": [ { "cidr": "10.0.0.0/24" } ]  
EventBusId String 事件集ID。
示例值:eb-xxxxxxxx
RuleName String 事件集名称,只能包含字母、数字、下划线、连字符,以字母开头,以数字或字母结尾,2~60个字符
示例值:rule
Enable Boolean 使能开关。
示例值:true
Description String 事件集描述,不限字符类型,200字符描述以内
示例值:这是一个描述

3. 输出参数

参数名称 类型 描述
RuleId String 事件规则ID
示例值:rule-xxxxxxxx
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 创建过滤规则

输入示例

POST / HTTP/1.1
Host: eb.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateRule
<公共请求参数>

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

输出示例

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

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码

错误码 描述
FailedOperation.TagResource 标签绑定操作失败。
FailedOperation.TagResourceAllocateQuotas 申请标签配额失败。
InvalidParameterValue.DeadLetterConfig 死信队列配置参数取值与规范不符,请修正后再试。
InvalidParameterValue.Description Description取值与规范不符,请修正后再试。
InvalidParameterValue.EventPattern EventPattern取值与规范不符,请修正后再试。
InvalidParameterValue.RuleName RuleName取值与规范不符,请修正后再试。
InvalidParameterValue.Tags 标签参数错误。
InvalidParameterValue.Type Type取值与规范不符,请修正后再试。
LimitExceeded.Rule Rule数量达到限制,可提交工单申请提升限制。
ResourceNotFound 资源不存在。
ResourceNotFound.EventBus 未找到指定事件集,请创建后再试。
ResourceNotFound.Tag 未找到指定标签。