tenyun/types/eb.d.ts

Promise based and chained Tencent Cloud OpenAPI client for NodeJS

/// <reference types="node" />

import { AxiosPromise, AxiosRequestConfig } from "axios";

/** APIGWParams描述 */
declare interface APIGWParams {
  /** HTTPS */
  Protocol: string;
  /** POST */
  Method: string;
}

/** 用来描述需要投递到kafka topic的参数 */
declare interface CkafkaDeliveryParams {
  /** ckafka topic name */
  TopicName: string;
  /** ckafka资源qcs六段式 */
  ResourceDescription: string;
}

/** Ckafka 连接器参数 */
declare interface CkafkaParams {
  /** kafka offset */
  Offset: string;
  /** ckafka topic */
  TopicName: string;
}

/** 用来描述ckafka投递目标 */
declare interface CkafkaTargetParams {
  /** 要投递到的ckafka topic */
  TopicName: string;
  /** 重试策略 */
  RetryPolicy: RetryPolicy;
}

/** Connection信息 */
declare interface Connection {
  /** 状态 */
  Status: string;
  /** 更新时间 */
  ModTime: string;
  /** 使能开关 */
  Enable: boolean;
  /** 描述 */
  Description: string;
  /** 创建时间 */
  AddTime: string;
  /** 连接器ID */
  ConnectionId: string;
  /** 事件集ID */
  EventBusId: string;
  /** 连接器描述 */
  ConnectionDescription: ConnectionDescription;
  /** 连接器名称 */
  ConnectionName: string;
  /** 类型 */
  Type: string;
}

/** 连接器基础信息 */
declare interface ConnectionBrief {
  /** 连接器类型 */
  Type?: string | null;
  /** 连接器状态 */
  Status?: string | null;
}

/** ConnectionDescription描述 */
declare interface ConnectionDescription {
  /** 资源qcs六段式，更多参考 [资源六段式](https://cloud.tencent.com/document/product/598/10606) */
  ResourceDescription: string;
  /** apigw参数 */
  APIGWParams?: APIGWParams | null;
  /** ckafka参数 */
  CkafkaParams?: CkafkaParams | null;
  /** data transfer service (DTS)参数 */
  DTSParams?: DTSParams | null;
  /** tdmq参数 */
  TDMQParams?: TDMQParams | null;
}

/** Data Transfer Service参数 */
declare interface DTSParams {
  /** Consumer Group Name */
  ConsumerGroupName: string;
  /** 账户名 */
  Account: string;
  /** 密码 */
  Password: string | null;
}

/** rule对应的dlq配置 */
declare interface DeadLetterConfig {
  /** 支持dlq、丢弃、忽略错误继续传递三种模式, 分别对应: DLQ,DROP,IGNORE_ERROR */
  DisposeMethod: string;
  /** 设置了DLQ方式后,此选项必填. 错误消息会被投递到对应的kafka topic中 */
  CkafkaDeliveryParams?: CkafkaDeliveryParams | null;
}

/** 描述Es规则目标 */
declare interface ESTargetParams {
  /** 网络连接类型 */
  NetMode: string | null;
  /** 索引前缀 */
  IndexPrefix: string | null;
  /** es日志轮换粒度 */
  RotationInterval: string | null;
  /** DTS事件配置 */
  OutputMode: string | null;
  /** DTS索引配置 */
  IndexSuffixMode: string | null;
  /** es模版类型 */
  IndexTemplateType?: string | null;
}

/** 描述如何过滤数据 */
declare interface EtlFilter {
  /** 语法Rule规则保持一致 */
  Filter: string;
}

/** eb event信息 */
declare interface Event {
  /** 事件源的信息,新产品上报必须符合EB的规范 */
  Source: string;
  /** 事件数据，内容由创建事件的系统来控制，当前datacontenttype仅支持application/json;charset=utf-8，所以该字段是json字符串 */
  Data: string;
  /** 事件类型，可自定义，选填。云服务默认写 COS:Created:PostObject，用“：”分割类型字段 */
  Type: string;
  /** 事件来源详细描述，可自定义，选填。云服务默认为标准qcs资源表示语法：qcs::dts:ap-guangzhou:appid/uin:xxx */
  Subject: string;
  /** 事件发生的毫秒时间戳，time.Now().UnixNano()/1e6 */
  Time?: number;
  /** 事件的地域信息，没有则默认是EB所在的地域信息 */
  Region?: string;
  /** 用于描述事件状态，非必须，默认是"" */
  Status?: string;
  /** 事件的唯一id，用户侧主动上传则需要保证风格一致 */
  Id?: string;
  /** 标签列表 */
  TagList?: Tag[];
}

/** 事件集信息 */
declare interface EventBus {
  /** 更新时间 */
  ModTime: string;
  /** 事件集描述，不限字符类型，200字符描述以内 */
  Description: string;
  /** 创建时间 */
  AddTime: string;
  /** 事件集名称，只能包含字母、数字、下划线、连字符，以字母开头，以数字或字母结尾，2~60个字符 */
  EventBusName: string;
  /** 事件集ID */
  EventBusId: string;
  /** 事件集类型 */
  Type: string;
  /** 计费模式 */
  PayMode?: string | null;
  /** 连接器基础信息 */
  ConnectionBriefs?: ConnectionBrief[] | null;
  /** 目标简要信息 */
  TargetBriefs?: TargetBrief[] | null;
}

