APIGWParams
APIGWParams描述
被如下接口引用：CreateConnection, ListConnections。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Protocol | String | 是 | HTTPS 示例值：HTTPS |
| Method | String | 是 | POST 示例值：POST |
CkafkaDeliveryParams
用来描述需要投递到kafka topic的参数
被如下接口引用：ListRules。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| TopicName | String | 是 | ckafka topic name 示例值：topic-xxxxxx |
| ResourceDescription | String | 是 | ckafka资源qcs六段式 示例值：qcs::ckafka:ap-chongqing:uin/123456:ckafkaId/uin/456789/ckafka-x |
CkafkaParams
Ckafka 连接器参数
被如下接口引用：CreateConnection, ListConnections。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Offset | String | 是 | kafka offset 示例值：latest |
| TopicName | String | 是 | ckafka topic 示例值：topic |
CkafkaTargetParams
用来描述ckafka投递目标
被如下接口引用：CreateTarget。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| TopicName | String | 是 | 要投递到的ckafka topic 示例值：topic-xxxx |
| RetryPolicy | RetryPolicy | 是 | 重试策略 |
Connection
Connection信息
被如下接口引用：ListConnections。
| 名称 | 类型 | 描述 |
|---|---|---|
| Status | String | 状态 示例值：Active |
| ModTime | Timestamp ISO8601 | 更新时间 示例值：2021-04-27T14:34:19+08:00 |
| Enable | Boolean | 使能开关 示例值：true |
| Description | String | 描述 示例值：这是一个描述 |
| AddTime | Timestamp ISO8601 | 创建时间 示例值：2021-04-27T14:34:19+08:00 |
| ConnectionId | String | 连接器ID 示例值：connection-xxxxxxxx |
| EventBusId | String | 事件集ID 示例值：eb-xxxxxxxx |
| ConnectionDescription | ConnectionDescription | 连接器描述 |
| ConnectionName | String | 连接器名称 示例值：connection |
| Type | String | 类型 示例值：apigw |
ConnectionBrief
连接器基础信息
被如下接口引用：ListEventBuses。
| 名称 | 类型 | 描述 |
|---|---|---|
| Type | String | 连接器类型 注意：此字段可能返回 null，表示取不到有效值。 示例值：tdmq |
| Status | String | 连接器状态 注意：此字段可能返回 null，表示取不到有效值。 示例值：Normal |
ConnectionDescription
ConnectionDescription描述
被如下接口引用：CreateConnection, ListConnections。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| ResourceDescription | String | 是 | 资源qcs六段式，更多参考 资源六段式 示例值：qcs::apigw:ap-guangzhou:uin/0000000:serviceid/service-id |
| APIGWParams | APIGWParams | 否 | apigw参数 注意：此字段可能返回 null，表示取不到有效值。 |
| CkafkaParams | CkafkaParams | 否 | ckafka参数 注意：此字段可能返回 null，表示取不到有效值。 |
| DTSParams | DTSParams | 否 | data transfer service (DTS)参数 注意：此字段可能返回 null，表示取不到有效值。 |
| TDMQParams | TDMQParams | 否 | tdmq参数 注意：此字段可能返回 null，表示取不到有效值。 |
DTSParams
Data Transfer Service参数
被如下接口引用：CreateConnection, ListConnections。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| ConsumerGroupName | String | 是 | Consumer Group Name 示例值：consumer-grp-subs-abcde12345-consumer-group-name |
| Account | String | 是 | 账户名 示例值：user-account |
| Password | String | 是 | 密码 注意：此字段可能返回 null，表示取不到有效值。 示例值：user-pwd |
DeadLetterConfig
rule对应的dlq配置
被如下接口引用：ListRules。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| DisposeMethod | String | 是 | 支持dlq、丢弃、忽略错误继续传递三种模式, 分别对应: DLQ,DROP,IGNORE_ERROR 示例值：DLQ |
| CkafkaDeliveryParams | CkafkaDeliveryParams | 否 | 设置了DLQ方式后,此选项必填. 错误消息会被投递到对应的kafka topic中 注意：此字段可能返回 null，表示取不到有效值。 |
ESTargetParams
描述Es规则目标
被如下接口引用：CreateTarget。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| NetMode | String | 是 | 网络连接类型 注意：此字段可能返回 null，表示取不到有效值。 示例值：privatelink |
| IndexPrefix | String | 是 | 索引前缀 注意：此字段可能返回 null，表示取不到有效值。 示例值：esindex |
| RotationInterval | String | 是 | es日志轮换粒度 注意：此字段可能返回 null，表示取不到有效值。 示例值：none |
| OutputMode | String | 是 | DTS事件配置 注意：此字段可能返回 null，表示取不到有效值。 示例值：default |
| IndexSuffixMode | String | 是 | DTS索引配置 注意：此字段可能返回 null，表示取不到有效值。 示例值：default |
| IndexTemplateType | String | 否 | es模版类型 注意：此字段可能返回 null，表示取不到有效值。 示例值：_type |
EtlFilter
描述如何过滤数据
被如下接口引用：CheckTransformation, CreateTransformation, GetTransformation, UpdateTransformation。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Filter | String | 是 | 语法Rule规则保持一致 示例值："{"source":"ckafka.cloud.tencent"}" |
Event
eb event信息
被如下接口引用：PublishEvent, PutEvents。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Source | String | 是 | 事件源的信息,新产品上报必须符合EB的规范 示例值：cvm.cloud.tencent |
| Data | String | 是 | 事件数据，内容由创建事件的系统来控制，当前datacontenttype仅支持application/json;charset=utf-8，所以该字段是json字符串 示例值："{"a":"b","c":"d","e":1}" |
| Type | String | 是 | 事件类型，可自定义，选填。云服务默认写 COS:Created:PostObject，用“：”分割类型字段 示例值：cvm:ErrorEvent:PingUnreachable |
| Subject | String | 是 | 事件来源详细描述，可自定义，选填。云服务默认为标准qcs资源表示语法：qcs::dts:ap-guangzhou:appid/uin:xxx 示例值：qcs::dts:ap-guangzhou:appid/uin:xxx |
| Time | Integer | 否 | 事件发生的毫秒时间戳， time.Now().UnixNano()/1e6 示例值：1631186355147 |
| Region | String | 否 | 事件的地域信息，没有则默认是EB所在的地域信息 示例值：ap-chengdu |
| Status | String | 否 | 用于描述事件状态，非必须，默认是"" 示例值："-" |
| Id | String | 否 | 事件的唯一id，用户侧主动上传则需要保证风格一致 示例值：13a3f42d-7258-4ada-da6d-023a333b4662 |
| TagList | Array of Tag | 否 | 标签列表 示例值：[{"Key":"k1", "Value":"v1"}] |
EventBus
事件集信息
被如下接口引用：ListEventBuses。
| 名称 | 类型 | 描述 |
|---|---|---|
| ModTime | Timestamp ISO8601 | 更新时间 示例值：2021-04-27T14:34:19+08:00 |
| Description | String | 事件集描述，不限字符类型，200字符描述以内 示例值：这是一个描述 |
| AddTime | Timestamp ISO8601 | 创建时间 示例值：2021-04-27T14:34:19+08:00 |
| EventBusName | String | 事件集名称，只能包含字母、数字、下划线、连字符，以字母开头，以数字或字母结尾，2~60个字符 示例值：EventBus |
| EventBusId | String | 事件集ID 示例值：eb-xxxxxxxx |
| Type | String | 事件集类型 示例值：Cloud |
| PayMode | String | 计费模式 注意：此字段可能返回 null，表示取不到有效值。 示例值：Postpaid(后付费) |
| ConnectionBriefs | Array of ConnectionBrief | 连接器基础信息 注意：此字段可能返回 null，表示取不到有效值。 |
| TargetBriefs | Array of TargetBrief | 目标简要信息 注意：此字段可能返回 null，表示取不到有效值。 |
Extraction
描述如何提取数据
被如下接口引用：CheckTransformation, CreateTransformation, GetTransformation, UpdateTransformation。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| ExtractionInputPath | String | 是 | JsonPath, 不指定则使用默认值$. 示例值：$ |
| Format | String | 是 | 取值: TEXT/JSON 示例值：TEXT |
| TextParams | TextParams | 否 | 仅在Text需要传递 注意：此字段可能返回 null，表示取不到有效值。 |
Filter
描述键值对过滤器，用于条件过滤查询。例如过滤ID、名称、状态等
- 若存在多个Filter时，Filter间的关系为逻辑与（AND）关系。
- 若同一个Filter存在多个Values，同一Filter下Values间的关系为逻辑或（OR）关系。
被如下接口引用：ListEventBuses。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Values | Array of String | 是 | 一个或者多个过滤值。 示例值：Cloud |
| Name | String | 是 | 过滤键的名称。EventBusName(事件集名称)/EventBusId(事件集Id)/Type(事件集类型:Cloud(云服务);Platform(平台型);Custom(自定义))/TagKey(标签键) 示例值：Type |
LogFilter
日志查询相关接口filter参数定义
被如下接口引用：DescribeLogTagValue, SearchLog。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Key | String | 否 | 过滤字段名称 示例值：status |
| Operator | String | 否 | 运算符，全等 eq，不等 neq，相似 like，排除相似 not like, 小于 lt，小于且等于 lte，大于 gt，大于且等于 gte，在范围内 range，不在范围内 norange 示例值：eq |
| Value | String | 否 | 过滤值,范围运算需要同时输入两个值，以英文逗号分隔 示例值："0" |
| Type | String | 否 | 该层级filters逻辑关系，取值 "AND" 或 "OR" 示例值：AND |
| Filters | Array of LogFilters | 否 | LogFilters数组 |
LogFilters
日志存储过滤条件
被如下接口引用：DescribeLogTagValue, SearchLog。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Key | String | 是 | 过滤字段名称，取值范围如下:region(地域)，type(事件类型)，source(事件源)，status(事件状态) 示例值：status |
| Operator | String | 是 | 运算符, 全等 eq，不等 neq，相似 like，排除相似 not like, 小于 lt，小于且等于 lte，大于 gt，大于且等于 gte，在范围内 range，不在范围内 norange 示例值：eq |
| Value | String | 是 | 过滤值，范围运算需要同时输入两个值，以英文逗号分隔 示例值："0" |
OutputStructParam
Transform输出参数
被如下接口引用：CheckTransformation, CreateTransformation, GetTransformation, UpdateTransformation。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Key | String | 是 | 对应输出json中的key 示例值：name |
| Value | String | 是 | 可以填json-path也可以支持常量或者内置关键字date类型 示例值：$.name |
| ValueType | String | 是 | value的数据类型, 可选值: STRING, NUMBER,BOOLEAN,NULL,SYS_VARIABLE,JSONPATH 示例值：JSONPATH |
PlatformEventDetail
平台事件名称
被如下接口引用：ListPlatformEventNames。
| 名称 | 类型 | 描述 |
|---|---|---|
| EventName | String | 事件名称 注意：此字段可能返回 null，表示取不到有效值。 |
| EventType | String | 事件类型 注意：此字段可能返回 null，表示取不到有效值。 |
PlatformEventSummary
平台事件匹配规则
被如下接口引用：ListPlatformEventPatterns。
| 名称 | 类型 | 描述 |
|---|---|---|
| EventName | String | 平台事件名称 注意：此字段可能返回 null，表示取不到有效值。 |
| EventPattern | String | 平台事件匹配规则 注意：此字段可能返回 null，表示取不到有效值。 |
PlatformProduct
平台产品基础信息
被如下接口引用：ListPlatformProducts。
| 名称 | 类型 | 描述 |
|---|---|---|
| ProductName | String | 平台产品名称 |
| ProductType | String | 平台产品类型 |
RetryPolicy
用来描述一个ckafka投递目标的重试策略
被如下接口引用：CreateTarget。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| RetryInterval | Integer | 是 | 重试间隔 单位:秒 示例值：30 |
| MaxRetryAttempts | Integer | 是 | 最大重试次数 示例值：3 |
Rule
规则信息
被如下接口引用：ListRules。
| 名称 | 类型 | 描述 |
|---|---|---|
| Status | String | 状态 示例值：Active |
| ModTime | Timestamp ISO8601 | 修改时间 示例值：2021-04-27T14:34:19+08:00 |
| Enable | Boolean | 使能开关 示例值：true |
| Description | String | 描述 示例值：这是一个描述 |
| RuleId | String | 规则ID 示例值：rule-xxxxxxxx |
| AddTime | Timestamp ISO8601 | 创建时间 示例值：2021-04-27T14:34:19+08:00 |
| EventBusId | String | 事件集ID 示例值：eb-xxxxxxxx |
| RuleName | String | 规则名称 示例值：rule |
| Targets | Array of TargetBrief | Target 简要信息 注意：此字段可能返回 null，表示取不到有效值。 |
| DeadLetterConfig | DeadLetterConfig | rule设置的dlq规则. 可能为null 注意：此字段可能返回 null，表示取不到有效值。 |
SCFParams
云函数参数
被如下接口引用：CreateTarget。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| BatchTimeout | Integer | 否 | 批量投递最长等待时间 注意：此字段可能返回 null，表示取不到有效值。 示例值：1 |
| BatchEventCount | Integer | 否 | 批量投递最大事件条数 注意：此字段可能返回 null，表示取不到有效值。 示例值：1 |
| EnableBatchDelivery | Boolean | 否 | 开启批量投递使能 注意：此字段可能返回 null，表示取不到有效值。 示例值：false |
SearchLogResult
日志检索详情
被如下接口引用：SearchLog。
| 名称 | 类型 | 描述 |
|---|---|---|
| Timestamp | String | 单条日志上报时间 注意：此字段可能返回 null，表示取不到有效值。 |
| Message | String | 日志内容详情 注意：此字段可能返回 null，表示取不到有效值。 |
| Source | String | 事件来源 注意：此字段可能返回 null，表示取不到有效值。 |
| Type | String | 事件类型 注意：此字段可能返回 null，表示取不到有效值。 |
| RuleIds | String | 事件匹配规则 注意：此字段可能返回 null，表示取不到有效值。 示例值：rule-xxxx |
| Subject | String | 实例ID 注意：此字段可能返回 null，表示取不到有效值。 示例值：ins-xxxx |
| Region | String | 地域 注意：此字段可能返回 null，表示取不到有效值。 示例值：ap-guangzhou |
| Status | String | 事件状态 注意：此字段可能返回 null，表示取不到有效值。 |
TDMQParams
TDMQ参数详情
被如下接口引用：CreateConnection, ListConnections。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| ClusterType | String | 否 | 集群类型 注意：此字段可能返回 null，表示取不到有效值。 示例值：default:虚拟集群; exclusive:专业集群 |
| ClusterEndPoint | String | 否 | 集群支撑网接入点 注意：此字段可能返回 null，表示取不到有效值。 |
Tag
事件总线资源标签
被如下接口引用：PublishEvent, PutEvents。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Key | String | 是 | 标签名称 示例值：Key |
| Value | String | 是 | 标签值 示例值：Value |
Target
Target信息
被如下接口引用：ListTargets。
| 名称 | 类型 | 描述 |
|---|---|---|
| Type | String | 目标类型 示例值：scf |
| EventBusId | String | 事件集ID 示例值：eb-xxxxxxxx |
| TargetId | String | 目标ID 示例值：target-xxxxxxxx |
| TargetDescription | TargetDescription | 目标描述 |
| RuleId | String | 事件规则ID 示例值：rule-xxxxxxxx |
| EnableBatchDelivery | Boolean | 开启批量投递使能 注意：此字段可能返回 null，表示取不到有效值。 示例值：false |
| BatchTimeout | Integer | 批量投递最长等待时间 注意：此字段可能返回 null，表示取不到有效值。 示例值：1 |
| BatchEventCount | Integer | 批量投递最大事件条数 注意：此字段可能返回 null，表示取不到有效值。 示例值：1 |
TargetBrief
目标简要信息
被如下接口引用：ListEventBuses, ListRules。
| 名称 | 类型 | 描述 |
|---|---|---|
| TargetId | String | 目标ID 示例值：target-xxxxxxxx |
| Type | String | 目标类型 示例值：scf |
TargetDescription
TargetDescription描述
被如下接口引用：CreateTarget, ListTargets。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| ResourceDescription | String | 是 | QCS资源六段式，更多参考 资源六段式；scf资源六段式示例[qcs::scf:ap-guangzhou:uin/123:namespace/test(函数命名空间)/function/test(函数名)/$LATEST(函数版本)] amp资源六段式示例[qcs::eb-amp:ap-guangzhou:uin/123:] ckafka资源六段式示例[qcs::ckafka:ap-guangzhou:uin/123:ckafkaId/uin/123/ckafka-123(ckafka实例Id)] cls资源六段式示例[qcs::cls:ap-guangzhou:uin/123:topic/122332442(topicId)] es资源六段式示例[qcs::es:ap-guangzhou:appid/123/uin/456:instance/es-7cplmhsd(es实例Id)] 示例值：qcs::es:ap-guangzhou:uin/1500000688:instance/es-7cplmhsd |
| SCFParams | SCFParams | 否 | 云函数参数 |
| CkafkaTargetParams | CkafkaTargetParams | 否 | Ckafka参数 |
| ESTargetParams | ESTargetParams | 否 | ElasticSearch参数 |
TextParams
描述如何切分数据
被如下接口引用：CheckTransformation, CreateTransformation, GetTransformation, UpdateTransformation。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Separator | String | 否 | 逗号、| 、制表符、空格、换行符、%、#，限制长度为 1。 注意：此字段可能返回 null，表示取不到有效值。 示例值：, |
| Regex | String | 否 | 填写正则表达式：长度128 注意：此字段可能返回 null，表示取不到有效值。 示例值：a(.*)bc |
Transform
描述如何数据转换
被如下接口引用：CheckTransformation, CreateTransformation, GetTransformation, UpdateTransformation。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| OutputStructs | Array of OutputStructParam | 是 | 描述如何数据转换 |
Transformation
一个转换器
被如下接口引用：CheckTransformation, CreateTransformation, GetTransformation, UpdateTransformation。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Extraction | Extraction | 否 | 描述如何提取数据，{"ExtractionInputPath":"$.data.payload","Format":"JSON"} 注意：此字段可能返回 null，表示取不到有效值。 示例值：{"ExtractionInputPath":"$.data.payload","Format":"JSON"} |
| EtlFilter | EtlFilter | 否 | 描述如何过滤数据;{"Filter":"{"source":"ckafka.cloud.tencent"}"} 注意：此字段可能返回 null，表示取不到有效值。 示例值：{"Filter":"{"source":"ckafka.cloud.tencent"}"} |
| Transform | Transform | 否 | 描述如何数据转换;"OutputStructs":[{"Key":"op","Value":"$.op","ValueType":"JSONPATH"}] 注意：此字段可能返回 null，表示取不到有效值。 示例值："OutputStructs":[{"Key":"op","Value":"$.op","ValueType":"JSONPATH"}] |
