tencentcloud-sdk-nodejs/tencentcloud/services/ckafka/v20190819/ckafka_models.d.ts

腾讯云 API NODEJS SDK

/**
 * consumer信息
 */
export interface GroupInfoMember {
    /**
     * coordinator 为消费分组中的消费者生成的唯一 ID
     */
    MemberId?: string;
    /**
     * 客户消费者 SDK 自己设置的 client.id 信息
     */
    ClientId?: string;
    /**
     * 一般存储客户的 IP 地址
     */
    ClientHost?: string;
    /**
     * 存储着分配给该消费者的 partition 信息
     */
    Assignment?: Assignment;
}
/**
 * 分区和位移
 */
export interface PartitionOffset {
    /**
     * 分区
     */
    Partition?: string;
    /**
     * 位点偏移量
     */
    Offset?: number;
}
/**
 * DescribeACL请求参数结构体
 */
export interface DescribeACLRequest {
    /**
     * ckafka集群实例Id
     */
    InstanceId: string;
    /**
     * Acl资源类型，(2:TOPIC，3:GROUP，4:CLUSTER)
     */
    ResourceType: number;
    /**
     * 资源名称，和resourceType相关，如当resourceType为TOPIC时，则该字段表示topic名称，当resourceType为GROUP时，该字段表示group名称，当resourceType为CLUSTER时，该字段可为空。
     */
    ResourceName: string;
    /**
     * 偏移位置
     */
    Offset?: number;
    /**
     * 个数限制
     */
    Limit?: number;
    /**
     * 关键字匹配
     */
    SearchWord?: string;
}
/**
 * DescribeTopicSyncReplica返回参数结构体
 */