/** 描述如何提取数据 */
declare interface Extraction {
  /** JsonPath, 不指定则使用默认值$. */
  ExtractionInputPath: string;
  /** 取值: TEXT/JSON */
  Format: string;
  /** 仅在Text需要传递 */
  TextParams?: TextParams | null;
}

/** 描述键值对过滤器，用于条件过滤查询。例如过滤ID、名称、状态等* 若存在多个Filter时，Filter间的关系为逻辑与（AND）关系。* 若同一个Filter存在多个Values，同一Filter下Values间的关系为逻辑或（OR）关系。 */
declare interface Filter {
  /** 一个或者多个过滤值。 */
  Values: string[];
  /** 过滤键的名称。EventBusName(事件集名称)/EventBusId(事件集Id)/Type(事件集类型:Cloud(云服务);Platform(平台型);Custom(自定义))/TagKey(标签键) */
  Name: string;
}

/** 日志查询相关接口filter参数定义 */
declare interface LogFilter {
  /** 过滤字段名称 */
  Key?: string | null;
  /** 运算符，全等 eq，不等 neq，相似 like，排除相似 not like, 小于 lt，小于且等于 lte，大于 gt，大于且等于 gte，在范围内 range，不在范围内 norange */
  Operator?: string | null;
  /** 过滤值,范围运算需要同时输入两个值，以英文逗号分隔 */
  Value?: string | null;
  /** 该层级filters逻辑关系，取值 "AND" 或 "OR" */
  Type?: string | null;
  /** LogFilters数组 */
  Filters?: LogFilters[] | null;
}

/** 日志存储过滤条件 */
declare interface LogFilters {
  /** 过滤字段名称，取值范围如下:region(地域)，type(事件类型)，source(事件源)，status(事件状态) */
  Key: string;
  /** 运算符, 全等 eq，不等 neq，相似 like，排除相似 not like, 小于 lt，小于且等于 lte，大于 gt，大于且等于 gte，在范围内 range，不在范围内 norange */
  Operator: string;
  /** 过滤值，范围运算需要同时输入两个值，以英文逗号分隔 */
  Value: string;
}

/** Transform输出参数 */
declare interface OutputStructParam {
  /** 对应输出json中的key */
  Key: string;
  /** 可以填json-path也可以支持常量或者内置关键字date类型 */
  Value: string;
  /** value的数据类型, 可选值: STRING, NUMBER,BOOLEAN,NULL,SYS_VARIABLE,JSONPATH */
  ValueType: string;
}

/** 平台事件名称 */
declare interface PlatformEventDetail {
  /** 事件名称 */
  EventName?: string | null;
  /** 事件类型 */
  EventType?: string | null;
}

/** 平台事件匹配规则 */
declare interface PlatformEventSummary {
  /** 平台事件名称 */
  EventName?: string | null;
  /** 平台事件匹配规则 */
  EventPattern?: string | null;
}

/** 平台产品基础信息 */
declare interface PlatformProduct {
  /** 平台产品名称 */
  ProductName?: string;
  /** 平台产品类型 */
  ProductType?: string;
}

/** 用来描述一个ckafka投递目标的重试策略 */
declare interface RetryPolicy {
  /** 重试间隔 单位:秒 */
  RetryInterval: number;
  /** 最大重试次数 */
  MaxRetryAttempts: number;
}

/** 规则信息 */
declare interface Rule {
  /** 状态 */
  Status?: string;
  /** 修改时间 */
  ModTime?: string;
  /** 使能开关 */
  Enable?: boolean;
  /** 描述 */
  Description?: string;
  /** 规则ID */
  RuleId?: string;
  /** 创建时间 */
  AddTime?: string;
  /** 事件集ID */
  EventBusId?: string;
  /** 规则名称 */
  RuleName?: string;
  /** Target 简要信息 */
  Targets?: TargetBrief[] | null;
  /** rule设置的dlq规则. 可能为null */
  DeadLetterConfig?: DeadLetterConfig | null;
}

/** 云函数参数 */
declare interface SCFParams {
  /** 批量投递最长等待时间 */
  BatchTimeout?: number | null;
  /** 批量投递最大事件条数 */
  BatchEventCount?: number | null;
  /** 开启批量投递使能 */
  EnableBatchDelivery?: boolean | null;
}

/** 日志检索详情 */
declare interface SearchLogResult {
  /** 单条日志上报时间 */
  Timestamp?: string | null;
  /** 日志内容详情 */
  Message?: string | null;
  /** 事件来源 */
  Source?: string | null;
  /** 事件类型 */
  Type?: string | null;
  /** 事件匹配规则 */
  RuleIds?: string | null;
  /** 实例ID */
  Subject?: string | null;
  /** 地域 */
  Region?: string | null;
  /** 事件状态 */
  Status?: string | null;
}

/** TDMQ参数详情 */
declare interface TDMQParams {
  /** 集群类型 */
  ClusterType?: string | null;
  /** 集群支撑网接入点 */
  ClusterEndPoint?: string | null;
}

/** 事件总线资源标签 */
declare interface Tag {
  /** 标签名称 */
  Key: string;
  /** 标签值 */
  Value: string;
}

/** Target信息 */
declare interface Target {
  /** 目标类型 */
  Type?: string;
  /** 事件集ID */
  EventBusId?: string;
  /** 目标ID */
  TargetId?: string;
  /** 目标描述 */
  TargetDescription?: TargetDescription;
  /** 事件规则ID */
  RuleId?: string;
  /** 开启批量投递使能 */
  EnableBatchDelivery?: boolean | null;
  /** 批量投递最长等待时间 */
  BatchTimeout?: number | null;
  /** 批量投递最大事件条数 */
  BatchEventCount?: number | null;
}

/** 目标简要信息 */
declare interface TargetBrief {
  /** 目标ID */
  TargetId: string;
  /** 目标类型 */
  Type: string;
}

/** TargetDescription描述 */
declare interface TargetDescription {
  /** QCS资源六段式，更多参考 [资源六段式](https://cloud.tencent.com/document/product/598/10606)；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)] */
  ResourceDescription: string;
  /** 云函数参数 */
  SCFParams?: SCFParams;
  /** Ckafka参数 */
  CkafkaTargetParams?: CkafkaTargetParams;
  /** ElasticSearch参数 */
  ESTargetParams?: ESTargetParams;
}

/** 描述如何切分数据 */
declare interface TextParams {
  /** 逗号、| 、制表符、空格、换行符、%、#，限制长度为 1。 */
  Separator?: string | null;
  /** 填写正则表达式：长度128 */
  Regex?: string | null;
}

/** 描述如何数据转换 */
declare interface Transform {
  /** 描述如何数据转换 */
  OutputStructs: OutputStructParam[];
}

/** 一个转换器 */
declare interface Transformation {
  /** 描述如何提取数据，{"ExtractionInputPath":"$.data.payload","Format":"JSON"} */
  Extraction?: Extraction | null;
  /** 描述如何过滤数据;{"Filter":"{\"source\":\"ckafka.cloud.tencent\"}"} */
  EtlFilter?: EtlFilter | null;
  /** 描述如何数据转换;"OutputStructs":[{"Key":"op","Value":"$.op","ValueType":"JSONPATH"}] */
  Transform?: Transform | null;
}

declare interface CheckRuleRequest {
  /** Event信息 */
  Event: string;
  /** EventPattern信息 */
  EventPattern: string;
}

declare interface CheckRuleResponse {
  /** 唯一请求 ID，每次请求都会返回。 */
  RequestId?: string;
}

declare interface CheckTransformationRequest {
  /** 待处理的json字符串 */
  Input: string;
  /** 一个转换规则列表 */
  Transformations: Transformation[];
}

declare interface CheckTransformationResponse {
  /** 经过Transformations处理之后的数据 */
  Output?: string;
  /** 唯一请求 ID，每次请求都会返回。 */
  RequestId?: string;
}

declare interface CreateConnectionRequest {
  /** 连接器描述 */
  ConnectionDescription: ConnectionDescription;
  /** 事件集ID */
  EventBusId: string;
  /** 连接器名称 */
  ConnectionName: string;
  /** 描述 */
  Description?: string;
  /** 使能开关 */
  Enable?: boolean;
  /** 连接器类型，目前支持以下类型:apigw/ckafka/dts/tdmq */
  Type?: string;
}

declare interface CreateConnectionResponse {
  /** 连接器ID */
  ConnectionId?: string;
  /** 唯一请求 ID，每次请求都会返回。 */
  RequestId?: string;
}

declare interface CreateEventBusRequest {
  /** 事件集名称，只能包含字母、中文、数字、下划线、连字符，以字母/中文开头，以数字、字母或中文结尾，2~60个字符 */
  EventBusName: string;
  /** 事件集描述，只能包含数字、中英文及常用标点符号，不超过200个字符 */
  Description?: string;
  /** EB存储时长 */
  SaveDays?: number;
  /** EB是否开启存储 */
  EnableStore?: boolean;
}

declare interface CreateEventBusResponse {
  /** 事件集ID */
  EventBusId?: string;
  /** 唯一请求 ID，每次请求都会返回。 */
  RequestId?: string;
}

declare interface CreateRuleRequest {
  /** 参考：[事件模式](https://cloud.tencent.com/document/product/1359/56084) */
  EventPattern: string;
  /** 事件集ID */
  EventBusId: string;
  /** 事件规则名称，只能包含字母、中文、数字、下划线、连字符，以字母/中文开头，以数字、字母或中文结尾，2~60个字符 */
  RuleName: string;
  /** 使能开关。 */
  Enable?: boolean;
  /** 事件规则描述，只能包含数字、中英文及常用标点符号，不超过200个字符 */
  Description?: string;
}