export interface DescribeTopicSyncReplicaResponse {
    /**
     * 返回topic 副本详情
     */
    Result?: TopicInSyncReplicaResult;
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * DescribeDatahubGroupOffsets返回参数结构体
 */
export interface DescribeDatahubGroupOffsetsResponse {
    /**
     * 返回的结果对象
     */
    Result?: GroupOffsetResponse;
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * 查询连接源具体数据的返参
 */
export interface DescribeConnectResourceResp {
    /**
     * 连接源的Id
     */
    ResourceId?: string;
    /**
     * 连接源名称
     */
    ResourceName?: string;
    /**
     * 连接源描述
     */
    Description?: string;
    /**
     * 连接源类型
     */
    Type?: string;
    /**
     * 连接源的状态
     */
    Status?: number;
    /**
     * 连接源的创建时间
     */
    CreateTime?: string;
    /**
     * 连接源的异常信息
     */
    ErrorMessage?: string;
    /**
     * 连接源的当前所处步骤
     */
    CurrentStep?: string;
    /**
     * 步骤列表
  注意：此字段可能返回 null，表示取不到有效值。
     */
    StepList?: Array<string>;
    /**
     * MySQL配置，Type为MYSQL或TDSQL_C_MYSQL时返回
  注意：此字段可能返回 null，表示取不到有效值。
     */
    MySQLConnectParam?: MySQLConnectParam;
    /**
     * PostgreSQL配置，Type为POSTGRESQL或TDSQL_C_POSTGRESQL时返回
  注意：此字段可能返回 null，表示取不到有效值。
     */
    PostgreSQLConnectParam?: PostgreSQLConnectParam;
    /**
     * Dts配置，Type为DTS时返回
  注意：此字段可能返回 null，表示取不到有效值。
     */
    DtsConnectParam?: DtsConnectParam;
    /**
     * MongoDB配置，Type为MONGODB时返回
  注意：此字段可能返回 null，表示取不到有效值。
     */
    MongoDBConnectParam?: MongoDBConnectParam;
    /**
     * Es配置，Type为ES时返回
  注意：此字段可能返回 null，表示取不到有效值。
     */
    EsConnectParam?: EsConnectParam;
    /**
     * ClickHouse配置，Type为CLICKHOUSE时返回
  注意：此字段可能返回 null，表示取不到有效值。
     */
    ClickHouseConnectParam?: ClickHouseConnectParam;
    /**
     * MariaDB配置，Type为MARIADB时返回
  注意：此字段可能返回 null，表示取不到有效值。
     */
    MariaDBConnectParam?: MariaDBConnectParam;
    /**
     * SQLServer配置，Type为SQLSERVER时返回
  注意：此字段可能返回 null，表示取不到有效值。
     */
    SQLServerConnectParam?: SQLServerConnectParam;
    /**
     * Ctsdb配置，Type为CTSDB时返回
  注意：此字段可能返回 null，表示取不到有效值。
     */
    CtsdbConnectParam?: CtsdbConnectParam;
    /**
     * Doris 配置，Type 为 DORIS 时返回
  注意：此字段可能返回 null，表示取不到有效值。
     */
    DorisConnectParam?: DorisConnectParam;
    /**
     * Kafka配置，Type 为 KAFKA 时返回
  注意：此字段可能返回 null，表示取不到有效值。
     */
    KafkaConnectParam?: KafkaConnectParam;
    /**
     * MQTT配置，Type 为 MQTT 时返回
  注意：此字段可能返回 null，表示取不到有效值。
     */
    MqttConnectParam?: MqttConnectParam;
}
/**
 * AuthorizeToken返回参数结构体
 */
export interface AuthorizeTokenResponse {
    /**
     * 0 成功
     */
    Result?: number;
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * Es类型入参
 */
export interface EsParam {
    /**
     * Es实例资源Id
     */
    Resource: string;
    /**
     * Es的连接port
     */
    Port?: number;
    /**
     * Es用户名
     */
    UserName?: string;
    /**
     * Es密码
     */
    Password?: string;
    /**
     * 是否为自建集群
     */
    SelfBuilt?: boolean;
    /**
     * 实例vip
     */
    ServiceVip?: string;
    /**
     * 实例的vpcId
     */
    UniqVpcId?: string;
    /**
     * Es是否抛弃解析失败的消息
     */
    DropInvalidMessage?: boolean;
    /**
     * Es自定义index名称
     */
    Index?: string;
    /**
     * Es自定义日期后缀
     */
    DateFormat?: string;
    /**
     * 非json格式数据的自定义key
     */
    ContentKey?: string;
    /**
     * Es是否抛弃非json格式的消息
     */
    DropInvalidJsonMessage?: boolean;
    /**
     * 转储到Es中的文档ID取值字段名
     */
    DocumentIdField?: string;
    /**
     * Es自定义index名称的类型，STRING，JSONPATH，默认为STRING
     */
    IndexType?: string;
    /**
     * 当设置成员参数DropInvalidMessageToCls设置为true时,DropInvalidMessage参数失效
     */
    DropCls?: DropCls;
    /**
     * 转储到ES的消息为Database的binlog时，如果需要同步数据库操作，即增删改的操作到ES时填写数据库表主键
     */
    DatabasePrimaryKey?: string;
    /**
     * 死信队列
     */
    DropDlq?: FailureParam;
    /**
     * 使用数据订阅格式导入 es 时，消息与 es 索引字段映射关系。不填默认为默认字段匹配
     */
    RecordMappingList?: Array<EsRecordMapping>;
    /**
     * 消息要映射为 es 索引中 @timestamp 的字段，如果当前配置为空，则使用消息的时间戳进行映射
     */
    DateField?: string;
    /**
     * 用来区分当前索引映射，属于新建索引还是存量索引。"EXIST_MAPPING"：从存量索引中选择；"NEW_MAPPING"：新建索引
     */
    RecordMappingMode?: string;
}
/**
 * DescribeAclRule返回参数结构体
 */
export interface DescribeAclRuleResponse {
    /**
     * 返回的AclRule结果集对象
     */
    Result?: AclRuleResp;
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * Dts类型入参
 */
export interface DtsParam {
    /**
     * Dts实例Id
     */
    Resource: string;
    /**
     * Dts的连接ip
     */
    Ip?: string;
    /**
     * Dts的连接port
     */
    Port?: number;
    /**
     * Dts订阅的topic
     */
    Topic?: string;
    /**
     * Dts消费分组的Id
     */
    GroupId?: string;
    /**
     * Dts消费分组的账号
     */
    GroupUser?: string;
    /**
     * Dts消费分组的密码
     */
    GroupPassword?: string;
    /**
     * false同步原始数据，true同步解析后的json格式数据,默认true
     */
    TranSql?: boolean;
}
/**
 * CancelAuthorizationToken请求参数结构体
 */
export interface CancelAuthorizationTokenRequest {
    /**
     * ckafka集群实例Id
     */
    InstanceId: string;
    /**
     * 用户
     */
    User: string;
    /**
     * token串
     */
    Tokens: string;
}
/**
 * MongoDB类型入参
 */
export interface MongoDBParam {
    /**
     * MongoDB的数据库名称
     */
    Database: string;
    /**
     * MongoDB的集群
     */
    Collection: string;
    /**
     * 是否复制存量数据，默认传参true
     */
    CopyExisting: boolean;
    /**
     * 实例资源
     */
    Resource: string;
    /**
     * MongoDB的连接ip
     */
    Ip?: string;
    /**
     * MongoDB的连接port
     */
    Port?: number;
    /**
     * MongoDB数据库用户名
     */
    UserName?: string;
    /**
     * MongoDB数据库密码
     */
    Password?: string;
    /**
     * 监听事件类型，为空时表示全选。取值包括insert,update,replace,delete,invalidate,drop,dropdatabase,rename，多个类型间使用,逗号分隔
     */
    ListeningEvent?: string;
    /**
     * 主从优先级，默认主节点
     */
    ReadPreference?: string;
    /**
     * 聚合管道
     */
    Pipeline?: string;
    /**
     * 是否为自建集群
     */
    SelfBuilt?: boolean;
}
/**
 * DeleteTopic请求参数结构体
 */
export interface DeleteTopicRequest {
    /**
     * ckafka 实例Id
     */
    InstanceId: string;
    /**
     * ckafka 主题名称
     */
    TopicName: string;
}
/**
 * FetchMessageListByOffset请求参数结构体
 */
export interface FetchMessageListByOffsetRequest {
    /**
     * ckafka集群实例Id
     */
    InstanceId: string;
    /**
     * 主题名
     */
    Topic: string;
    /**
     * 分区id
     */
    Partition: number;
    /**
     * 位点信息
     */
    Offset: number;
    /**
     * 最大查询条数，默认20，最大20
     */
    SinglePartitionRecordNumber?: number;
}
/**
 * 地域实体对象
 */
export interface Region {
    /**
     * 地域ID
     */
    RegionId?: number;
    /**
     * 地域名称
     */
    RegionName?: string;
    /**
     * 区域名称
     */
    AreaName?: string;
    /**
     * 地域代码
     */
    RegionCode?: string;
    /**
     * 地域代码（V3版本）
     */
    RegionCodeV3?: string;
    /**
     * NONE:默认值不支持任何特殊类型 实例类型
     */
    Support?: string;
    /**
     * 是否支持ipv6, 0：表示不支持，1：表示支持
     */
    Ipv6?: number;
    /**
     * 是否支持跨可用区, 0：表示不支持，1：表示支持
     */
    MultiZone?: number;
}
/**
 * CreateAclRule请求参数结构体
 */
export interface CreateAclRuleRequest {
    /**
     * ckafka集群实例Id
     */
    InstanceId: string;
    /**
     * Acl资源类型,目前只支持Topic,枚举值列表：Topic
     */
    ResourceType: string;
    /**
     * ACL规则匹配类型，目前支持前缀匹配与预设策略，枚举值列表：PREFIXED/PRESET
     */
    PatternType: string;
    /**
     * 规则名称
     */
    RuleName: string;
    /**
     * 设置的ACL规则列表
     */
    RuleList: Array<AclRuleInfo>;
    /**
     * 表示前缀匹配的前缀的值
     */
    Pattern?: string;
    /**
     * 预设ACL规则是否应用到新增的topic中
     */
    IsApplied?: number;
    /**
     * ACL规则的备注
     */
    Comment?: string;
}
/**
 * DescribeInstancesDetail返回参数结构体
 */
export interface DescribeInstancesDetailResponse {
    /**
     * 返回的实例详情结果对象
     */
    Result?: InstanceDetailResponse;
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * DescribeTaskStatus请求参数结构体
 */
export interface DescribeTaskStatusRequest {
    /**
     * 流程Id
     */
    FlowId: number;
}
/**
 * DescribeAclRule请求参数结构体
 */
export interface DescribeAclRuleRequest {
    /**
     * ckafka集群实例Id
     */
    InstanceId: string;
    /**
     * ACL规则名
     */
    RuleName?: string;
    /**
     * ACL规则匹配类型
     */
    PatternType?: string;
    /**
     * 是否读取简略的ACL规则
     */
    IsSimplified?: boolean;
}
/**
 * 操作型结果返回值
 */
export interface JgwOperateResponse {
    /**
     * 返回的code，0为正常，非0为错误
     */
    ReturnCode?: string;
    /**
     * 成功消息
     */
    ReturnMessage?: string;
    /**
     * 操作型返回的Data数据,可能有flowId等
  注意：此字段可能返回 null，表示取不到有效值。
     */
    Data?: OperateResponseData;
}
/**
 * 创建MQTT 为Source的Data Hub Task参数
 */
export interface MqttParam {
    /**
     * 需要同步的MQTT Topic列表, CSV格式
     */
    Topics: string;
    /**
     * MQTT clean-session
     */
    CleanSession: boolean;
    /**
     * MQTT instance-id
     */
    Resource?: string;
    /**
     * MQTT实例VIP
     */
    Ip?: string;
    /**
     * MQTT VIP 端口
     */
    Port?: number;
    /**
     * MQTT实例用户名
     */
    UserName?: string;
    /**
     * MQTT实例内账户密码
     */
    Password?: string;
    /**
     * QoS
     */
    Qos?: number;
    /**
     * tasks.max 订阅Topic的并发Task个数, 默认为1; 当设置大于1时, 使用Shared Subscription
     */
    MaxTasks?: number;
    /**
     * MQTT 实例的Service VIP
     */
    ServiceVip?: string;
    /**
     * MQTT实例的VPC ID
     */
    UniqVpcId?: string;
    /**
     * 是否为自建集群, MQTT只支持非自建集群
     */
    SelfBuilt?: boolean;
}
/**
 * broker维度topic 流量排行指标
 */
export interface BrokerTopicFlowData {
    /**
     * 主题名
     */
    TopicName?: string;
    /**
     * 主题Id
     */
    TopicId?: string;
    /**
     * Topic 流量(MB)
     */
    TopicTraffic?: string;
}
/**
 * 实例详情中的标签对象
 */
export interface Tag {
    /**
     * 标签的key
     */
    TagKey: string;
    /**
     * 标签的值
     */
    TagValue: string;
}
/**
 * ModifyAclRule返回参数结构体
 */
export interface ModifyAclRuleResponse {
    /**
     * 规则的唯一表示Key
     */
    Result?: number;
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * record 与数据库表的映射关系
 */
export interface RecordMapping {
    /**
     * 消息的 key 名称
  注意：此字段可能返回 null，表示取不到有效值。
     */
    JsonKey?: string;
    /**
     * 消息类型
     */
    Type?: string;
    /**
     * 消息是否允许为空
  注意：此字段可能返回 null，表示取不到有效值。
     */
    AllowNull?: boolean;
    /**
     * 对应映射列名称
  注意：此字段可能返回 null，表示取不到有效值。
     */
    ColumnName?: string;
    /**
     * 数据库表额外字段
  注意：此字段可能返回 null，表示取不到有效值。
     */
    ExtraInfo?: string;
    /**
     * 当前列大小
  注意：此字段可能返回 null，表示取不到有效值。
     */
    ColumnSize?: string;
    /**
     * 当前列精度
  注意：此字段可能返回 null，表示取不到有效值。
     */
    DecimalDigits?: string;
    /**
     * 是否为自增列
  注意：此字段可能返回 null，表示取不到有效值。
     */
    AutoIncrement?: boolean;
    /**
     * 数据库表默认参数
  注意：此字段可能返回 null，表示取不到有效值。
     */
    DefaultValue?: string;
}
/**
 * MongoDB修改连接源参数
 */
export interface MongoDBModifyConnectParam {
    /**
     * MongoDB连接源的实例资源【不支持修改】
     */
    Resource: string;
    /**
     * MongoDB的连接port【不支持修改】
     */
    Port?: number;
    /**
     * MongoDB连接源的实例vip【不支持修改】
     */
    ServiceVip?: string;
    /**
     * MongoDB连接源的vpcId【不支持修改】
     */
    UniqVpcId?: string;
    /**
     * MongoDB连接源的用户名
     */
    UserName?: string;
    /**
     * MongoDB连接源的密码
     */
    Password?: string;
    /**
     * MongoDB连接源是否为自建集群【不支持修改】
     */
    SelfBuilt?: boolean;
    /**
     * 是否更新到关联的Datahub任务
     */
    IsUpdate?: boolean;
}
/**
 * FetchMessageListByOffset返回参数结构体
 */
export interface FetchMessageListByOffsetResponse {
    /**
     * 返回结果。注意，列表中不返回具体的消息内容（key、value），如果需要查询具体消息内容，请使用FetchMessageByOffset接口
     */
    Result?: Array<ConsumerRecord>;
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * DeleteRouteTriggerTime请求参数结构体
 */
export interface DeleteRouteTriggerTimeRequest {
    /**
     * ckafka集群实例Id
     */
    InstanceId: string;
    /**
     * 修改删除路由的定时时间
     */
    DelayTime: string;
}
/**
 * CreatePostPaidInstance请求参数结构体
 */
export interface CreatePostPaidInstanceRequest {
    /**
     * ckafka集群实例名称，是一个不超过 64 个字符的字符串，必须以字母为首字符，剩余部分可以包含字母、数字和横划线(-)
     */
    InstanceName?: string;
    /**
     * 私有网络Id  创建的实例默认接入点所在的 vpc 对应 vpcId。目前不支持创建基础网络实例，因此该参数必填
     */
    VpcId?: string;
    /**
     * 子网id。创建实例默认接入点所在的子网对应的子网 id
     */
    SubnetId?: string;
    /**
     * 国际站标准版实例规格。目前只有国际站标准版使用当前字段区分规格，国内站标准版使用峰值带宽区分规格。除了国际站标准版外的所有实例填写 1 即可。国际站标准版实例：入门型(general)]填写1；[标准型(standard)]填写2；[进阶型(advanced)]填写3；[容量型(capacity)]填写4；[高阶型1(specialized-1)]填写5；[高阶型2(specialized-2)]填写6；[高阶型3(specialized-3)]填写7；[高阶型4(specialized-4)]填写8。
     */
    InstanceType?: number;
    /**
     * 实例日志的默认最长保留时间，单位分钟。不传入该参数时默认为 1440 分钟（1天），最大30天。当 topic 显式设置消息保留时间时，以 topic 保留时间为准
     */
    MsgRetentionTime?: number;
    /**
     * 创建实例时可以选择集群Id, 该入参表示集群Id。不指定实例所在集群则不传入该参数
     */
    ClusterId?: number;
    /**
     * 实例版本。目前支持 "0.10.2","1.1.1","2.4.1","2.4.2","2.8.1"。"2.4.1" 与 "2.4.2" 属于同一个版本，传任意一个均可。
     */
    KafkaVersion?: string;
    /**
     * 实例类型。"standard"：标准版，"profession"：专业版。  (标准版仅国际站支持，国内站目前支持专业版)
     */
    SpecificationsType?: string;
    /**
     * 专业版实例磁盘类型，标准版实例不需要填写。"CLOUD_SSD"：SSD云硬盘；"CLOUD_BASIC"：高性能云硬盘。不传默认值为 "CLOUD_BASIC"
     */
    DiskType?: string;
    /**
     * 实例内网峰值带宽。单位 MB/s。标准版需传入当前实例规格所对应的峰值带宽。注意如果创建的实例为专业版实例，峰值带宽，分区数等参数配置需要满足专业版的计费规格。
     */
    BandWidth?: number;
    /**
     * 实例硬盘大小，需要满足当前实例的计费规格
     */
    DiskSize?: number;
    /**
     * 实例最大分区数量，需要满足当前实例的计费规格
     */
    Partition?: number;
    /**
     * 实例最大 topic 数量，需要满足当前实例的计费规格
     */
    TopicNum?: number;
    /**
     * 实例所在的可用区。当创建多可用区实例时，该参数为创建的默认接入点所在子网的可用区 id
     */
    ZoneId?: number;
    /**
     * 当前实例是否为多可用区实例。
     */
    MultiZoneFlag?: boolean;
    /**
     * 当实例为多可用区实例时，多可用区 id 列表。注意参数 ZoneId 对应的多可用区需要包含在该参数数组中
     */
    ZoneIds?: Array<number | bigint>;
    /**
     * 购买实例数量。非必填，默认值为 1。当传入该参数时，会创建多个 instanceName 加后缀区分的实例
     */
    InstanceNum?: number;
    /**
     * 公网带宽大小，单位 Mbps。默认是没有加上免费 3Mbps 带宽。例如总共需要 3Mbps 公网带宽，此处传 0；总共需要 6Mbps 公网带宽，此处传 3。需要保证传入参数为 3 的整数倍
     */
    PublicNetworkMonthly?: number;
    /**
     * 标签
     */
    Tags?: Array<Tag>;
    /**
     * 弹性带宽开关 0不开启  1开启（0默认)
     */
    ElasticBandwidthSwitch?: number;
}
/**
 * 修改实例属性的配置对象
 */
export interface ModifyInstanceAttributesConfig {
    /**
     * 自动创建 true 表示开启，false 表示不开启
     */
    AutoCreateTopicEnable?: boolean;
    /**
     * 可选，如果auto.create.topic.enable设置为true没有设置该值时，默认设置为3
     */
    DefaultNumPartitions?: number;
    /**
     * 如果auto.create.topic.enable设置为true没有指定该值时默认设置为2
     */
    DefaultReplicationFactor?: number;
}
/**
 * AuthorizeToken请求参数结构体
 */
export interface AuthorizeTokenRequest {
    /**
     * ckafka集群实例Id
     */
    InstanceId: string;
    /**
     * 用户
     */
    User: string;
    /**
     * token串
     */
    Tokens: string;
}
/**
 * RenewCkafkaInstance返回参数结构体
 */
export interface RenewCkafkaInstanceResponse {
    /**
     * 返回值
     */
    Result?: RenewCkafkaInstanceResp;
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * CreatePartition返回参数结构体
 */
export interface CreatePartitionResponse {
    /**
     * 返回的结果集
     */
    Result?: JgwOperateResponse;
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * MySQL类型入参
 */
export interface MySQLParam {
    /**
     * MySQL的数据库名称，"*"为全数据库
     */
    Database: string;
    /**
     * MySQL的数据表名称，"*"为所监听的所有数据库中的非系统表，可以","间隔，监听多个数据表，但数据表需要以"数据库名.数据表名"的格式进行填写，需要填入正则表达式时，格式为"数据库名\\.数据表名"
     */
    Table: string;
    /**
     * 该MySQL在连接管理内的Id
     */
    Resource: string;
    /**
     * 复制存量信息(schema_only不复制, initial全量)，默认值initial
     */
    SnapshotMode?: string;
    /**
     * 存放MySQL的Ddl信息的Topic，为空则默认不存放
     */
    DdlTopic?: string;
    /**
     * "TABLE" 表示读取项为 table，"QUERY" 表示读取项为 query
     */
    DataSourceMonitorMode?: string;
    /**
     * 当 "DataMonitorMode"="TABLE" 时，传入需要读取的 Table；当 "DataMonitorMode"="QUERY" 时，传入需要读取的查询 sql 语句
     */
    DataSourceMonitorResource?: string;
    /**
     * "TIMESTAMP" 表示增量列为时间戳类型，"INCREMENT" 表示增量列为自增 id 类型
     */
    DataSourceIncrementMode?: string;
    /**
     * 传入需要监听的列名称
     */
    DataSourceIncrementColumn?: string;
    /**
     * "HEAD" 表示复制存量 + 增量数据，"TAIL" 表示只复制增量数据
     */
    DataSourceStartFrom?: string;
    /**
     * "INSERT" 表示使用 Insert 模式插入，"UPSERT" 表示使用 Upsert 模式插入
     */
    DataTargetInsertMode?: string;
    /**
     * 当 "DataInsertMode"="UPSERT" 时，传入当前 upsert 时依赖的主键
     */
    DataTargetPrimaryKeyField?: string;
    /**
     * 表与消息间的映射关系
     */
    DataTargetRecordMapping?: Array<RecordMapping>;
    /**
     * 事件路由到特定主题的正则表达式，默认为(.*)
     */
    TopicRegex?: string;
    /**
     * TopicRegex的引用组，指定$1、$2等
     */
    TopicReplacement?: string;
    /**
     * 格式：库1.表1:字段1,字段2;库2.表2:字段2，表之间;（分号）隔开，字段之间,（逗号）隔开。不指定的表默认取表的主键
     */
    KeyColumns?: string;
    /**
     * Mysql 是否抛弃解析失败的消息，默认为true
     */
    DropInvalidMessage?: boolean;
    /**
     * 当设置成员参数DropInvalidMessageToCls设置为true时,DropInvalidMessage参数失效
     */
    DropCls?: DropCls;
    /**
     * 输出格式，DEFAULT、CANAL_1、CANAL_2
     */
    OutputFormat?: string;
    /**
     * 当Table输入的是前缀时，该项值为true，否则为false
     */
    IsTablePrefix?: boolean;
    /**
     * 如果该值为all，则DDL数据以及DML数据也会写入到选中的topic；若该值为dml，则只有DML数据写入到选中的topic
     */
    IncludeContentChanges?: string;
    /**
     * 如果该值为true，且MySQL中"binlog_rows_query_log_events"配置项的值为"ON"，则流入到topic的数据包含原SQL语句；若该值为false，流入到topic的数据不包含原SQL语句
     */
    IncludeQuery?: boolean;
    /**
     * 如果该值为 true，则消息中会携带消息结构体对应的schema，如果该值为false则不会携带
     */
    RecordWithSchema?: boolean;
    /**
     * 存放信令表的数据库名称
     */
    SignalDatabase?: string;
    /**
     * 输入的table是否为正则表达式，如果该选项以及IsTablePrefix同时为true，该选项的判断优先级高于IsTablePrefix
     */
    IsTableRegular?: boolean;
    /**
     * 信号表
  注意：此字段可能返回 null，表示取不到有效值。
     */
    SignalTable?: string;
    /**
     * datetime 类型字段转换为时间戳的时区
     */
    DateTimeZone?: string;
    /**
     * 自建
     */
    SelfBuilt?: boolean;
}
/**
 * partition信息
 */
export interface Partitions {
    /**
     * 分区
     */
    Partition: number;
    /**
     * partition 消费位移
     */
    Offset: number;
}
/**
 * DescribeTopic返回参数结构体
 */
export interface DescribeTopicResponse {
    /**
     * 返回的结果
     */
    Result?: TopicResult;
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * 消费组返回结果实体
 */
export interface ConsumerGroupResponse {
    /**
     * 符合条件的消费组数量
     */
    TotalCount?: number;
    /**
     * 主题列表
     */
    TopicList?: Array<ConsumerGroupTopic>;
    /**
     * 消费分组List
     */
    GroupList?: Array<ConsumerGroup>;
    /**
     * 所有分区数量
     */
    TotalPartition?: number;
    /**
     * 监控的分区列表
     */
    PartitionListForMonitor?: Array<Partition>;
    /**
     * 主题总数
     */
    TotalTopic?: number;
    /**
     * 监控的主题列表
     */
    TopicListForMonitor?: Array<ConsumerGroupTopic>;
    /**
     * 监控的组列表
     */
    GroupListForMonitor?: Array<Group>;
}
/**
 * CreateTopicIpWhiteList返回参数结构体
 */
export interface CreateTopicIpWhiteListResponse {
    /**
     * 删除主题IP白名单结果
     */
    Result?: JgwOperateResponse;
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * 数据处理规则失败处理
 */
export interface FailureParam {
    /**
     * 类型，DLQ死信队列，IGNORE_ERROR保留，DROP废弃
     */
    Type: string;
    /**
     * Ckafka类型死信队列
     */
    KafkaParam?: KafkaParam;
    /**
     * 重试间隔
     */
    RetryInterval?: number;
    /**
     * 重试次数
     */
    MaxRetryAttempts?: number;
    /**
     * DIP Topic类型死信队列
     */
    TopicParam?: TopicParam;
    /**
     * 死信队列类型，CKAFKA，TOPIC
     */
    DlqType?: string;
}
/**
 * CreateTopic请求参数结构体
 */
export interface CreateTopicRequest {
    /**
     * 实例Id
     */
    InstanceId: string;
    /**
     * 主题名称，是一个不超过 128 个字符的字符串，必须以字母为首字符，剩余部分可以包含字母、数字和横划线(-)
     */
    TopicName: string;
    /**
     * Partition个数，大于0
     */
    PartitionNum: number;
    /**
     * 副本个数，不能多于 broker 数，最大为3
     */
    ReplicaNum: number;
    /**
     * ip白名单开关, 1:打开  0:关闭，默认不打开
     */
    EnableWhiteList?: number;
    /**
     * Ip白名单列表，配额限制，enableWhileList=1时必选
     */
    IpWhiteList?: Array<string>;
    /**
     * 清理日志策略，日志清理模式，默认为"delete"。"delete"：日志按保存时间删除，"compact"：日志按 key 压缩，"compact, delete"：日志按 key 压缩且会按保存时间删除。
     */
    CleanUpPolicy?: string;
    /**
     * 主题备注，是一个不超过 64 个字符的字符串，必须以字母为首字符，剩余部分可以包含字母、数字和横划线(-)
     */
    Note?: string;
    /**
     * 默认为1
     */
    MinInsyncReplicas?: number;
    /**
     * 是否允许未同步的副本选为leader，false:不允许，true:允许，默认不允许
     */
    UncleanLeaderElectionEnable?: number;
    /**
     * 可选参数。消息保留时间，单位ms，当前最小值为60000ms
     */
    RetentionMs?: number;
    /**
     * Segment分片滚动的时长，单位ms，当前最小为3600000ms
     */
    SegmentMs?: number;
    /**
     * 主题消息最大值，单位为 Byte，最小值1024Byte(即1KB)，最大值为12582912Byte（即12MB）
     */
    MaxMessageBytes?: number;
    /**
     * 预设ACL规则, 1:打开  0:关闭，默认不打开
     */
    EnableAclRule?: number;
    /**
     * 预设ACL规则的名称
     */
    AclRuleName?: string;
    /**
     * 可选, 保留文件大小. 默认为-1,单位bytes, 当前最小值为1048576B
     */
    RetentionBytes?: number;
    /**
     * 标签列表
     */
    Tags?: Array<Tag>;
}
/**
 * DeleteAcl返回参数结构体
 */
export interface DeleteAclResponse {
    /**
     * 返回结果
     */
    Result?: JgwOperateResponse;
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * 动态消息保留时间配置
 */
export interface DynamicRetentionTime {
    /**
     * 动态消息保留时间配置开关（0: 关闭，1: 开启）
  注意：此字段可能返回 null，表示取不到有效值。
     */
    Enable?: number;
    /**
     * 磁盘配额百分比触发条件，即消息达到此值触发消息保留时间变更事件
  注意：此字段可能返回 null，表示取不到有效值。
     */
    DiskQuotaPercentage?: number;
    /**
     * 每次向前调整消息保留时间百分比
  注意：此字段可能返回 null，表示取不到有效值。
     */
    StepForwardPercentage?: number;
    /**
     * 保底时长，单位分钟
  注意：此字段可能返回 null，表示取不到有效值。
     */
    BottomRetention?: number;
}
/**
 * 实例详情返回结果
 */
export interface InstanceDetailResponse {
    /**
     * 符合条件的实例总数
     */
    TotalCount?: number;
    /**
     * 符合条件的实例详情列表
     */
    InstanceList?: Array<InstanceDetail>;
}
/**
 * ModifyInstancePre请求参数结构体
 */
export interface ModifyInstancePreRequest {
    /**
     * ckafka集群实例Id
     */
    InstanceId: string;
    /**
     * 预计磁盘，根据磁盘步长，规格向上调整。
     */
    DiskSize?: number;
    /**
     * 预计带宽，根据带宽步长，规格向上调整。
     */
    BandWidth?: number;
    /**
     * 预计分区，根据带宽步长，规格向上调整。
     */
    Partition?: number;
}
/**
 * 公网带宽参数
 */
export interface InquiryPublicNetworkParam {
    /**
     * 公网计费模式: BANDWIDTH_PREPAID(包年包月), BANDWIDTH_POSTPAID_BY_HOUR(带宽按小时计费)
     */
    PublicNetworkChargeType?: string;
    /**
     * 公网带宽, 单位MB
     */
    PublicNetworkMonthly?: number;
}
/**
 * DeleteConnectResource返回参数结构体
 */
export interface DeleteConnectResourceResponse {
    /**
     * 连接源的Id
     */
    Result?: ConnectResourceResourceIdResp;
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * 批量发送消息内容
 */
export interface BatchContent {
    /**
     * 发送的消息体
     */
    Body: string;
    /**
     * 发送消息的键名
     */
    Key?: string;
}
/**
 * Scf类型入参
 */
export interface ScfParam {
    /**
     * SCF云函数函数名
     */
    FunctionName: string;
    /**
     * SCF云函数命名空间, 默认为default
     */
    Namespace?: string;
    /**
     * SCF云函数版本及别名, 默认为$DEFAULT
     */
    Qualifier?: string;
    /**
     * 每批最大发送消息数, 默认为1000
     */
    BatchSize?: number;
    /**
     * SCF调用失败后重试次数, 默认为5
     */
    MaxRetries?: number;
}
/**
 * DescribeTopic请求参数结构体
 */
export interface DescribeTopicRequest {
    /**
     * ckafka集群实例Id
     */
    InstanceId: string;
    /**
     * 过滤条件，按照 topicName 过滤，支持模糊查询
     */
    SearchWord?: string;
    /**
     * 偏移量，不填默认为0
     */
    Offset?: number;
    /**
     * 返回数量，不填则默认为20，最大值为50
     */
    Limit?: number;
    /**
     * Acl预设策略名称
     */
    AclRuleName?: string;
}
/**
 * PostgreSQL修改连接源参数
 */
export interface PostgreSQLModifyConnectParam {
    /**
     * PostgreSQL连接源的实例资源【不支持修改】
     */
    Resource: string;
    /**
     * PostgreSQL的连接port【不支持修改】
     */
    Port?: number;
    /**
     * PostgreSQL连接源的实例vip【不支持修改】
     */
    ServiceVip?: string;
    /**
     * PostgreSQL连接源的vpcId【不支持修改】
     */
    UniqVpcId?: string;
    /**
     * PostgreSQL连接源的用户名
     */
    UserName?: string;
    /**
     * PostgreSQL连接源的密码
     */
    Password?: string;
    /**
     * 当type为TDSQL_C_POSTGRESQL时，该参数才有值【不支持修改】
     */
    ClusterId?: string;
    /**
     * 是否更新到关联的Datahub任务
     */
    IsUpdate?: boolean;
    /**
     * 是否为自建集群
     */
    SelfBuilt?: boolean;
}
/**
 * ModifyAclRule请求参数结构体
 */
export interface ModifyAclRuleRequest {
    /**
     * ckafka集群实例Id
     */
    InstanceId: string;
    /**
     * ACL规则名
     */
    RuleName: string;
    /**
     * 修改预设规则时传入,是否应用到新增的Topic
     */
    IsApplied?: number;
}
/**
 * 组实体
 */
export interface Group {
    /**
     * 消费分组名称
     */
    GroupName?: string;
}
/**
 * Prometheus 监控返回
 */
export interface PrometheusResult {
    /**
     * 返回的code，0为正常，非0为错误
     */
    ReturnCode?: string;
    /**
     * 成功消息
     */
    ReturnMessage?: string;
    /**
     * 操作型返回的Data数据,可能有flowId等
     */
    Data?: OperateResponseData;
}
/**
 * ModifyRoutineMaintenanceTask请求参数结构体
 */
export interface ModifyRoutineMaintenanceTaskRequest {
    /**
     * 实例id
     */
    InstanceId: string;
    /**
     * 自动化运维类别
     */
    MaintenanceType: string;
    /**
     * INSTANCE_STORAGE_CAPACITY(磁盘自动扩容)/MESSAGE_RETENTION_PERIOD(磁盘动态消息保留策略)
     */
    MaintenanceSubtype: string;
    /**
     * 主题名
     */
    TopicName?: string;
    /**
     * 任务触发阈值
     */
    ConfigureThreshold?: number;
    /**
     * 任务调整步长
     */
    ConfigureStepSize?: number;
    /**
     * 任务调整上限
     */
    ConfigureLimit?: number;
    /**
     * 任务预期触发时间，存储从当日 0AM 开始偏移的秒数
     */
    PlannedTime?: number;
    /**
     * 任务额外信息
     */
    ExtraConfig?: string;
    /**
     * 任务状态
     */
    Status?: number;
    /**
     * 执行week day
     */
    Week?: string;
}
/**
 * 实例对象
 */
export interface Instance {
    /**
     * ckafka集群实例Id
     */
    InstanceId?: string;
    /**
     * ckafka集群实例Name
     */
    InstanceName?: string;
    /**
     * 实例的状态。0: 创建中，1: 运行中，2: 删除中,  3: 已删除,  5: 隔离中,  7: 升级中,  -1: 创建失败
     */
    Status?: number;
    /**
     * 是否开源实例。开源：true，不开源：false
     */
    IfCommunity?: boolean;
}
/**
 * DescribeInstanceAttributes返回参数结构体
 */
export interface DescribeInstanceAttributesResponse {
    /**
     * 实例属性返回结果对象。
     */
    Result?: InstanceAttributesResponse;
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * 主题详情返回实体
 */
export interface TopicDetailResponse {
    /**
     * 返回的主题详情列表
     */
    TopicList?: Array<TopicDetail>;
    /**
     * 符合条件的所有主题详情数量
     */
    TotalCount?: number;
}
/**
 * MariaDB连接源参数
 */
export interface MariaDBModifyConnectParam {
    /**
     * MariaDB连接源的实例资源【不支持修改】
     */
    Resource: string;
    /**
     * MariaDB的连接port【不支持修改】
     */
    Port?: number;
    /**
     * MariaDB连接源的实例vip【不支持修改】
     */
    ServiceVip?: string;
    /**
     * MariaDB连接源的vpcId【不支持修改】
     */
    UniqVpcId?: string;
    /**
     * MariaDB连接源的用户名
     */
    UserName?: string;
    /**
     * MariaDB连接源的密码
     */
    Password?: string;
    /**
     * 是否更新到关联的Datahub任务
     */
    IsUpdate?: boolean;
}
/**
 * DescribeRegion返回参数结构体
 */
export interface DescribeRegionResponse {
    /**
     * 返回地域枚举结果列表
     */
    Result?: Array<Region>;
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * CreateTopic返回参数结构体
 */
export interface CreateTopicResponse {
    /**
     * 返回创建结果
     */
    Result?: CreateTopicResp;
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * Kafka连接源参数
 */
export interface KafkaConnectParam {
    /**
     * Kafka连接源的实例资源, 非自建时必填，NetworkType=VPC时传clb实例id
     */
    Resource?: string;
    /**
     * 是否为自建集群
     */
    SelfBuilt?: boolean;
    /**
     * 是否更新到关联的Dip任务
  注意：此字段可能返回 null，表示取不到有效值。
     */
    IsUpdate?: boolean;
    /**
     * Kafka连接的broker地址, NetworkType=PUBLIC公网时必填
     */
    BrokerAddress?: string;
    /**
     * CKafka连接源的实例资源地域, 跨地域时必填
     */
    Region?: string;
}
/**
 * Datahub任务信息
 */
export interface DatahubTaskInfo {
    /**
     * 任务Id
     */
    TaskId?: string;
    /**
     * 任务名称
     */
    TaskName?: string;
    /**
     * 任务类型，SOURCE数据接入，SINK数据流出
     */
    TaskType?: string;
    /**
     * 状态，-1创建失败，0创建中，1运行中，2删除中，3已删除，4删除失败，5暂停中，6已暂停，7暂停失败，8恢复中，9恢复失败
     */
    Status?: number;
    /**
     * 数据源
     */
    SourceResource?: DatahubResource;
    /**
     * 数据目标
     */
    TargetResource?: DatahubResource;
    /**
     * 任务创建时间
     */
    CreateTime?: string;
    /**
     * 异常信息
     */
    ErrorMessage?: string;
    /**
     * 创建进度百分比
     */
    TaskProgress?: number;
    /**
     * 任务当前处于的步骤
     */
    TaskCurrentStep?: string;
    /**
     * Datahub转储Id
     */
    DatahubId?: string;
    /**
     * 步骤列表
     */
    StepList?: Array<string>;
}
/**
 * DescribeConsumerGroup返回参数结构体
 */
export interface DescribeConsumerGroupResponse {
    /**
     * 返回的消费分组信息
     */
    Result?: ConsumerGroupResponse;
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * 创建后付费接口返回的 Data 数据结构
 */
export interface CreateInstancePostData {
    /**
     * CreateInstancePre返回固定为0，不能作为CheckTaskStatus的查询条件。只是为了保证和后台数据结构对齐。
     */
    FlowId?: number;
    /**
     * 订单号列表
     */
    DealNames?: Array<string>;
    /**
     * ckafka集群实例Id，当购买多个实例时，默认返回购买的第一个实例 id
     */
    InstanceId?: string;
    /**
     * 订单和购买实例对应映射列表
     */
    DealNameInstanceIdMapping?: Array<DealInstanceDTO>;
}
/**
 * DeleteDatahubTask返回参数结构体
 */
export interface DeleteDatahubTaskResponse {
    /**
     * 操作结果
     */
    Result?: DatahubTaskIdRes;
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * 实例属性返回结果对象
 */
export interface InstanceAttributesResponse {
    /**
     * ckafka集群实例Id
     */
    InstanceId?: string;
    /**
     * ckafka集群实例Name
     */
    InstanceName?: string;
    /**
     * 接入点 VIP 列表信息
     */
    VipList?: Array<VipEntity>;
    /**
     * 虚拟IP
     */
    Vip?: string;
    /**
     * 虚拟端口
     */
    Vport?: string;
    /**
     * 实例的状态。0: 创建中，1: 运行中，2: 删除中,  3: 已删除,  5: 隔离中,  7: 升级中,  -1: 创建失败
     */
    Status?: number;
    /**
     * 实例带宽，单位：Mbps
     */
    Bandwidth?: number;
    /**
     * 实例的存储大小，单位：GB
     */
    DiskSize?: number;
    /**
     * 可用区
     */
    ZoneId?: number;
    /**
     * VPC 的 ID，为空表示是基础网络
     */
    VpcId?: string;
    /**
     * 子网 ID， 为空表示基础网络
     */
    SubnetId?: string;
    /**
     * 实例健康状态， 1：健康，2：告警，3：异常
     */
    Healthy?: number;
    /**
     * 实例健康信息，当前会展示磁盘利用率，最大长度为256
     */
    HealthyMessage?: string;
    /**
     * 创建时间
     */
    CreateTime?: number;
    /**
     * 消息保存时间,单位为分钟
     */
    MsgRetentionTime?: number;
    /**
     * 自动创建 Topic 配置， 若该字段为空，则表示未开启自动创建
     */
    Config?: InstanceConfigDO;
    /**
     * 剩余创建分区数
     */
    RemainderPartitions?: number;
    /**
     * 剩余创建主题数
     */
    RemainderTopics?: number;
    /**
     * 当前创建分区数
     */
    CreatedPartitions?: number;
    /**
     * 当前创建主题数
     */
    CreatedTopics?: number;
    /**
     * 标签数组
     */
    Tags?: Array<Tag>;
    /**
     * 过期时间
     */
    ExpireTime?: number;
    /**
     * 可用区列表
     */
    ZoneIds?: Array<number | bigint>;
    /**
     * ckafka集群实例版本
     */
    Version?: string;
    /**
     * 最大分组数
     */
    MaxGroupNum?: number;
    /**
     * 售卖类型,0:标准版,1:专业版
     */
    Cvm?: number;
    /**
     * 类型
     */
    InstanceType?: string;
    /**
     * 表示该实例支持的特性。FEATURE_SUBNET_ACL:表示acl策略支持设置子网。
     */
    Features?: Array<string>;
    /**
     * 动态消息保留策略
     */
    RetentionTimeConfig?: DynamicRetentionTime;
    /**
     * 最大连接数
     */
    MaxConnection?: number;
    /**
     * 公网带宽
     */
    PublicNetwork?: number;
    /**
     * 时间
     */
    DeleteRouteTimestamp?: string;
    /**
     * 剩余创建分区数
     */
    RemainingPartitions?: number;
    /**
     * 剩余创建主题数
     */
    RemainingTopics?: number;
    /**
     * 动态硬盘扩容策略
     */
    DynamicDiskConfig?: DynamicDiskConfig;
    /**
     * 实例计费类型
     */
    InstanceChargeType?: string;
    /**
     * 集群类型
     */
    ClusterType?: string;
    /**
     * 免费分区数量
     */
    FreePartitionNumber?: number;
    /**
     * 弹性带宽上浮值
     */
    ElasticFloatBandwidth?: number;
    /**
     * ssl自定义证书id
     */
    CustomCertId?: string;
    /**
     * 集群topic默认 unclean.leader.election.enable配置: 1 开启 0 关闭
     */
    UncleanLeaderElectionEnable?: number;
}
/**
 * DescribeDatahubTopics返回参数结构体
 */
export interface DescribeDatahubTopicsResponse {
    /**
     * 主题列表
     */
    Result?: DescribeDatahubTopicsResp;
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * Topic配置
 */
export interface TopicParam {
    /**
     * 单独售卖Topic的Topic名称
     */
    Resource: string;
    /**
     * Offset类型，最开始位置earliest，最新位置latest，时间点位置timestamp
  注意：此字段可能返回 null，表示取不到有效值。
     */
    OffsetType?: string;
    /**
     * Offset类型为timestamp时必传，传时间戳，精确到秒
  注意：此字段可能返回 null，表示取不到有效值。
     */
    StartTime?: number;
    /**
     * Topic的TopicId【出参】
     */
    TopicId?: string;
    /**
     * 写入Topic时是否进行压缩，不开启填"none"，开启的话，可选择"gzip", "snappy", "lz4"中的一个进行填写。
     */
    CompressionType?: string;
    /**
     * 使用的Topic是否需要自动创建（目前只支持SOURCE流入任务）
     */
    UseAutoCreateTopic?: boolean;
    /**
     * 源topic消息1条扩增成msgMultiple条写入目标topic(该参数目前只有ckafka流入ckafka适用)
     */
    MsgMultiple?: number;
}
/**
 * Ckafka配置
 */
export interface KafkaParam {
    /**
     * 是否为自建集群
     */
    SelfBuilt: boolean;
    /**
     * ckafka集群实例Id
     */
    Resource: string;
    /**
     * 主题名，多个以“,”分隔
     */
    Topic?: string;
    /**
     * Offset类型，最开始位置earliest，最新位置latest，时间点位置timestamp
  注意：此字段可能返回 null，表示取不到有效值。
     */
    OffsetType?: string;
    /**
     * Offset类型为timestamp时必传，传时间戳，精确到秒
  注意：此字段可能返回 null，表示取不到有效值。
     */
    StartTime?: number;
    /**
     * 实例资源名称
  注意：此字段可能返回 null，表示取不到有效值。
     */
    ResourceName?: string;
    /**
     * 可用区
  注意：此字段可能返回 null，表示取不到有效值。
     */
    ZoneId?: number;
    /**
     * 主题Id
  注意：此字段可能返回 null，表示取不到有效值。
     */
    TopicId?: string;
    /**
     * Topic的分区数
  注意：此字段可能返回 null，表示取不到有效值。
     */
    PartitionNum?: number;
    /**
     * 启用容错实例/开启死信队列
  注意：此字段可能返回 null，表示取不到有效值。
     */
    EnableToleration?: boolean;
    /**
     * Qps 限制
     */
    QpsLimit?: number;
    /**
     * Table到Topic的路由，「分发到多个topic」开关打开时必传
  注意：此字段可能返回 null，表示取不到有效值。
     */
    TableMappings?: Array<TableMapping>;
    /**
     * 「分发到多个topic」开关，默认为false
     */
    UseTableMapping?: boolean;
    /**
     * 使用的Topic是否需要自动创建（目前只支持SOURCE流入任务，如果不使用分发到多个topic，需要在Topic字段填写需要自动创建的topic名）
     */
    UseAutoCreateTopic?: boolean;
    /**
     * 写入Topic时是否进行压缩，不开启填"none"，开启的话，填写"open"。
     */
    CompressionType?: string;
    /**
     * 源topic消息1条扩增成msgMultiple条写入目标topic(该参数目前只有ckafka流入ckafka适用)
     */
    MsgMultiple?: number;
    /**
     * 数据同步专用参数, 正常数据处理可为空, 实例级别同步: 仅同步元数据填写"META_SYNC_INSTANCE_TYPE", 同步元数据及全部topic内消息的填写"META_AND_DATA_SYNC_INSTANCE_TYPE"; topic级别同步: 选中的源和目标topic中的消息(需要目标实例也包含该topic)填写"DATA_SYNC_TYPE"
     */
    ConnectorSyncType?: string;
    /**
     * 数据同步专用参数, 当通过时,希望下游的消息写入分区与上游的一致,则填true,但下游分区小于上游时,会报错; 不需要一致则为false, 默认为false
     */
    KeepPartition?: boolean;
    /**
     * 正则匹配Topic列表
     */
    TopicRegularExpression?: string;
}
/**
 * Connection信息
 */
export interface Connection {
    /**
     * 主题名
     */
    TopicName?: string;
    /**
     * 消费组ID
     */
    GroupId?: string;
    /**
     * 主题Id
     */
    TopicId?: string;
}
/**
 * BatchCreateAcl返回参数结构体
 */
export interface BatchCreateAclResponse {
    /**
     * 状态码：0-修改成功，否则修改失败
     */
    Result?: number;
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * DeleteRoute请求参数结构体
 */
export interface DeleteRouteRequest {
    /**
     * ckafka集群实例Id
     */
    InstanceId: string;
    /**
     * 路由id
     */
    RouteId: number;
    /**
     * 调用方appId
     */
    CallerAppid?: number;
    /**
     * 设置定时删除路由时间,若DeleteRouteTime < now ,设置时间小于当前接口提交时间则立即执行;DeleteRouteTime > now,设置时间大于当前接口提交时间,则按照设置的时间,定时执行删除;  该参数设置提交后,无法撤销!!!
     */
    DeleteRouteTime?: string;
}
/**
 * MongoDB连接源参数
 */
export interface MongoDBConnectParam {
    /**
     * MongoDB的连接port
     */
    Port: number;
    /**
     * MongoDB连接源的用户名
     */
    UserName: string;
    /**
     * MongoDB连接源的密码
     */
    Password: string;
    /**
     * MongoDB连接源的实例资源
     */
    Resource: string;
    /**
     * MongoDB连接源是否为自建集群
     */
    SelfBuilt: boolean;
    /**
     * MongoDB连接源的实例vip，当为腾讯云实例时，必填
     */
    ServiceVip?: string;
    /**
     * MongoDB连接源的vpcId，当为腾讯云实例时，必填
     */
    UniqVpcId?: string;
    /**
     * 是否更新到关联的Datahub任务
     */
    IsUpdate?: boolean;
}
/**
 * BatchModifyTopicAttributes返回参数结构体
 */
export interface BatchModifyTopicAttributesResponse {
    /**
     * 返回结果
     */
    Result?: Array<BatchModifyTopicResultDTO>;
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * 数据处理——Value处理参数——转换时间格式参数
 */
export interface DateParam {
    /**
     * 时间格式
     */
    Format?: string;
    /**
     * 输入类型，string，unix时间戳，默认string
     */
    TargetType?: string;
    /**
     * 时区，默认GMT+8
     */
    TimeZone?: string;
}
/**
 * 实例缩容应答
 */
export interface ScalingDownResp {
    /**
     * 订单号列表
     */
    DealNames?: Array<string>;
}
/**
 * 建立私有连接的参数
 */
export interface PrivateLinkParam {
    /**
     * 客户实例的vip
     */
    ServiceVip: string;
    /**
     * 客户实例的vpcId
     */
    UniqVpcId: string;
}
/**
 * 创建主题返回
 */
export interface CreateTopicResp {
    /**
     * 主题Id
     */
    TopicId?: string;
}
/**
 * 任务状态返回对象
 */
export interface TaskStatusResponse {
    /**
     * 任务状态:
  0 成功
  1 失败
  2 进行中
     */
    Status?: number;
    /**
     * 输出信息
     */
    Output?: string;
}
/**
 * 值支持一拆多，即将一个值拆为一个数组
 */
export interface SplitParam {
    /**
     * 分隔符
     */
    Regex: string;
}
/**
 * DescribeTopicDetail请求参数结构体
 */
export interface DescribeTopicDetailRequest {
    /**
     * ckafka集群实例Id
     */
    InstanceId: string;
    /**
     * （过滤条件）按照topicName过滤，支持模糊查询
     */
    SearchWord?: string;
    /**
     * 偏移量，不填默认为0
     */
    Offset?: number;
    /**
     * 返回数量，不填则默认 10，最大值20，取值要大于0
     */
    Limit?: number;
    /**
     * Acl预设策略名称
     */
    AclRuleName?: string;
    /**
     * 根据特定的属性排序(目前支持PartitionNum/CreateTime)
     */
    OrderBy?: string;
    /**
     * 0-顺序、1-倒序
     */
    OrderType?: number;
    /**
     * 目前支持 ReplicaNum （副本数）筛选
     */
    Filters?: Array<Filter>;
}
/**
 * DescribeGroupOffsets返回参数结构体
 */
export interface DescribeGroupOffsetsResponse {
    /**
     * 返回结果
     */
    Result?: GroupOffsetResponse;
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * 消息记录
 */
export interface ConsumerRecord {
    /**
     * 主题名
     */
    Topic?: string;
    /**
     * 分区id
     */
    Partition?: number;
    /**
     * 位点
     */
    Offset?: number;
    /**
     * 消息key
  注意：此字段可能返回 null，表示取不到有效值。
     */
    Key?: string;
    /**
     * 消息value
  注意：此字段可能返回 null，表示取不到有效值。
     */
    Value?: string;
    /**
     * 消息时间戳
     */
    Timestamp?: number;
    /**
     * 消息headers
  注意：此字段可能返回 null，表示取不到有效值。
     */
    Headers?: string;
}
/**
 * DeleteGroup返回参数结构体
 */
export interface DeleteGroupResponse {
    /**
     * 返回结果
     */
    Result?: JgwOperateResponse;
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * CreateToken返回参数结构体
 */
export interface CreateTokenResponse {
    /**
     * token串
     */
    Result?: string;
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * DescribeGroupOffsets请求参数结构体
 */
export interface DescribeGroupOffsetsRequest {
    /**
     * ckafka集群实例Id
     */
    InstanceId: string;
    /**
     * Kafka 消费分组
     */
    Group: string;
    /**
     * group 订阅的主题名称数组，如果没有该数组，则表示指定的 group 下所有 topic 信息
     */
    Topics?: Array<string>;
    /**
     * 模糊匹配 topicName
     */
    SearchWord?: string;
    /**
     * 本次查询的偏移位置，默认为0
     */
    Offset?: number;
    /**
     * 本次返回结果的最大个数，默认为50，最大值为50
     */
    Limit?: number;
}
/**
 * Datahub Topic详情
 */
export interface DescribeDatahubTopicResp {
    /**
     * 名称
     */
    Name?: string;
    /**
     * Topic名称
     */
    TopicName?: string;
    /**
     * Topic Id
     */
    TopicId?: string;
    /**
     * 分区数
     */
    PartitionNum?: number;
    /**
     * 过期时间
     */
    RetentionMs?: number;
    /**
     * 备注
     */
    Note?: string;
    /**
     * 用户名
     */
    UserName?: string;
    /**
     * 密码
     */
    Password?: string;
    /**
     * 状态，1使用中，2删除中
     */
    Status?: number;
    /**
     * 服务路由地址
     */
    Address?: string;
}
/**
 * 实例详情
 */
export interface InstanceDetail {
    /**
     * ckafka集群实例Id
     */
    InstanceId?: string;
    /**
     * ckafka集群实例名称
     */
    InstanceName?: string;
    /**
     * 访问实例的vip 信息
     */
    Vip?: string;
    /**
     * 访问实例的端口信息
     */
    Vport?: string;
    /**
     * 虚拟IP列表
     */
    VipList?: Array<VipEntity>;
    /**
     * 实例的状态。0: 创建中，1: 运行中，2: 删除中,  3: 已删除,  5: 隔离中,  7: 升级中,  -1: 创建失败
     */
    Status?: number;
    /**
     * 实例带宽，单位Mbps
     */
    Bandwidth?: number;
    /**
     * ckafka集群实例磁盘大小，单位G
     */
    DiskSize?: number;
    /**
     * 可用区域ID
     */
    ZoneId?: number;
    /**
     * vpcId，如果为空，说明是基础网络
     */
    VpcId?: string;
    /**
     * 子网id
     */
    SubnetId?: string;
    /**
     * 实例是否续费，int  枚举值：1表示自动续费，2表示明确不自动续费
     */
    RenewFlag?: number;
    /**
     * 实例状态 int：1表示健康，2表示告警，3 表示实例状态异常
     */
    Healthy?: number;
    /**
     * 实例状态信息
     */
    HealthyMessage?: string;
    /**
     * 实例创建时间
     */
    CreateTime?: number;
    /**
     * 实例过期时间
     */
    ExpireTime?: number;
    /**
     * 是否为内部客户。值为1 表示内部客户
     */
    IsInternal?: number;
    /**
     * Topic个数
     */
    TopicNum?: number;
    /**
     * 标识tag
     */
    Tags?: Array<Tag>;
    /**
     * kafka版本信息
     */
    Version?: string;
    /**
     * 跨可用区
     */
    ZoneIds?: Array<number | bigint>;
    /**
     * ckafka售卖类型
     */
    Cvm?: number;
    /**
     * ckafka集群实例类型
     */
    InstanceType?: string;
    /**
     * ckafka集群实例磁盘类型
     */
    DiskType?: string;
    /**
     * 当前规格最大Topic数
     */
    MaxTopicNumber?: number;
    /**
     * 当前规格最大Partition数
     */
    MaxPartitionNumber?: number;
    /**
     * 计划升级配置时间
     */
    RebalanceTime?: string;
    /**
     * 实例当前partition数量
     */
    PartitionNumber?: number;
    /**
     * ckafka集群实例公网带宽类型
     */
    PublicNetworkChargeType?: string;
    /**
     * 公网带宽 最小3Mbps  最大999Mbps 仅专业版支持填写
     */
    PublicNetwork?: number;
    /**
     * ckafka集群实例底层集群类型
     */
    ClusterType?: string;
    /**
     * 实例功能列表
     */
    Features?: Array<string>;
}
/**
 * 实例 / topic 维度限流策略
 */
export interface InstanceQuotaConfigResp {
    /**
     * 生产限流大小，单位 MB/s
  注意：此字段可能返回 null，表示取不到有效值。
     */
    QuotaProducerByteRate: number;
    /**
     * 消费限流大小，单位 MB/s
  注意：此字段可能返回 null，表示取不到有效值。
     */
    QuotaConsumerByteRate: number;
}
/**
 * DescribeTopicDetail返回参数结构体
 */
export interface DescribeTopicDetailResponse {
    /**
     * 返回的主题详情实体
     */
    Result?: TopicDetailResponse;
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * DeleteAcl请求参数结构体
 */
export interface DeleteAclRequest {
    /**
     * ckafka集群实例Id
     */
    InstanceId: string;
    /**
     * Acl资源类型，(2:TOPIC，3:GROUP，4:CLUSTER)
     */
    ResourceType: number;
    /**
     * 资源名称，和resourceType相关，如当resourceType为TOPIC时，则该字段表示topic名称，当resourceType为GROUP时，该字段表示group名称，当resourceType为CLUSTER时，该字段可为空。
     */
    ResourceName: string;
    /**
     * Acl操作方式，(2:ALL，3:READ，4:WRITE，5:CREATE，6:DELETE，7:ALTER，8:DESCRIBE，9:CLUSTER_ACTION，10:DESCRIBE_CONFIGS，11:ALTER_CONFIGS，12:IDEMPOTENT_WRITE)
     */
    Operation: number;
    /**
     * 权限类型，(2:DENY，3:ALLOW)，当前ckafka支持ALLOW(相当于白名单)，其它用于后续兼容开源kafka的acl时使用
     */
    PermissionType: number;
    /**
     * 默认为\*，表示任何host都可以访问，当前ckafka不支持host为\*，但是后面开源kafka的产品化会直接支持
     */
    Host?: string;
    /**
     * 用户列表，默认为*，表示任何user都可以访问，当前用户只能是用户列表中包含的用户
     */
    Principal?: string;
}
/**
 * CreateInstancePost返回参数结构体
 */
export interface CreateInstancePostResponse {
    /**
     * 返回结果
     */
    Result?: JgwOperateResponse;
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * RouteDTO
 */
export interface RouteDTO {
    /**
     * 路由Id
     */
    RouteId?: number;
}
/**
 * DescribeDatahubTask返回参数结构体
 */
export interface DescribeDatahubTaskResponse {
    /**
     * 返回结果
     */
    Result?: DescribeDatahubTaskRes;
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * FetchLatestDatahubMessageList请求参数结构体
 */
export interface FetchLatestDatahubMessageListRequest {
    /**
     * 弹性topic名称
     */
    Name: string;
    /**
     * 分区id
     */
    Partition: number;
    /**
     * 位点信息
     */
    Offset?: number;
    /**
     * 最大查询条数，最小1，最大100
     */
    MessageCount?: number;
}
/**
 * SQLServer连接源参数
 */
export interface SQLServerConnectParam {
    /**
     * SQLServer的连接port
     */
    Port: number;
    /**
     * SQLServer连接源的用户名
     */
    UserName: string;
    /**
     * SQLServer连接源的密码
     */
    Password: string;
    /**
     * SQLServer连接源的实例资源
     */
    Resource: string;
    /**
     * SQLServer连接源的实例vip，当为腾讯云实例时，必填
     */
    ServiceVip?: string;
    /**
     * SQLServer连接源的vpcId，当为腾讯云实例时，必填
     */
    UniqVpcId?: string;
    /**
     * 是否更新到关联的Dip任务
     */
    IsUpdate?: boolean;
}
/**
 * CreateConnectResource返回参数结构体
 */
export interface CreateConnectResourceResponse {
    /**
     * 连接源的Id
     */
    Result?: ConnectResourceResourceIdResp;
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * 消费组偏移量返回结果
 */
export interface GroupOffsetResponse {
    /**
     * 符合调节的总结果数
     */
    TotalCount?: number;
    /**
     * 该主题分区数组，其中每个元素为一个 json object
     */
    TopicList?: Array<GroupOffsetTopic>;
}
/**
 * 详细类别的价格
 */
export interface InquiryDetailPrice {
    /**
     * 额外内网带宽价格
  注意：此字段可能返回 null，表示取不到有效值。
     */
    BandwidthPrice?: InquiryBasePrice;
    /**
     * 硬盘价格
  注意：此字段可能返回 null，表示取不到有效值。
     */
    DiskPrice?: InquiryBasePrice;
    /**
     * 额外分区价格
  注意：此字段可能返回 null，表示取不到有效值。
     */
    PartitionPrice?: InquiryBasePrice;
    /**
     * 额外Topic价格
  注意：此字段可能返回 null，表示取不到有效值。
     */
    TopicPrice?: InquiryBasePrice;
    /**
     * 实例套餐价格
     */
    InstanceTypePrice?: InquiryBasePrice;
}
/**
 * InquireCkafkaPrice接口询价返回值
 */
export interface InquireCkafkaPriceResp {
    /**
     * 实例价格
     */
    InstancePrice?: InquiryPrice;
    /**
     * 公网带宽价格
  注意：此字段可能返回 null，表示取不到有效值。
     */
    PublicNetworkBandwidthPrice?: InquiryPrice;
}
/**
 * DescribeDatahubTasks返回参数结构体
 */
export interface DescribeDatahubTasksResponse {
    /**
     * 返回任务