declare interface CreateRuleResponse {
  /** 事件规则ID */
  RuleId?: string;
  /** 唯一请求 ID，每次请求都会返回。 */
  RequestId?: string;
}

declare interface CreateTargetRequest {
  /** 事件集ID */
  EventBusId: string;
  /** 目标类型;取值范围:scf(云函数)/cls(日志服务)/amp(消息推送)/ckafka(消息推送)/es(大数据elastic-search) */
  Type: string;
  /** 目标描述;scf类型示例:{"ResourceDescription":"qcs::scf:ap-guangzhou:uin/2252646423:namespace/default/function/john-test-0326/$LATEST"};cls类型示例:{"ResourceDescription":"qcs::cls:ap-guangzhou:uin/12323442323:topic/7103f705-6c38-4b64-ac9d-428af0f2e732"}ckafka类型示例:{"ResourceDescription":"qcs::ckafka:ap-guangzhou:uin/1500000688:ckafkaId/uin/1500000688/ckafka-018q1nwj","CkafkaTargetParams":{"TopicName":"alert","RetryPolicy":{"RetryInterval":60,"MaxRetryAttempts":360}}}amp类型-邮件/短信示例:{"ResourceDescription":"qcs::eb-amp:ap-guangzhou:uin/100012505002:","AMPParams":{"NotificationTemplateId":10181,"Lang":"cn","NoticeReceivers":[{"UserType":"User","UserIds":["9424525"],"TimeWindow":{"From":"09:30:00","To":"23:30:00"},"Channels":["Email","SMS"]}]}}es类型示例:{"ResourceDescription":"qcs::es:ap-guangzhou:uin/1500000688:instance/es-7cplmhsd","ESTargetParams":{"EsVersion":"7.14.2","UserName":"elastic","Password":"xxxxx","NetMode":"privateLink","IndexPrefix":"auto-test","IndexSuffixMode":"default","RotationInterval":"none","IndexTemplateType":"","OutputMode":"default"}} */
  TargetDescription: TargetDescription;
  /** 事件规则ID */
  RuleId: string;
}

declare interface CreateTargetResponse {
  /** 目标ID */
  TargetId?: string;
  /** 唯一请求 ID，每次请求都会返回。 */
  RequestId?: string;
}

declare interface CreateTransformationRequest {
  /** 事件总线 id */
  EventBusId: string;
  /** 规则id */
  RuleId: string;
  /** 一个转换规则列表，当前仅限定一个;示例如下：[{"Extraction":{"ExtractionInputPath":"$.data.payload","Format":"JSON"},"EtlFilter":{"Filter":"{\"source\":\"ckafka.cloud.tencent\"}"},"Transform":{"OutputStructs":[{"Key":"op","Value":"$.op","ValueType":"JSONPATH"},{"Key":"table","Value":"$.source.table","ValueType":"JSONPATH"},{"Key":"id","Value":"$.after.id","ValueType":"JSONPATH"},{"Key":"app_id","Value":"$.after.app_id","ValueType":"JSONPATH"},{"Key":"spu_id","Value":"$.after.spu_id","ValueType":"JSONPATH"}]}}] */
  Transformations: Transformation[];
}

declare interface CreateTransformationResponse {
  /** 生成的转换器id */
  TransformationId?: string;
  /** 唯一请求 ID，每次请求都会返回。 */
  RequestId?: string;
}

declare interface DeleteConnectionRequest {
  /** 连接器ID */
  ConnectionId: string;
  /** 事件集ID */
  EventBusId: string;
}

declare interface DeleteConnectionResponse {
  /** 唯一请求 ID，每次请求都会返回。 */
  RequestId?: string;
}

declare interface DeleteEventBusRequest {
  /** 事件集ID */
  EventBusId: string;
}

declare interface DeleteEventBusResponse {
  /** 唯一请求 ID，每次请求都会返回。 */
  RequestId?: string;
}

declare interface DeleteRuleRequest {
  /** 事件集ID */
  EventBusId: string;
  /** 事件规则ID */
  RuleId: string;
}

declare interface DeleteRuleResponse {
  /** 唯一请求 ID，每次请求都会返回。 */
  RequestId?: string;
}

declare interface DeleteTargetRequest {
  /** 事件集ID */
  EventBusId: string;
  /** 事件目标ID */
  TargetId: string;
  /** 事件规则ID */
  RuleId: string;
}

declare interface DeleteTargetResponse {
  /** 唯一请求 ID，每次请求都会返回。 */
  RequestId?: string;
}

declare interface DeleteTransformationRequest {
  /** 事件集ID */
  EventBusId: string;
  /** 规则ID */
  RuleId: string;
  /** 转换器id */
  TransformationId: string;
}

declare interface DeleteTransformationResponse {
  /** 唯一请求 ID，每次请求都会返回。 */
  RequestId?: string;
}

declare interface DescribeLogTagValueRequest {
  /** 起始时间 */
  StartTime: number;
  /** 结束时间 */
  EndTime: number;
  /** 事件集ID */
  EventBusId: string;
  /** 聚合字段,取值范围如下：Source(事件源),RuleIds(命中规则),Subject(实例ID),Region(地域) */
  GroupField: string;
  /** 页数 */
  Page: number;
  /** 每页数据大小 */
  Limit: number;
  /** 筛选条件 */
  Filter?: LogFilter[];
}

declare interface DescribeLogTagValueResponse {
  /** 事件查询维度值结果 */
  Results?: string[] | null;
  /** 唯一请求 ID，每次请求都会返回。 */
  RequestId?: string;
}

declare interface GetEventBusRequest {
  /** 事件集ID */
  EventBusId: string;
}

declare interface GetEventBusResponse {
  /** 更新时间 */
  ModTime?: string;
  /** 事件集描述 */
  Description?: string;
  /** 日志主题ID */
  ClsTopicId?: string;
  /** 创建时间 */
  AddTime?: string;
  /** 日志集ID */
  ClsLogsetId?: string;
  /** 事件集名称 */
  EventBusName?: string;
  /** 事件集ID */
  EventBusId?: string;
  /** （已废弃）事件集类型 */
  Type?: string;
  /** 计费模式 */
  PayMode?: string;
  /** EB日志存储时长 */
  SaveDays?: number | null;
  /** EB日志主题ID */
  LogTopicId?: string | null;
  /** 是否开启存储 */
  EnableStore?: boolean | null;
  /** 消息序列，是否有序 */
  LinkMode?: string | null;
  /** 唯一请求 ID，每次请求都会返回。 */
  RequestId?: string;
}

declare interface GetPlatformEventTemplateRequest {
  /** 平台产品事件类型 */
  EventType: string;
}

declare interface GetPlatformEventTemplateResponse {
  /** 平台产品事件模板 */
  EventTemplate?: string;
  /** 唯一请求 ID，每次请求都会返回。 */
  RequestId?: string;
}

declare interface GetRuleRequest {
  /** 事件集ID */
  EventBusId: string;
  /** 事件规则ID */
  RuleId: string;
}

declare interface GetRuleResponse {
  /** 事件集id */
  EventBusId?: string;
  /** 事件规则id */
  RuleId?: string;
  /** 事件规则名称 */
  RuleName?: string;
  /** 事件规则状态 */
  Status?: string;
  /** 使能开关 */
  Enable?: boolean;
  /** 事件规则描述 */
  Description?: string;
  /** 事件模式 */
  EventPattern?: string;
  /** 创建时间 */
  AddTime?: string;
  /** 更新时间 */
  ModTime?: string;
  /** 唯一请求 ID，每次请求都会返回。 */
  RequestId?: string;
}

declare interface GetTransformationRequest {
  /** 事件集ID */
  EventBusId: string;
  /** 规则ID */
  RuleId: string;
  /** 转换器id */
  TransformationId: string;
}

declare interface GetTransformationResponse {
  /** 转换规则列表 */
  Transformations?: Transformation[];
  /** 唯一请求 ID，每次请求都会返回。 */
  RequestId?: string;
}

declare interface ListConnectionsRequest {
  /** 事件集ID */
  EventBusId: string;
  /** 根据哪个字段进行返回结果排序，目前支持如下以下字段：AddTime, ModTime */
  OrderBy?: string;
  /** 返回数量，默认为20，最大值为100。 */
  Limit?: number;
  /** 以升序还是降序的方式返回结果，可选值 ASC 和 DESC */
  Order?: string;
  /** 偏移量，默认为0。 */
  Offset?: number;
}

declare interface ListConnectionsResponse {
  /** 连接器信息 */
  Connections?: Connection[];
  /** 连接器总数 */
  TotalCount?: number;
  /** 唯一请求 ID，每次请求都会返回。 */
  RequestId?: string;
}

declare interface ListEventBusesRequest {
  /** 根据哪个字段进行返回结果排序,支持以下字段：created_at（创建时间）, updated_at（修改时间） */
  OrderBy?: string;
  /** 返回数量，默认为20，最大值为100。 */
  Limit?: number;
  /** 以升序还是降序的方式返回结果，可选值 ASC（升序） 和 DESC（降序） */
  Order?: string;
  /** 过滤字段范围: EventBusName(事件集名称)/EventBusId(事件集Id)/Type(事件集类型:Cloud(云服务);Platform(平台型);Custom(自定义))/TagKey(标签键)。每次请求的Filters的上限为10，Filter.Values的上限为5。[{"Name":"Type","Values":["Cloud","Platform"]}] */
  Filters?: Filter[];
  /** 分页偏移量，默认为0。 */
  Offset?: number;
}

declare interface ListEventBusesResponse {
  /** 事件集信息 */
  EventBuses?: EventBus[];
  /** 事件集总数 */
  TotalCount?: number;
  /** 唯一请求 ID，每次请求都会返回。 */
  RequestId?: string;
}

declare interface ListPlatformEventNamesRequest {
  /** 平台产品类型 */
  ProductType: string;
}

declare interface ListPlatformEventNamesResponse {
  /** 平台产品列表 */
  EventNames?: PlatformEventDetail[];
  /** 唯一请求 ID，每次请求都会返回。 */
  RequestId?: string;
}

declare interface ListPlatformEventPatternsRequest {
  /** 平台产品类型 */
  ProductType: string;
}

declare interface ListPlatformEventPatternsResponse {
  /** 平台产品事件匹配规则 */
  EventPatterns?: PlatformEventSummary[];
  /** 唯一请求 ID，每次请求都会返回。 */
  RequestId?: string;
}

declare interface ListPlatformProductsRequest {
}

declare interface ListPlatformProductsResponse {
  /** 平台产品列表 */
  PlatformProducts?: PlatformProduct[];
  /** 唯一请求 ID，每次请求都会返回。 */
  RequestId?: string;
}

declare interface ListRulesRequest {
  /** 事件集ID */
  EventBusId: string;
  /** 根据哪个字段进行返回结果排序,支持以下字段：AddTime（创建时间）, ModTime（修改时间）,name（规则名称） */
  OrderBy?: string;
  /** 返回数量，默认为20，最大值为100。 */
  Limit?: number;
  /** 分页偏移量，默认为0。 */
  Offset?: number;
  /** 以升序还是降序的方式返回结果，可选值 ASC（升序） 和 DESC（降序） */
  Order?: string;
}

declare interface ListRulesResponse {
  /** 事件规则信息 */
  Rules?: Rule[];
  /** 事件规则总数 */
  TotalCount?: number;
  /** 唯一请求 ID，每次请求都会返回。 */
  RequestId?: string;
}

declare interface ListTargetsRequest {
  /** 事件集ID */
  EventBusId: string;
  /** 事件规则ID */
  RuleId: string;
  /** 根据哪个字段进行返回结果排序,支持以下字段：AddTime（创建时间）, ModTime（修改时间） */
  OrderBy?: string;
  /** 返回数量，默认为20，最大值为100。 */
  Limit?: number;
  /** 分页偏移量，默认为0。 */
  Offset?: number;
  /** 以升序还是降序的方式返回结果，可选值 ASC（升序） 和 DESC（降序） */
  Order?: string;
}

declare interface ListTargetsResponse {
  /** 目标总数 */
  TotalCount?: number;
  /** 目标信息 */
  Targets?: Target[];
  /** 唯一请求 ID，每次请求都会返回。 */
  RequestId?: string;
}

declare interface PublishEventRequest {
  /** 事件列表 */
  EventList: Event[];
  /** 事件集ID */
  EventBusId: string;
}

declare interface PublishEventResponse {
  /** 唯一请求 ID，每次请求都会返回。 */
  RequestId?: string;
}

declare interface PutEventsRequest {
  /** 事件列表 */
  EventList: Event[];
  /** 事件集ID */
  EventBusId: string;
}

declare interface PutEventsResponse {
  /** 唯一请求 ID，每次请求都会返回。 */
  RequestId?: string;
}

declare interface SearchLogRequest {
  /** 起始时间unix 毫秒时间戳 */
  StartTime: number;
  /** 结束时间unix 毫秒时间戳 */
  EndTime: number;
  /** 事件集ID */
  EventBusId: string;
  /** 页码 */
  Page: number;
  /** 每页数据大小 */
  Limit: number;
  /** 事件查询筛选条件；示例如下：[{"key":"host","operator":"eq","value":"106.53.106.243"},{"type":"AND","filters":[{"key":"region","operator":"like","value":"*guangzhou*"},{"key":"type","operator":"eq","value":"cvm:ErrorEvent:GuestReboot"}]},{"type":"OR","filters":[{"key":"field1","operator":"like","value":"*access*"},{"key":"field2","operator":"eq","value":"custorm"}]}] */
  Filter?: LogFilter[];
  /** 事件查询结果排序，["timestamp","subject"] */
  OrderFields?: string[];
  /** 排序方式，asc 从旧到新，desc 从新到旧 */
  OrderBy?: string;
}

declare interface SearchLogResponse {
  /** 事件总数 */
  Total?: number | null;
  /** 每页事件条数 */
  Limit?: number | null;
  /** 页码 */
  Page?: number | null;
  /** 事件查询结果 */
  Results?: SearchLogResult[] | null;
  /** 唯一请求 ID，每次请求都会返回。 */
  RequestId?: string;
}

declare interface UpdateConnectionRequest {
  /** 连接器ID */
  ConnectionId: string;
  /** 事件集ID */
  EventBusId: string;
  /** 使能开关 */
  Enable?: boolean;
  /** 描述 */
  Description?: string;
  /** 连接器名称 */
  ConnectionName?: string;
}

declare interface UpdateConnectionResponse {
  /** 唯一请求 ID，每次请求都会返回。 */
  RequestId?: string;
}

declare interface UpdateEventBusRequest {
  /** 事件集ID */
  EventBusId: string;
  /** 事件集描述，不限字符类型，200字符描述以内 */
  Description?: string;
  /** 事件集名称，只能包含字母、数字、下划线、连字符，以字母开头，以数字或字母结尾，2~60个字符 */
  EventBusName?: string;
  /** EB日志存储时长 */
  SaveDays?: number;
  /** EB日志主题ID */
  LogTopicId?: string;
  /** 是否开启存储 */
  EnableStore?: boolean;
}

declare interface UpdateEventBusResponse {
  /** 唯一请求 ID，每次请求都会返回。 */
  RequestId?: string;
}

declare interface UpdateRuleRequest {
  /** 事件规则ID */
  RuleId: string;
  /** 事件集ID */
  EventBusId: string;
  /** 使能开关。 */
  Enable?: boolean;
  /** 事件规则描述，只能包含数字、中英文及常用标点符号，不超过200个字符 */
  Description?: string;
  /** 参考：[事件模式](https://cloud.tencent.com/document/product/1359/56084) */
  EventPattern?: string;
  /** 事件规则名称，只能包含字母、中文、数字、下划线、连字符，以字母/中文开头，以数字、字母或中文结尾，2~60个字符 */
  RuleName?: string;
}

declare interface UpdateRuleResponse {
  /** 唯一请求 ID，每次请求都会返回。 */
  RequestId?: string;
}

declare interface UpdateTargetRequest {
  /** 事件集ID */
  EventBusId: string;
  /** 事件规则ID */
  RuleId: string;
  /** 事件目标ID */
  TargetId: string;
  /** 开启批量投递使能 */
  EnableBatchDelivery?: boolean;
  /** 批量投递最长等待时间 */
  BatchTimeout?: number;
  /** 批量投递最大事件条数 */
  BatchEventCount?: number;
}

declare interface UpdateTargetResponse {
  /** 唯一请求 ID，每次请求都会返回。 */
  RequestId?: string;
}

declare interface UpdateTransformationRequest {
  /** 事件集ID */
  EventBusId: string;
  /** 规则ID */
  RuleId: string;
  /** 转换器id */
  TransformationId: string;
  /** 一个转换规则列表，当前仅限定一个 */
  Transformations: Transformation[];
}

declare interface UpdateTransformationResponse {
  /** 唯一请求 ID，每次请求都会返回。 */
  RequestId?: string;
}

/** {@link Eb 事件总线} */
declare interface Eb {
  (): Versions;
  /** 检验规则 {@link CheckRuleRequest} {@link CheckRuleResponse} */
  CheckRule(data: CheckRuleRequest, config?: AxiosRequestConfig): AxiosPromise<CheckRuleResponse>;
  /** 检查转换器 {@link CheckTransformationRequest} {@link CheckTransformationResponse} */
  CheckTransformation(data: CheckTransformationRequest, config?: AxiosRequestConfig): AxiosPromise<CheckTransformationResponse>;
  /** 创建事件连接器 {@link CreateConnectionRequest} {@link CreateConnectionResponse} */
  CreateConnection(data: CreateConnectionRequest, config?: AxiosRequestConfig): AxiosPromise<CreateConnectionResponse>;
  /** 创建事件集 {@link CreateEventBusRequest} {@link CreateEventBusResponse} */
  CreateEventBus(data: CreateEventBusRequest, config?: AxiosRequestConfig): AxiosPromise<CreateEventBusResponse>;
  /** 创建事件规则 {@link CreateRuleRequest} {@link CreateRuleResponse} */
  CreateRule(data: CreateRuleRequest, config?: AxiosRequestConfig): AxiosPromise<CreateRuleResponse>;
  /** 创建事件目标 {@link CreateTargetRequest} {@link CreateTargetResponse} */
  CreateTarget(data: CreateTargetRequest, config?: AxiosRequestConfig): AxiosPromise<CreateTargetResponse>;
  /** 创建转换器 {@link CreateTransformationRequest} {@link CreateTransformationResponse} */
  CreateTransformation(data: CreateTransformationRequest, config?: AxiosRequestConfig): AxiosPromise<CreateTransformationResponse>;
  /** 删除事件连接器 {@link DeleteConnectionRequest} {@link DeleteConnectionResponse} */
  DeleteConnection(data: DeleteConnectionRequest, config?: AxiosRequestConfig): AxiosPromise<DeleteConnectionResponse>;
  /** 删除事件集 {@link DeleteEventBusRequest} {@link DeleteEventBusResponse} */
  DeleteEventBus(data: DeleteEventBusRequest, config?: AxiosRequestConfig): AxiosPromise<DeleteEventBusResponse>;
  /** 删除事件规则 {@link DeleteRuleRequest} {@link DeleteRuleResponse} */
  DeleteRule(data: DeleteRuleRequest, config?: AxiosRequestConfig): AxiosPromise<DeleteRuleResponse>;
  /** 删除事件目标 {@link DeleteTargetRequest} {@link DeleteTargetResponse} */
  DeleteTarget(data: DeleteTargetRequest, config?: AxiosRequestConfig): AxiosPromise<DeleteTargetResponse>;
  /** 删除转换器 {@link DeleteTransformationRequest} {@link DeleteTransformationResponse} */
  DeleteTransformation(data: DeleteTransformationRequest, config?: AxiosRequestConfig): AxiosPromise<DeleteTransformationResponse>;
  /** 事件查询维度值 {@link DescribeLogTagValueRequest} {@link DescribeLogTagValueResponse} */
  DescribeLogTagValue(data: DescribeLogTagValueRequest, config?: AxiosRequestConfig): AxiosPromise<DescribeLogTagValueResponse>;
  /** 获取事件集详情 {@link GetEventBusRequest} {@link GetEventBusResponse} */
  GetEventBus(data: GetEventBusRequest, config?: AxiosRequestConfig): AxiosPromise<GetEventBusResponse>;
  /** 获取平台产品事件模板 {@link GetPlatformEventTemplateRequest} {@link GetPlatformEventTemplateResponse} */
  GetPlatformEventTemplate(data: GetPlatformEventTemplateRequest, config?: AxiosRequestConfig): AxiosPromise<GetPlatformEventTemplateResponse>;
  /** 获取事件规则详情 {@link GetRuleRequest} {@link GetRuleResponse} */
  GetRule(data: GetRuleRequest, config?: AxiosRequestConfig): AxiosPromise<GetRuleResponse>;
  /** 获取转换器详情 {@link GetTransformationRequest} {@link GetTransformationResponse} */
  GetTransformation(data: GetTransformationRequest, config?: AxiosRequestConfig): AxiosPromise<GetTransformationResponse>;
  /** 获取事件连接器列表 {@link ListConnectionsRequest} {@link ListConnectionsResponse} */
  ListConnections(data: ListConnectionsRequest, config?: AxiosRequestConfig): AxiosPromise<ListConnectionsResponse>;
  /** 获取事件集列表 {@link ListEventBusesRequest} {@link ListEventBusesResponse} */
  ListEventBuses(data?: ListEventBusesRequest, config?: AxiosRequestConfig): AxiosPromise<ListEventBusesResponse>;
  /** 获取平台产品事件名称 {@link ListPlatformEventNamesRequest} {@link ListPlatformEventNamesResponse} */
  ListPlatformEventNames(data: ListPlatformEventNamesRequest, config?: AxiosRequestConfig): AxiosPromise<ListPlatformEventNamesResponse>;
  /** 获取平台产品事件匹配规则 {@link ListPlatformEventPatternsRequest} {@link ListPlatformEventPatternsResponse} */
  ListPlatformEventPatterns(data: ListPlatformEventPatternsRequest, config?: AxiosRequestConfig): AxiosPromise<ListPlatformEventPatternsResponse>;
  /** 获取平台产品列表 {@link ListPlatformProductsRequest} {@link ListPlatformProductsResponse} */
  ListPlatformProducts(data?: ListPlatformProductsRequest, config?: AxiosRequestConfig): AxiosPromise<ListPlatformProductsResponse>;
  /** 获取事件规则列表 {@link ListRulesRequest} {@link ListRulesResponse} */
  ListRules(data: ListRulesRequest, config?: AxiosRequestConfig): AxiosPromise<ListRulesResponse>;
  /** 获取事件目标列表 {@link ListTargetsRequest} {@link ListTargetsResponse} */
  ListTargets(data: ListTargetsRequest, config?: AxiosRequestConfig): AxiosPromise<ListTargetsResponse>;
  /** Event事件投递 {@link PublishEventRequest} {@link PublishEventResponse} */
  PublishEvent(data: PublishEventRequest, config?: AxiosRequestConfig): AxiosPromise<PublishEventResponse>;
  /** 事件投递 {@link PutEventsRequest} {@link PutEventsResponse} */
  PutEvents(data: PutEventsRequest, config?: AxiosRequestConfig): AxiosPromise<PutEventsResponse>;
  /** 事件查询 {@link SearchLogRequest} {@link SearchLogResponse} */
  SearchLog(data: SearchLogRequest, config?: AxiosRequestConfig): AxiosPromise<SearchLogResponse>;
  /** 更新事件连接器 {@link UpdateConnectionRequest} {@link UpdateConnectionResponse} */
  UpdateConnection(data: UpdateConnectionRequest, config?: AxiosRequestConfig): AxiosPromise<UpdateConnectionResponse>;
  /** 更新事件集 {@link UpdateEventBusRequest} {@link UpdateEventBusResponse} */
  UpdateEventBus(data: UpdateEventBusRequest, config?: AxiosRequestConfig): AxiosPromise<UpdateEventBusResponse>;
  /** 更新事件规则 {@link UpdateRuleRequest} {@link UpdateRuleResponse} */
  UpdateRule(data: UpdateRuleRequest, config?: AxiosRequestConfig): AxiosPromise<UpdateRuleResponse>;
  /** 更新事件目标 {@link UpdateTargetRequest} {@link UpdateTargetResponse} */
  UpdateTarget(data: UpdateTargetRequest, config?: AxiosRequestConfig): AxiosPromise<UpdateTargetResponse>;
  /** 更新转换器 {@link UpdateTransformationRequest} {@link UpdateTransformationResponse} */
  UpdateTransformation(data: UpdateTransformationRequest, config?: AxiosRequestConfig): AxiosPromise<UpdateTransformationResponse>;
}

export declare type Versions = ["2021-04-16"];

export default Eb;