/** * 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,可通过[DescribeInstances](https://cloud.tencent.com/document/product/597/40835)接口获取 */ InstanceId: string; /** * Acl资源类型,(2:TOPIC,3:GROUP,4:CLUSTER) */ ResourceType: number; /** * 资源名称,和resourceType相关,如当resourceType为TOPIC时,则该字段表示topic名称,当resourceType为GROUP时,该字段表示group名称,当resourceType为CLUSTER时,该字段可为空。 */ ResourceName: string; /** * 偏移位置 */ Offset?: number; /** * 个数限制,默认值为50,最大值为50。 */ Limit?: number; /** * 关键字匹配 */ SearchWord?: string; } /** * DescribeTopicSyncReplica返回参数结构体 */ export interface DescribeTopicSyncReplicaResponse { /** *
返回topic 副本详情
*/ Result?: TopicInSyncReplicaResult; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * FetchMessageByOffset请求参数结构体 */ export interface FetchMessageByOffsetRequest { /** *ckafka集群实例Id,可通过DescribeInstances接口获取
*/ InstanceId: string; /** *主题名,可通过DescribeTopic接口获取
*/ Topic: string; /** *分区id
*/ Partition: number; /** *位点信息
*/ Offset: number; } /** * 查询连接源具体数据的返参 */ export interface DescribeConnectResourceResp { /** * 连接源的Id */ ResourceId?: string; /** * 连接源名称 */ ResourceName?: string; /** * 连接源描述 */ Description?: string; /** * 连接源类型 */ Type?: string; /** * 连接源的状态 枚举值: -1 (创建失败) 、0 (创建中) 、 1 (运行中)、 2 (删除中) 、 4 (删除失败) 、 5 (配置更改中) 、 6 (配置更改失败) 、 7 (异常) */ Status?: number; /** * 连接源的创建时间 */ CreateTime?: string; /** * 连接源的异常信息 */ ErrorMessage?: string; /** * 连接源的当前所处步骤 */ CurrentStep?: string; /** * 步骤列表 注意:此字段可能返回 null,表示取不到有效值。 */ StepList?: Arrayckafka集群实例Id
取值参考:DescribeInstances
*/ 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,可通过[DescribeInstances](https://cloud.tencent.com/document/product/597/40835)接口获取 */ InstanceId: string; /** * Acl资源类型,目前只支持Topic,枚举值列表:Topic */ ResourceType: string; /** * ACL规则匹配类型,目前支持前缀匹配与预设策略,枚举值列表:PREFIXED/PRESET */ PatternType: string; /** * 规则名称 */ RuleName: string; /** * 设置的ACL规则列表 */ RuleList: Array返回的实例详情结果对象
*/ Result?: InstanceDetailResponse; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 实例路由 */ export interface InstanceRoute { /** * ckafka集群实例Id */ InstanceId: string; /** * 路由Id */ RouteId: number; } /** * DescribeTaskStatus请求参数结构体 */ export interface DescribeTaskStatusRequest { /** * 流程Id */ FlowId: number; } /** * DescribeAclRule请求参数结构体 */ export interface DescribeAclRuleRequest { /** * ckafka集群实例Id,可通过[DescribeInstances](https://cloud.tencent.com/document/product/597/40835)接口获取 */ InstanceId: string; /** * ACL规则名 */ RuleName?: string; /** * ACL规则匹配类型 (PREFIXED:前缀匹配,PRESET:预设策略) */ PatternType?: string; /** * 是否读取简略的ACL规则,默认值为false,表示不读取简略的ACL规则。 */ IsSimplified?: boolean; } /** * RestartDatahubTask请求参数结构体 */ export interface RestartDatahubTaskRequest { /** * 任务id */ TaskId: string; } /** * 操作型结果返回值 */ 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; /** * 用于控制会话的持久性。cleanSession 为true时,连接时会创建一个全新的会话。 cleanSession = false时,连接时会恢复之前的会话。 */ 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; } /** * 安全组路由信息 */ export interface SecurityGroupRoute { /** * 路由信息 */ InstanceRoute?: InstanceRoute; /** * 关联的安全组列表 */ SecurityGroupIds?: Array返回结果。注意,列表中不返回具体的消息内容(key、value),如果需要查询具体消息内容,请使用FetchMessageByOffset接口
*/ Result?: Array私有网络Id,可通过DescribeVpcs接口获取
*/ VpcId: string; /** *子网Id,可通过DescribeSubnets接口获取
*/ SubnetId: string; /** *ckafka集群实例名称,是一个长度不超过128的任意字符。
*/ InstanceName?: 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; /** *实例版本。目前支持当前支持"2.4.1", "2.4.2","2.8.1", "3.2.3",默认取值"2.4.1"。"2.4.1" 与 "2.4.2" 属于同一个版本,传任意一个均可。
*/ KafkaVersion?: string; /** *实例类型。"standard":标准版,"profession":专业版。 (标准版仅国际站支持,国内站目前支持专业版)
*/ SpecificationsType?: string; /** *专业版实例磁盘类型,标准版实例不需要填写。"CLOUD_SSD":SSD云硬盘;"CLOUD_BASIC":高性能云硬盘。不传默认值为 "CLOUD_BASIC"
*/ DiskType?: string; /** *实例内网峰值带宽,默认值为40。单位 MB/s。标准版需传入当前实例规格所对应的峰值带宽。注意如果创建的实例为专业版实例,峰值带宽,分区数等参数配置需要满足专业版的计费规格,可以通过以下链接查看计费规格:https://cloud.tencent.com/document/product/597/11745
*/ BandWidth?: number; /** *实例硬盘大小,默认取值为500,步长设置为100。需要满足当前实例的计费规格,可以通过以下链接查看计费规格:https://cloud.tencent.com/document/product/597/122562
*/ DiskSize?: number; /** *实例最大分区数量,需要满足当前实例的计费规格。默认值为800,步长为100。可以通过以下链接查看计费规格:https://cloud.tencent.com/document/product/597/122563
*/ Partition?: number; /** *实例最大 topic 数量,需要满足当前实例的计费规格。默认值为800,步长设置为100。
*/ TopicNum?: number; /** *实例所在的可用区。当创建多可用区实例时,该参数为创建的默认接入点所在子网的可用区 id。ZoneId、ZoneIds不能同时为空,可通过DescribeCkafkaZone接口获取。
*/ ZoneId?: number; /** *当前实例是否为多可用区实例。
*/ MultiZoneFlag?: boolean; /** *当实例为多可用区实例时,多可用区 id 列表。注意参数 ZoneId 对应的多可用区需要包含在该参数数组中。ZoneId、ZoneIds不能同时为空,可通过DescribeCkafkaZone接口获取。
*/ ZoneIds?: Array购买实例数量。非必填,默认值为 1。当传入该参数时,会创建多个 instanceName 加后缀区分的实例
*/ InstanceNum?: number; /** *公网带宽大小,单位 Mbps。默认是没有加上免费 3Mbps 带宽。例如总共需要 3Mbps 公网带宽,此处传 0;总共需要 6Mbps 公网带宽,此处传 3。需要保证传入参数为 3 的整数倍
*/ PublicNetworkMonthly?: number; /** *标签
*/ Tags?: Array弹性带宽开关 0不开启 1开启(0默认)
*/ ElasticBandwidthSwitch?: number; /** *自定义证书Id,仅当SpecificationsType为profession时生效,支持自定义证书能力
可通过DescribeCertificateDetail接口获取
*/ CustomSSLCertId?: string; } /** * 修改实例属性的配置对象 */ export interface ModifyInstanceAttributesConfig { /** * 自动创建 true 表示开启,false 表示不开启 */ AutoCreateTopicEnable?: boolean; /** * 新创建主题的默认分区数,如果AutoCreateTopicEnable设置为true没有设置该值时,默认设置为3 */ DefaultNumPartitions?: number; /** * 新创建主题的默认副本数,如果AutoCreateTopicEnable设置为true没有指定该值时默认设置为2 */ DefaultReplicationFactor?: number; } /** * AuthorizeToken请求参数结构体 */ export interface AuthorizeTokenRequest { /** * ckafka集群实例Id, 可通过[DescribeInstances](https://cloud.tencent.com/document/product/597/40835)接口获取 */ 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返回的结果
*/ Result?: TopicResult; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 消费组返回结果实体 */ export interface ConsumerGroupResponse { /** * 符合条件的消费组数量 */ TotalCount?: number; /** * 主题列表 */ TopicList?: Array实例Id
取值参考:DescribeInstances
*/ InstanceId: string; /** *只能包含字母、数字、下划线、“-”、“.”
*/ TopicName: string; /** *Partition个数,大于0
*/ PartitionNum: number; /** *副本个数,不能多于 broker 数,最大为3
*/ ReplicaNum: number; /** *ip白名单开关, 1:打开 0:关闭,默认不打开
*/ EnableWhiteList?: number; /** *Ip白名单列表,配额限制,enableWhileList=1时必选
*/ IpWhiteList?: Array清理日志策略,日志清理模式,默认为"delete"。"delete":日志按保存时间删除,"compact":日志按 key 压缩,"compact, delete":日志按 key 压缩且会按保存时间删除。
*/ CleanUpPolicy?: string; /** *主题备注
入参限制:不超过 64 个字符
*/ Note?: string; /** *最小同步副本数
默认值:1
最小值为1
*/ MinInsyncReplicas?: number; /** *是否允许未同步的副本选为leader,0:不允许,1:允许,默认不允许
*/ UncleanLeaderElectionEnable?: number; /** *可选参数,消息保留时间
取值范围:[60000, 7776000000]
单位:毫秒
默认值:7200000
*/ RetentionMs?: number; /** *Segment分片滚动的时长
单位:毫秒
默认值:86400000
最小值为86400000ms(1天)
*/ SegmentMs?: number; /** *主题消息最大值,单位为 Byte,最小值1024Bytes(即1KB),最大值为12582912Bytes(即12MB)
*/ MaxMessageBytes?: number; /** *预设ACL规则, 1:打开 0:关闭,默认不打开
*/ EnableAclRule?: number; /** *预设ACL规则的名称
*/ AclRuleName?: string; /** *可选, 保留文件大小. 默认为-1,单位Byte, 当前最小值为1073741824。
取值范围:[1073741824, 1099511627776]
单位:字节
特殊值:-1表示无限制
*/ RetentionBytes?: number; /** *标签列表
*/ Tags?: Array消息保存的时间类型:CreateTime/LogAppendTime
*/ LogMsgTimestampType?: string; } /** * 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?: Arrayckafka集群实例Id
取值参考:DescribeInstances
*/ 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
取值参考:DescribeInstances
*/ InstanceId: string; /** *ACL规则名
*/ RuleName: string; /** *修改预设规则时传入,是否应用到新增的Topic
枚举值:
默认值:0
*/ 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 { /** * ckafka集群实例id,可通过[DescribeInstances](https://cloud.tencent.com/document/product/597/40835)接口获取 */ InstanceId: string; /** * 自动化运维类别, 类别如下: QUOTA、ANALYSIS、RE_BALANCE、ELASTIC_BANDWIDTH */ MaintenanceType: string; /** * INSTANCE_STORAGE_CAPACITY(磁盘自动扩容)/MESSAGE_RETENTION_PERIOD(磁盘动态消息保留策略) */ MaintenanceSubtype: string; /** * 主题名 */ TopicName?: string; /** * 任务触发阈值 */ ConfigureThreshold?: number; /** * 任务调整步长 */ ConfigureStepSize?: number; /** * 任务调整上限 */ ConfigureLimit?: number; /** * 任务预期触发时间,存储从当日 0AM 开始偏移的秒数 */ PlannedTime?: number; /** * 任务额外信息 */ ExtraConfig?: string; /** * 任务状态,0 开启,1 关闭 */ 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返回地域枚举结果列表
*/ Result?: Array返回创建结果
*/ 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; /** * 网络类型:PUBLIC公网;VPC */ NetworkType?: string; /** * vpcId,NetworkType=VPC时必传 */ UniqVpcId?: string; /** * vip,NetworkType=VPC时必传 */ ServiceVip?: string; /** * 端口,NetworkType=VPC时必传 */ Port?: number; /** * 跨云同步下需要客户传递唯一Id标志一组资源 */ CrossNetResourceUniqueId?: string; /** * 跨云子网ID */ CrossNetVpcSubNetId?: 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?: ArrayCreateInstancePre返回固定为0,不能作为CheckTaskStatus的查询条件。只是为了保证和后台数据结构对齐。
*/ FlowId?: number; /** *订单号列表
*/ DealNames?: Arrayckafka集群实例Id,当购买多个实例时,默认返回购买的第一个实例 id
*/ InstanceId?: string; /** *订单和购买实例对应映射列表
*/ DealNameInstanceIdMapping?: ArrayCAM鉴权返回的eventId
*/ EventId?: string; } /** * 变配类型查询出参 */ export interface DescModifyType { /** * 变配类型 */ ModifyType?: number; /** * 是否迁移标志 */ MigrateFlag?: boolean; } /** * 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虚拟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过期时间
*/ ExpireTime?: number; /** *可用区列表
*/ ZoneIds?: Arrayckafka集群实例版本
*/ Version?: string; /** *最大分组数
*/ MaxGroupNum?: number; /** *售卖类型,0:标准版,1:专业版
*/ Cvm?: number; /** *实例类型 枚举列表: profession :专业版
standards2 :标准版premium :高级版serverless :serverless版
表示该实例支持的特性。FEATURE_SUBNET_ACL:表示acl策略支持设置子网。
*/ Features?: Array动态消息保留策略
*/ RetentionTimeConfig?: DynamicRetentionTime; /** *最大连接数
*/ MaxConnection?: number; /** *公网带宽
*/ PublicNetwork?: number; /** *该字段已废弃,无实际含义
*/ DeleteRouteTimestamp?: string; /** *剩余创建分区数
*/ RemainingPartitions?: number; /** *剩余创建主题数
*/ RemainingTopics?: number; /** *动态硬盘扩容策略
*/ DynamicDiskConfig?: DynamicDiskConfig; /** *系统维护时间
*/ SystemMaintenanceTime?: string; /** *实例级别消息最大大小
*/ MaxMessageByte?: number; /** *实例计费类型 POSTPAID_BY_HOUR 按小时付费; PREPAID 包年包月
*/ InstanceChargeType?: string; /** *是否开启弹性带宽白名单
1:已开启弹性带宽白名单;0:未开启弹性带宽白名单;
弹性带宽开通状态1:未开启弹性带宽;16: 开启弹性带宽中;32:开启弹性带宽成功;33:关闭弹性带宽中;34:关闭弹性带宽成功;64:开启弹性带宽失败;65:关闭弹性带宽失败;
*/ ElasticBandwidthOpenStatus?: number; /** *集群类型
CLOUD_IDC IDC集群CLOUD_CVM_SHARE CVM共享集群CLOUD_CVM_YUNTI 云梯CVM集群CLOUD_CVM CVM集群CLOUD_CDC CDC集群CLOUD_EKS_TSE EKS集群
免费分区数量
*/ FreePartitionNumber?: number; /** *弹性带宽上浮值
*/ ElasticFloatBandwidth?: number; /** *ssl自定义证书id 仅自定义证书实例集群返回
*/ CustomCertId?: string; /** *集群topic默认 unclean.leader.election.enable配置: 1 开启 0 关闭
*/ UncleanLeaderElectionEnable?: number; /** *实例删除保护开关: 1 开启 0 关闭
*/ DeleteProtectionEnable?: number; /** *实例级别消息保留大小
单位:bytes事务ID最大空闲时间,超时未提交的事务将被标记为过期
单位:ms */ TransactionalIdExpirationMs?: 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?: Arrayckafka集群实例Id,可通过DescribeInstances接口获取
*/ InstanceId: string; /** *(过滤条件)按照topicName过滤,支持模糊查询
*/ SearchWord?: string; /** *偏移量,不填默认为0
*/ Offset?: number; /** *返回数量,不填则默认 20,取值要大于0
*/ Limit?: number; /** *Acl预设策略名称
*/ AclRuleName?: string; /** *根据特定的属性排序(目前支持PartitionNum/CreateTime),默认值为CreateTime。
该参数为空时,默认按CreateTime倒序排序
*/ OrderBy?: string; /** *0-顺序、1-倒序,默认值为0。
*/ OrderType?: number; /** *目前支持 ReplicaNum (副本数)筛选
*/ Filters?: Array返回结果
*/ 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
取值参考:DescribeInstances
*/ InstanceId: string; /** *Kafka 消费分组
取值参考:DescribeGroup
*/ Group: string; /** *group 订阅的主题名称数组,如果没有该数组,则表示指定的 group 下所有 topic 信息
取值参考:DescribeTopic
*/ Topics?: Array模糊匹配 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; /** * 过期时间,单位ms */ 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实例的状态。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?: Arraykafka版本信息
*/ Version?: string; /** *跨可用区
*/ ZoneIds?: Arrayckafka售卖类型
*/ 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实例级别消息保留大小
单位:byte实例级别消息保留大小
*/ RetentionBytes?: number; } /** * 实例 / 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; } /** * 安全组路由信息返回结果 */ export interface SecurityGroupRouteResp { /** * 符合条件的安全组路由信息总数 */ TotalCount?: number; /** * 符合条件的安全组路由信息列表 */ SecurityGroupRoutes?: Array返回结果
*/ Result?: ConsumerRecord; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 数据处理——Value处理参数——正则替换参数 */ export interface RegexReplaceParam { /** * 正则表达式 */ Regex: string; /** * 替换新值 */ NewValue: string; } /** * DescribeSecurityGroupRoutes返回参数结构体 */ export interface DescribeSecurityGroupRoutesResponse { /** * 返回的安全组路由信息结果对象 */ Result?: SecurityGroupRouteResp; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * AclRule列表接口出参 */ export interface AclRule { /** * ACL规则名 */ RuleName?: string; /** * ckafka集群实例Id */ InstanceId?: string; /** * ACL规则匹配类型,目前只支持前缀匹配,枚举值列表:PREFIXED */ PatternType?: string; /** * 表示前缀匹配的前缀的值 */ Pattern?: string; /** * Acl资源类型,目前只支持Topic,枚举值列表:Topic */ ResourceType?: string; /** * 该规则所包含的ACL信息 */ AclList?: string; /** * 规则所创建的时间 */ CreateTimeStamp?: string; /** * 预设ACL规则是否应用到新增的topic中 */ IsApplied?: number; /** * 规则更新时间 */ UpdateTimeStamp?: string; /** * 规则的备注 */ Comment?: string; /** * 其中一个显示的对应的TopicName */ TopicName?: string; /** * 应用该ACL规则的Topic数 */ TopicCount?: number; /** * patternType的中文显示 */ PatternTypeTitle?: string; } /** * DescribeACL返回参数结构体 */ export interface DescribeACLResponse { /** * 返回的ACL结果集对象 */ Result?: AclResponse; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * topic消息堆积、占用磁盘排行 */ export interface TopicMessageHeapRanking { /** * 主题ID */ TopicId?: string; /** * 主题名称 */ TopicName?: string; /** * 分区数 */ PartitionNum?: number; /** * 副本数 */ ReplicaNum?: number; /** * Topic 流量,单位为MB。 */ TopicTraffic?: string; /** * topic消息堆积/占用磁盘,单位为Bytes。 */ MessageHeap?: number; } /** * InquireCkafkaPrice请求参数结构体 */ export interface InquireCkafkaPriceRequest { /** * 国内站标准版填写standards2, 国际站标准版填写standard,专业版填写profession,高级版填写premium */ InstanceType: string; /** * 购买/续费付费类型(购买时不填的话, 默认获取购买包年包月一个月的费用) */ InstanceChargeParam?: InstanceChargeParam; /** * 购买/续费时购买的实例数量(不填时, 默认为1个) */ InstanceNum?: number; /** * 实例内网带宽大小, 单位MB/s (购买时必填,专业版/高级版询价时带宽信息必填) */ Bandwidth?: number; /** * 实例的硬盘购买类型以及大小 (购买时必填,专业版/高级版询价时磁盘信息必填) */ InquiryDiskParam?: InquiryDiskParam; /** * 实例消息保留时间大小, 单位小时 (购买时必填) */ MessageRetention?: number; /** * 购买实例topic数, 单位个 (购买时必填) */ Topic?: number; /** * 购买实例分区数, 单位个 (购买时必填,专业版/高级版询价时带宽信息必填) 分区上限 最大值: 40000,步长: 100 可以通过以下链接查看规格限制: https://cloud.tencent.com/document/product/597/122563 */ Partition?: number; /** * 购买地域, 可通过查看DescribeCkafkaZone这个接口获取ZoneId */ ZoneIds?: Array返回结果
*/ Result?: GroupResponse; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeTopicSubscribeGroup接口出参 */ export interface TopicSubscribeGroup { /** * 总数 */ TotalCount?: number; /** * 消费分组状态数量信息 */ StatusCountInfo?: string; /** * 消费分组信息 */ GroupsInfo?: Array返回结果
*/ Result?: JgwOperateResponse; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * topic链接信息 */ export interface DescribeConnectInfoResultDTO { /** * ip地址 注意:此字段可能返回 null,表示取不到有效值。 */ IpAddr?: string; /** * 连结时间 注意:此字段可能返回 null,表示取不到有效值。 */ Time?: string; /** * 是否支持的版本 */ IsUnSupportVersion?: boolean; } /** * topic副本及详细信息 */ export interface TopicInSyncReplicaInfo { /** * 分区名称 */ Partition?: string; /** * Leader Id */ Leader?: number; /** * 副本集 */ Replica?: string; /** * ISR */ InSyncReplica?: string; /** * 起始Offset */ BeginOffset?: number; /** * 末端Offset */ EndOffset?: number; /** * 消息数 */ MessageCount?: number; /** * 未同步副本集 */ OutOfSyncReplica?: string; } /** * DescribeRegion请求参数结构体 */ export interface DescribeRegionRequest { /** *偏移量
*/ Offset?: number; /** *返回最大结果数
*/ Limit?: number; /** *业务字段,可忽略
枚举值:
默认值:ckafka
*/ Business?: string; /** *cdc专有集群业务字段,可忽略
*/ CdcId?: string; } /** * DescribeGroupInfo返回参数结构体 */ export interface DescribeGroupInfoResponse { /** * 返回的结果 */ Result?: Arrayckafka集群实例Id,可通过DescribeInstances接口获取
*/ InstanceId: string; /** *实例日志的最长保留时间,单位分钟,最大90天,最小为1min
*/ MsgRetentionTime?: number; /** *ckafka集群实例Name
*/ InstanceName?: string; /** *实例配置
*/ Config?: ModifyInstanceAttributesConfig; /** *动态消息保留策略配置
*/ DynamicRetentionConfig?: DynamicRetentionTime; /** *用于修改升级版本或升配定时任务的执行时间,Unix时间戳,精确到秒
*/ RebalanceTime?: number; /** *公网带宽 最小3Mbps 最大999Mbps 仅专业版支持填写
*/ PublicNetwork?: number; /** *动态硬盘扩容策略配置
* @deprecated */ DynamicDiskConfig?: DynamicDiskConfig; /** *实例级别单条消息大小(单位byte) 最大 12582912(不包含) 最小1024(不包含)
*/ MaxMessageByte?: number; /** *是否允许未同步的副本选为 leader: 1 开启 0 关闭
*/ UncleanLeaderElectionEnable?: number; /** *实例删除保护开关: 1 开启 0 关闭
*/ DeleteProtectionEnable?: number; /** *实例级别消息保留大小
单位:byte实例级别消息保留大小
*/ RetentionBytes?: number; /** *是否封禁高风险admin接口; true则封禁高风险adminApi; 关闭后不支持打开,仅专业版支持; 默认是false 对高风险admin接口不做处理
*/ AdminSecurity?: boolean; /** *事务ID最大空闲时间,超时未提交的事务将被标记为过期
取值范围:[3600000, 604800000]ckafka集群实例Id
取值参考:DescribeInstances
*/ InstanceId: string; /** *搜索关键字
*/ SearchWord?: string; /** *偏移量
*/ Offset?: number; /** *最大返回数量
默认值:20
*/ Limit?: number; /** *仅支持 GroupState 筛选, 支持的筛选状态有 Empty/Stable 注意:该参数只能在2.8/3.2 版本生效
*/ Filters?: Array(过滤条件)按照实例ID过滤
*/ InstanceId?: string; /** *(过滤条件)按照实例名,实例Id,可用区,私有网络id,子网id 过滤,支持模糊查询
*/ SearchWord?: string; /** *(过滤条件)实例的状态,不填默认返回全部
枚举值:
偏移量,不填默认为0。
*/ Offset?: number; /** *返回数量,不填则默认10,最大值20。
*/ Limit?: number; /** *匹配标签key值。
*/ TagKey?: string; /** *过滤器。filter.Name 支持('Ip', 'VpcId', 'SubNetId', 'InstanceType','InstanceId') ,filter.Values最多传递10个值.
*/ Filters?: Array已经废弃, 使用InstanceIdList
* @deprecated */ InstanceIds?: string; /** *按照实例ID过滤
*/ InstanceIdList?: Array根据标签列表过滤实例(取交集)
*/ TagList?: Array消费分组名称
*/ GroupName: string; /** *ckafka集群实例Id
取值参考:DescribeInstances
*/ InstanceId: string; /** *partition信息
*/ Partitions: Array指定topic,默认所有topic
*/ TopicName?: Arrayckafka集群实例Id,可通过DescribeInstances接口获取
*/ InstanceId: string; /** *磁盘大小 单位 GB 最大值为500000,步长100可以通过以下链接查看规格限制:https://cloud.tencent.com/document/product/597/122562
*/ DiskSize?: number; /** *峰值带宽 单位 MB/s可以通过以下链接查看规格限制及对应步长: https://cloud.tencent.com/document/product/597/11745
*/ BandWidth?: number; /** *分区上限 最大值: 40000, 步长: 100可以通过以下链接查看规格限制: https://cloud.tencent.com/document/product/597/122563
*/ Partition?: number; } /** * Cls类型入参 */ export interface ClsParam { /** * 生产的信息是否为json格式 */ DecodeJson: boolean; /** * cls日志主题id */ Resource: string; /** * cls日志集id */ LogSet?: string; /** * 当DecodeJson为false时必填 */ ContentKey?: string; /** * 指定消息中的某字段内容作为cls日志的时间。 字段内容格式需要是秒级时间戳 */ TimeField?: string; } /** * 分区详情 */ export interface TopicPartitionDO { /** * Partition 分区ID */ Partition?: number; /** * Leader 运行状态,0表示正常运行 */ LeaderStatus?: number; /** * ISR 个数 */ IsrNum?: number; /** * 副本个数 */ ReplicaNum?: number; } /** * 数据处理-解析参数 */ export interface AnalyseParam { /** * 解析格式,JSON,DELIMITER分隔符,REGULAR正则提取,SOURCE处理上层所有结果 */ Format: string; /** * 分隔符、正则表达式 */ Regex?: string; /** * 需再次处理的KEY——模式 */ InputValueType?: string; /** * 需再次处理的KEY——KEY表达式 */ InputValue?: string; } /** * 批量修改topic参数 */ export interface BatchModifyTopicInfo { /** * 主题名 */ TopicName: string; /** * 分区数 */ PartitionNum?: number; /** * 备注 */ Note?: string; /** * 副本数 */ ReplicaNum?: number; /** * 消息删除策略,可以选择delete 或者compact */ CleanUpPolicy?: string; /** * 当producer设置request.required.acks为-1时,min.insync.replicas指定replicas的最小数目 */ MinInsyncReplicas?: number; /** * 是否允许非ISR的副本成为Leader */ UncleanLeaderElectionEnable?: boolean; /** * topic维度的消息保留时间(毫秒)范围1 分钟到90 天 */ RetentionMs?: number; /** * topic维度的消息保留大小,单位为Byte,范围1 GB到1024 GB。 */ RetentionBytes?: number; /** * Segment分片滚动的时长(毫秒),范围1 天到90 天 */ SegmentMs?: number; /** * 批次的消息大小,范围1 KB到12 MB */ MaxMessageBytes?: number; /** * 消息保存的时间类型:CreateTime/LogAppendTime */ LogMsgTimestampType?: string; } /** * 消息价格实体 */ export interface Price { /** * 折扣价 */ RealTotalCost?: number; /** * 原价 */ TotalCost?: number; } /** * Es修改连接源参数 */ export interface EsModifyConnectParam { /** * Es连接源的实例资源【不支持修改】 */ Resource: string; /** * Es的连接port【不支持修改】 */ Port?: number; /** * Es连接源的实例vip【不支持修改】 */ ServiceVip?: string; /** * Es连接源的vpcId【不支持修改】 */ UniqVpcId?: string; /** * Es连接源的用户名 */ UserName?: string; /** * Es连接源的密码 */ Password?: string; /** * Es连接源是否为自建集群【不支持修改】 */ SelfBuilt?: boolean; /** * 是否更新到关联的Datahub任务 */ IsUpdate?: boolean; } /** * DescribeTypeInstances请求参数结构体 */ export interface DescribeTypeInstancesRequest { /** *(过滤条件)按照实例ID过滤
*/ InstanceId?: string; /** *(过滤条件)按照实例名称过滤,支持模糊查询
*/ SearchWord?: string; /** *(过滤条件)实例的状态,不填默认返回全部
枚举值:
偏移量,不填默认为0
*/ Offset?: number; /** *返回数量,不填则默认10,最大值100
*/ Limit?: number; /** *匹配标签key值。
*/ TagKey?: string; } /** * SendMessage请求参数结构体 */ export interface SendMessageRequest { /** * DataHub接入ID */ DataHubId: string; /** * 发送消息内容(单次请求最多500条) */ Message: Arrayckafka集群实例版本
*/ KafkaVersion?: string; /** *broker版本信息
*/ CurBrokerVersion?: string; /** *最新版本信息
*/ LatestBrokerVersion?: Array允许跨大版本内核升级
*/ AllowUpgradeHighVersion?: boolean; /** *允许升级的大版本
*/ HighVersionSet?: Array允许小版本号配置自动删除消费者组
*/ AllowAutoDeleteTimestamp?: boolean; /** *允许修改事务ID过期时间配置
*/ AllowModifyTxnIdExpiration?: boolean; } /** * DescribeConnectResources返回参数结构体 */ export interface DescribeConnectResourcesResponse { /** * 连接源列表 */ Result?: DescribeConnectResourcesResp; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeCkafkaVersion返回参数结构体 */ export interface DescribeCkafkaVersionResponse { /** * 实例版本信息 */ Result?: InstanceVersion; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 主题详情 */ export interface TopicDetail { /** * 主题名 */ TopicName?: string; /** * 主题Id */ TopicId?: string; /** * 分区数 */ PartitionNum?: number; /** * topic副本数 最小值 1,最大值 3 */ ReplicaNum?: number; /** * 备注 */ Note?: string; /** * 创建时间 */ CreateTime?: number; /** * 是否开启ip鉴权白名单,true表示开启,false表示不开启 */ EnableWhiteList?: boolean; /** * ip白名单中ip个数 */ IpWhiteListCount?: number; /** * 数据备份cos bucket: 转存到cos 的bucket地址 */ ForwardCosBucket?: string; /** * 数据备份cos 状态: 1 不开启数据备份,0 开启数据备份 */ ForwardStatus?: number; /** * 数据备份到cos的周期频率 */ ForwardInterval?: number; /** * 高级配置 */ Config?: Config; /** * 消息保留时间配置(用于动态配置变更记录) */ RetentionTimeConfig?: TopicRetentionTimeConfigRsp; /** * 0:正常,1:已删除,2:删除中 */ Status?: number; /** * 标签列表 注意:此字段可能返回 null,表示取不到有效值。 */ Tags?: Array返回的结果
*/ Result?: InstanceResponse; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 数据处理ROW输出格式配置 */ export interface RowParam { /** * 行内容,KEY_VALUE,VALUE */ RowContent: string; /** * key和value间的分隔符 */ KeyValueDelimiter?: string; /** * 元素建的分隔符 */ EntryDelimiter?: string; } /** * 过滤器参数 */ export interface FilterMapParam { /** * Key值 */ Key: string; /** * 匹配模式,前缀匹配PREFIX,后缀匹配SUFFIX,包含匹配CONTAINS,EXCEPT除外匹配,数值匹配NUMBER,IP匹配IP */ MatchMode: string; /** * Value值 */ Value: string; /** * 固定REGULAR */ Type?: string; } /** * 消息字段与 es 索引的映射关系 */ export interface EsRecordMapping { /** * es 索引成员名称 */ ColumnName?: string; /** * 消息字段名称 */ JsonKey?: string; } /** * topic 流量排行 */ export interface TopicFlowRanking { /** * 主题Id */ TopicId?: string; /** * 主题名称 */ TopicName?: string; /** * 分区数 */ PartitionNum?: number; /** * 副本数 */ ReplicaNum?: number; /** * Topic 流量,单位MB(设置date时以sum方式聚合) */ TopicTraffic?: string; /** * Topic 消息堆积 */ MessageHeap?: number; } /** * GroupInfo内部topic对象 */ export interface GroupInfoTopics { /** * 分配的 topic 名称 */ Topic?: string; /** * 分配的 partition 信息 */ Partitions?: ArrayCreateInstancePre返回固定为0,不能作为CheckTaskStatus的查询条件。只是为了保证和后台数据结构对齐。
*/ FlowId?: number; /** *订单号列表
*/ DealNames?: Arrayckafka集群实例Id,当购买多个实例时,默认返回购买的第一个实例 id
*/ InstanceId?: string; /** *订单和购买实例对应映射列表
*/ DealNameInstanceIdMapping?: ArrayCAM鉴权返回的eventId
*/ EventId?: string; } /** * Es连接源参数 */ export interface EsConnectParam { /** * Es的连接port */ Port: number; /** * Es连接源的用户名 */ UserName: string; /** * Es连接源的密码 */ Password: string; /** * Es连接源的实例资源 */ Resource: string; /** * Es连接源是否为自建集群 */ SelfBuilt: boolean; /** * Es连接源的实例vip,当为腾讯云实例时,必填 */ ServiceVip?: string; /** * Es连接源的vpcId,当为腾讯云实例时,必填 */ UniqVpcId?: string; /** * 是否更新到关联的Datahub任务 注意:此字段可能返回 null,表示取不到有效值。 */ IsUpdate?: boolean; } /** * Ctsdb连接源参数(更新) */ export interface CtsdbModifyConnectParam { /** * Ctsdb的连接port */ Port?: number; /** * Ctsdb连接源的实例vip */ ServiceVip?: string; /** * Ctsdb连接源的vpcId */ UniqVpcId?: string; /** * Ctsdb连接源的用户名 */ UserName?: string; /** * Ctsdb连接源的密码 */ Password?: string; /** * Ctsdb连接源的实例资源 */ Resource?: string; } /** * 动态硬盘扩容配置 */ export interface DynamicDiskConfig { /** * 动态硬盘扩容配置开关(0: 关闭,1: 开启) 注意:此字段可能返回 null,表示取不到有效值。 */ Enable?: number; /** * 每次磁盘动态扩容大小百分比 注意:此字段可能返回 null,表示取不到有效值。 */ StepForwardPercentage?: number; /** * 磁盘配额百分比触发条件,即消息达到此值触发硬盘自动扩容事件 注意:此字段可能返回 null,表示取不到有效值。 */ DiskQuotaPercentage?: number; /** * 最大扩容硬盘大小,以 GB 为单位 注意:此字段可能返回 null,表示取不到有效值。 */ MaxDiskSpace?: number; } /** * Doris 连接源修改参数 */ export interface DorisModifyConnectParam { /** * Doris 连接源的实例资源 */ Resource: string; /** * Doris jdbc 负载均衡连接 port,通常映射到 fe 的 9030 端口 */ Port?: number; /** * Doris 连接源的实例vip,当为腾讯云实例时,必填 */ ServiceVip?: string; /** * Doris 连接源的vpcId,当为腾讯云实例时,必填 */ UniqVpcId?: string; /** * Doris 连接源的用户名 */ UserName?: string; /** * Doris 连接源的密码 */ Password?: string; /** * 是否更新到关联的Datahub任务 */ IsUpdate?: boolean; /** * Doris 连接源是否为自建集群 */ SelfBuilt?: boolean; /** * Doris 的 http 负载均衡连接 port,通常映射到 be 的 8040 端口 */ BePort?: number; } /** * zone信息实体 */ export interface ZoneInfo { /** *可用区
*/ ZoneId?: string; /** *是否内部APP
枚举值:
默认值:0
*/ IsInternalApp?: number; /** *应用标识
*/ AppId?: number; /** *可用区是否售罄标识,true表示已售罄,false表示未售罄。
*/ Flag?: boolean; /** *可用区名称
*/ ZoneName?: string; /** *可用区状态
枚举值:
可用区状态以SoldOut为准
*/ ZoneStatus?: number; /** *额外标识
* @deprecated */ Exflag?: string; /** *true为售罄,false为未售罄
*/ SoldOut?: string; /** *标准版售罄信息
*/ SalesInfo?: Array额外标识
*/ ExtraFlag?: string; } /** * DescribeTopicSubscribeGroup返回参数结构体 */ export interface DescribeTopicSubscribeGroupResponse { /** *返回结果
*/ Result?: TopicSubscribeGroup; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DeleteAclRule请求参数结构体 */ export interface DeleteAclRuleRequest { /** * 实例id信息,可通过[DescribeInstances](https://cloud.tencent.com/document/product/597/40835)接口获取 */ InstanceId: string; /** * acl规则名称,可通过DescribeAclRule接口获取。 */ RuleName: string; } /** * DescribeTypeInstances返回参数结构体 */ export interface DescribeTypeInstancesResponse { /** *返回的结果
*/ Result?: InstanceResponse; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * ModifyConnectResource请求参数结构体 */ export interface ModifyConnectResourceRequest { /** * 连接源的Id */ ResourceId: string; /** * 连接源名称,为空时不修改 */ ResourceName?: string; /** * 连接源描述,为空时不修改 */ Description?: string; /** * 连接源类型,修改数据源参数时,需要与原Type相同,否则编辑数据源无效 */ Type?: string; /** * Dts配置,Type为DTS时必填 */ DtsConnectParam?: DtsModifyConnectParam; /** * MongoDB配置,Type为MONGODB时必填 */ MongoDBConnectParam?: MongoDBModifyConnectParam; /** * Es配置,Type为ES时必填 */ EsConnectParam?: EsModifyConnectParam; /** * ClickHouse配置,Type为CLICKHOUSE时必填 */ ClickHouseConnectParam?: ClickHouseModifyConnectParam; /** * MySQL配置,Type为MYSQL或TDSQL_C_MYSQL时必填 */ MySQLConnectParam?: MySQLModifyConnectParam; /** * PostgreSQL配置,Type为POSTGRESQL或TDSQL_C_POSTGRESQL时必填 */ PostgreSQLConnectParam?: PostgreSQLModifyConnectParam; /** * MariaDB配置,Type为MARIADB时必填 */ MariaDBConnectParam?: MariaDBModifyConnectParam; /** * SQLServer配置,Type为SQLSERVER时必填 */ SQLServerConnectParam?: SQLServerModifyConnectParam; /** * Ctsdb配置,Type为CTSDB */ CtsdbConnectParam?: CtsdbModifyConnectParam; /** * Doris配置,Type为DORIS */ DorisConnectParam?: DorisModifyConnectParam; /** * Kafka配置,Type为 KAFKA 时必填 */ KafkaConnectParam?: KafkaConnectParam; /** * MQTT配置,Type为 MQTT 时必填 */ MqttConnectParam?: MqttConnectParam; } /** * 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; } /** * CreateToken请求参数结构体 */ export interface CreateTokenRequest { /** * ckafka集群实例Id,可通过[DescribeInstances](https://cloud.tencent.com/document/product/597/40835)接口获取 */ InstanceId: string; /** * 用户名 */ User: string; } /** * Tdw类型入参 */ export interface TdwParam { /** * Tdw的bid */ Bid: string; /** * Tdw的tid */ Tid: string; /** * 默认true */ IsDomestic?: boolean; /** * TDW地址,默认tl-tdbank-tdmanager.tencent-distribute.com */ TdwHost?: string; /** * TDW端口,默认8099 */ TdwPort?: number; } /** * DescribeCvmInfo请求参数结构体 */ export interface DescribeCvmInfoRequest { /** * ckafka集群实例Id,可通过[DescribeInstances](https://cloud.tencent.com/document/product/597/40835)接口获取 */ InstanceId: string; } /** * 创建CDC 标准版共享集群出参 */ export interface CdcClusterResponse { /** * 任务ID */ TaskId?: number; } /** * DescribeTaskStatus返回参数结构体 */ export interface DescribeTaskStatusResponse { /** * 返回结果 */ Result?: TaskStatusResponse; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeModifyType请求参数结构体 */ export interface DescribeModifyTypeRequest { /** *ckafka集群实例Id
*/ InstanceId: string; /** *升配后的带宽,单位mb
*/ BandWidth: number; /** *升配后的磁盘,单位G
*/ DiskSize: number; /** *磁盘类型,例如 CLOUD_PREMIUM
*/ DiskType: string; /** *分区数量
*/ Partition: number; /** *topic数量
*/ Topic: number; /** *实例类型例如 sp_ckafka_profession
*/ Type: string; /** *变配入口
*/ ModifyEntry?: string; /** *是否可用区变更 false: 非可用区变更 true: 可用区变更 默认false
*/ ModifyZone?: boolean; } /** * CreateUser返回参数结构体 */ export interface CreateUserResponse { /** * 返回结果 */ Result?: JgwOperateResponse; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 主题占用Broker磁盘大小 */ export interface BrokerTopicData { /** * 主题名称 */ TopicName?: string; /** * 主题Id */ TopicId?: string; /** * 主题占用Broker 容量大小,单位为Bytes。 */ DataSize?: number; } /** * 批量解析 */ export interface BatchAnalyseParam { /** * ONE_BY_ONE单条输出,MERGE合并输出 */ Format: string; } /** * DeleteInstancePost请求参数结构体 */ export interface DeleteInstancePostRequest { /** * ckafka集群实例Id,可通过[DescribeInstances](https://cloud.tencent.com/document/product/597/40835)接口获取 */ InstanceId: string; } /** * DescribeTopicProduceConnection请求参数结构体 */ export interface DescribeTopicProduceConnectionRequest { /** * ckafka集群实例Id,可通过[DescribeInstances](https://cloud.tencent.com/document/product/597/40835)接口获取 */ InstanceId: string; /** * 主题名,可通过[DescribeTopic](https://cloud.tencent.com/document/product/597/40847)接口获取。 */ TopicName: string; } /** * MariaDB类型入参 */ export interface MariaDBParam { /** * MariaDB的数据库名称,"*"为全数据库 */ Database: string; /** * MariaDB的数据表名称,"*"为所监听的所有数据库中的非系统表,可以","间隔,监听多个数据表,但数据表需要以"数据库名.数据表名"的格式进行填写 */ Table: string; /** * 该MariaDB在连接管理内的Id */ Resource: string; /** * 复制存量信息(schema_only不复制, initial全量),默认值initial */ SnapshotMode?: string; /** * 格式:库1.表1:字段1,字段2;库2.表2:字段2,表之间;(分号)隔开,字段之间,(逗号)隔开。不指定的表默认取表的主键 */ KeyColumns?: string; /** * 当Table输入的是前缀时,该项值为true,否则为false */ IsTablePrefix?: boolean; /** * 输出格式,DEFAULT、CANAL_1、CANAL_2 */ OutputFormat?: string; /** * 如果该值为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; } /** * 数据处理——Value处理参数——截取参数 */ export interface SubstrParam { /** * 截取起始位置 */ Start: number; /** * 截取截止位置 */ End: number; } /** * DescribeTopicSubscribeGroup请求参数结构体 */ export interface DescribeTopicSubscribeGroupRequest { /** *ckafka集群实例Id
取值参考:DescribeInstances
*/ InstanceId: string; /** *主题名
*/ TopicName: string; /** *分页时的起始位置
*/ Offset?: number; /** *分页时的个数
默认值:20
*/ Limit?: number; } /** * Table、Topic路由 */ export interface TableMapping { /** * 库名 */ Database: string; /** * 表名,多个表,(逗号)隔开 */ Table: string; /** * Topic名称 */ Topic: string; /** * Topic ID */ TopicId: string; } /** * Dts修改连接源参数 */ export interface DtsModifyConnectParam { /** * Dts实例Id【不支持修改】 */ Resource: string; /** * Dts的连接port【不支持修改】 */ Port?: number; /** * Dts消费分组的Id */ GroupId?: string; /** * Dts消费分组的账号 */ UserName?: string; /** * Dts消费分组的密码 */ Password?: string; /** * 是否更新到关联的Datahub任务,默认为true */ IsUpdate?: boolean; /** * Dts订阅的topic【不支持修改】 */ Topic?: string; } /** * 实例配置实体 */ export interface InstanceConfigDO { /** * 是否自动创建主题 */ AutoCreateTopicsEnable?: boolean; /** * 分区数 */ DefaultNumPartitions?: number; /** * 默认的复制Factor */ DefaultReplicationFactor?: number; } /** * DeleteAclRule返回参数结构体 */ export interface DeleteAclRuleResponse { /** * 返回被删除的规则的ID */ Result?: number; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 用户返回实体 */ export interface UserResponse { /** * 符合条件的用户列表 */ Users?: Array返回结果
*/ Result?: UserResponse; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * Cos Datahub 任务接入参数 */ export interface CosParam { /** * cos 存储桶名称 */ BucketName: string; /** * 地域代码 */ Region: string; /** * 对象名称 */ ObjectKey?: string; /** * 汇聚消息量的大小(单位:MB) */ AggregateBatchSize?: number; /** * 汇聚的时间间隔(单位:小时) */ AggregateInterval?: number; /** * 消息汇聚后的文件格式(支持csv, json) */ FormatOutputType?: string; /** * 转储的对象目录前缀 */ ObjectKeyPrefix?: string; /** * 根据strptime 时间格式化的分区格式 */ DirectoryTimeFormat?: string; } /** * 查询kafka的zone信息返回的实体 */ export interface ZoneResponse { /** *zone列表
*/ ZoneList?: Array最大购买实例个数
*/ MaxBuyInstanceNum?: number; /** *最大购买带宽 单位Mb/s
*/ MaxBandwidth?: number; /** *后付费单位价格
*/ UnitPrice?: Price; /** *后付费消息单价
*/ MessagePrice?: Price; /** *用户独占集群信息
*/ ClusterInfo?: Array购买标准版配置
*/ Standard?: string; /** *购买标准版S2配置
*/ StandardS2?: string; /** *购买专业版配置
*/ Profession?: string; /** *购买物理独占版配置
*/ Physical?: string; /** *公网带宽 最小3Mbps 最大999Mbps 仅专业版支持填写 已废弃,无实际意义
*/ PublicNetwork?: string; /** *公网带宽配置
*/ PublicNetworkLimit?: string; /** *请求Id
*/ RequestId?: string; /** *分页offset
*/ Offset?: number; /** *分页limit
*/ Limit?: number; /** *是否必须录入tag
*/ ForceCheckTag?: boolean; } /** * DeleteInstancePre请求参数结构体 */ export interface DeleteInstancePreRequest { /** *ckafka集群实例Id,可通过DescribeInstances接口获取
*/ InstanceId: string; } /** * DeleteGroupSubscribeTopic请求参数结构体 */ export interface DeleteGroupSubscribeTopicRequest { /** * ckafka集群实例Id */ InstanceId: string; /** * 消费分组名称 */ Group: string; /** * 主题名 */ Topic: string; } /** * 消费组主题对象 */ export interface ConsumerGroupTopic { /** * 主题ID */ TopicId?: string; /** * 主题名称 */ TopicName?: string; } /** * 数据处理参数 */ export interface TransformsParam { /** * 原始数据 */ Content: string; /** * 处理链 */ FieldChain: Array(查询条件)按照ckafka集群实例Id过滤
*/ InstanceId?: string; /** *搜索词 ex:(查询条件)按照实例名称过滤,支持模糊查询
*/ SearchWord?: string; /** *(查询条件)实例的状态 不填默认返回全部
枚举值:
偏移量,不填默认为0
*/ Offset?: number; /** *返回数量,不填则默认10,最大值100
*/ Limit?: number; /** *已废弃。匹配标签key值。
* @deprecated */ TagKey?: string; /** *(查询条件)私有网络Id
*/ VpcId?: string; } /** * DescribeCkafkaZone返回参数结构体 */ export interface DescribeCkafkaZoneResponse { /** * 查询结果复杂对象实体 */ Result?: ZoneResponse; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * ModifyInstancePre返回参数结构体 */ export interface ModifyInstancePreResponse { /** *变更预付费实例配置返回结构
*/ Result?: CreateInstancePreResp; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * CreateUser请求参数结构体 */ export interface CreateUserRequest { /** * ckafka集群实例Id,可通过[DescribeInstances](https://cloud.tencent.com/document/product/597/40835)接口获取 */ InstanceId: string; /** * 用户名称 */ Name: string; /** * 用户密码 */ Password: string; } /** * 主题属性返回结果实体 */ export interface TopicAttributesResponse { /** * 主题 ID */ TopicId?: string; /** * 创建时间的秒级时间戳 */ CreateTime?: number; /** * 主题备注 */ Note?: string; /** * 分区个数 */ PartitionNum?: number; /** * IP 白名单开关,1:打开; 0:关闭 */ EnableWhiteList?: number; /** * IP 白名单列表 */ IpWhiteList?: Array返回结果
*/ Result?: CreateInstancePreResp; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * CheckCdcCluster请求参数结构体 */ export interface CheckCdcClusterRequest { /** * 任务ID */ TaskId: number; } /** * CVM和IP信息 */ export interface CvmAndIpInfo { /** * ckafka集群实例Id */ CkafkaInstanceId?: string; /** * CVM实例ID(ins-test )或POD IP(10.0.0.30) */ InstanceId?: string; /** * IP地址 */ Ip?: string; } /** * topic 生产消息数据,消费者数据 */ export interface TopicFlowRankingResult { /** * Topic 流量数组 */ TopicFlow?: Arrayckafka集群实例Id
取值参考:DescribeInstances
*/ InstanceId: string; /** *路由Id
*/ RouteId?: number; /** *是否显示主路由,true时会在返回原路由列表的基础上,再额外展示实例创建时的主路由信息(且不被InternalFlag/UsedFor等参数过滤影响)
*/ MainRouteFlag?: boolean; } /** * CreatePostPaidInstance返回参数结构体 */ export interface CreatePostPaidInstanceResponse { /** *返回结果
*/ Result?: CreateInstancePostResp; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 数据处理——Value处理参数 */ export interface ValueParam { /** * 处理模式,REPLACE替换,SUBSTR截取,DATE日期转换,TRIM去除前后空格,REGEX_REPLACE正则替换,URL_DECODE,LOWERCASE转换为小写 */ Type: string; /** * 替换,TYPE=REPLACE时必传 注意:此字段可能返回 null,表示取不到有效值。 */ Replace?: ReplaceParam; /** * 截取,TYPE=SUBSTR时必传 注意:此字段可能返回 null,表示取不到有效值。 */ Substr?: SubstrParam; /** * 时间转换,TYPE=DATE时必传 注意:此字段可能返回 null,表示取不到有效值。 */ Date?: DateParam; /** * 正则替换,TYPE=REGEX_REPLACE时必传 注意:此字段可能返回 null,表示取不到有效值。 */ RegexReplace?: RegexReplaceParam; /** * 值支持一拆多,TYPE=SPLIT时必传 注意:此字段可能返回 null,表示取不到有效值。 */ Split?: SplitParam; /** * key-value二次解析,TYPE=KV时必传 注意:此字段可能返回 null,表示取不到有效值。 */ KV?: KVParam; /** * 处理结果 注意:此字段可能返回 null,表示取不到有效值。 */ Result?: string; /** * JsonPath替换,TYPE=JSON_PATH_REPLACE时必传 注意:此字段可能返回 null,表示取不到有效值。 */ JsonPathReplace?: JsonPathReplaceParam; /** * Url解析 注意:此字段可能返回 null,表示取不到有效值。 */ UrlDecode?: UrlDecodeParam; /** * 小写字符解析 注意:此字段可能返回 null,表示取不到有效值。 */ Lowercase?: LowercaseParam; } /** * 小写字符解析 */ export type LowercaseParam = null; /** * MySQL修改连接源参数 */ export interface MySQLModifyConnectParam { /** * MySQL连接源的实例资源【不支持修改】 */ Resource: string; /** * MySQL的连接port【不支持修改】 */ Port?: number; /** * MySQL连接源的实例vip【不支持修改】 */ ServiceVip?: string; /** * MySQL连接源的vpcId【不支持修改】 */ UniqVpcId?: string; /** * MySQL连接源的用户名 */ UserName?: string; /** * MySQL连接源的密码 */ Password?: string; /** * 是否更新到关联的Datahub任务 */ IsUpdate?: boolean; /** * 当type为TDSQL_C_MYSQL时 */ ClusterId?: string; /** * 是否是自建的集群 */ SelfBuilt?: boolean; } /** * DescribeGroup返回实体 */ export interface DescribeGroup { /** * 消费分组名称 */ Group?: string; /** * 该 group 使用的协议。 */ Protocol?: string; } /** * Datahub请求的taskid */ export interface DatahubTaskIdRes { /** * 任务id */ TaskId?: string; } /** * DescribeRoute返回参数结构体 */ export interface DescribeRouteResponse { /** *返回的路由信息结果集
*/ Result?: RouteResponse; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * ModifyDatahubTopic返回参数结构体 */ export interface ModifyDatahubTopicResponse { /** * 返回结果集 */ Result?: JgwOperateResponse; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * PostgreSQL类型入参 */ export interface PostgreSQLParam { /** * PostgreSQL的数据库名称 */ Database: string; /** * PostgreSQL的数据表名称,"*"为所监听的所有数据库中的非系统表,可以","间隔,监听多个数据表,但数据表需要以"Schema名.数据表名"的格式进行填写,需要填入正则表达式时,格式为"Schema名\\.数据表名" */ Table: string; /** * 该PostgreSQL在连接管理内的Id */ Resource: string; /** * 插件名(decoderbufs/pgoutput),默认为decoderbufs */ PluginName: string; /** * 复制存量信息(never增量, initial全量),默认为initial */ SnapshotMode?: string; /** * 上游数据格式(JSON/Debezium), 当数据库同步模式为默认字段匹配时,必填 */ DataFormat?: string; /** * "INSERT" 表示使用 Insert 模式插入,"UPSERT" 表示使用 Upsert 模式插入 */ DataTargetInsertMode?: string; /** * 当 "DataInsertMode"="UPSERT" 时,传入当前 upsert 时依赖的主键 */ DataTargetPrimaryKeyField?: string; /** * 表与消息间的映射关系 */ DataTargetRecordMapping?: Arrayckafka集群实例Id
取值参考:DescribeInstances
*/ InstanceId: string; /** *主题名
*/ TopicName: string; /** *主题备注
入参限制:不超过64个字符
默认值:""
*/ Note?: string; /** *IP 白名单开关,1:打开;0:关闭。
*/ EnableWhiteList?: number; /** *最小同步副本数
默认值:1
最小值为1
*/ MinInsyncReplicas?: number; /** *是否允许未同步的副本选为leader
枚举值:
默认值:0
*/ UncleanLeaderElectionEnable?: number; /** *Segment分片滚动的时长
单位:毫秒
默认值:86400000
最小值为86400000ms(1天)
*/ RetentionMs?: number; /** *主题消息最大值
取值范围:[1024, 12582912]
单位:Bytes
*/ MaxMessageBytes?: number; /** *Segment 分片滚动的时长
单位:毫秒
最小值为86400000ms(1天)
*/ SegmentMs?: number; /** *消息删除策略,可以选择delete 或者compact
*/ CleanUpPolicy?: string; /** *Ip白名单列表,配额限制,enableWhileList=1时必选
*/ IpWhiteList?: Array预设ACL规则, 1:打开 0:关闭,默认不打开
*/ EnableAclRule?: number; /** *ACL规则名
*/ AclRuleName?: string; /** *可选, 保留文件大小
取值范围:[1073741824, 1099511627776]
单位:Bytes
默认值:-1
特殊值:-1表示无限制
*/ RetentionBytes?: number; /** *标签列表
*/ Tags?: Array生产限流,单位 MB/s;设置为-1,则生产不限流
*/ QuotaProducerByteRate?: number; /** *消费限流,单位 MB/s;设置为-1,则消费不限流
*/ QuotaConsumerByteRate?: number; /** *topic副本数 最小值 1,最大值 3
*/ ReplicaNum?: number; /** *消息保存的时间类型:CreateTime/LogAppendTime
*/ LogMsgTimestampType?: string; } /** * CreateInstancePre请求参数结构体 */ export interface CreateInstancePreRequest { /** *ckafka集群实例Name,是一个不超过 128 个字符的任意字符串。
*/ InstanceName: string; /** *可用区。当购买多可用区实例时,当前参数为主可用区。 查看可用区
*/ ZoneId: number; /** *预付费购买时长,例如 "1m",就是一个月,取值范围 1m~36m
*/ Period: 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; /** *私有网络Id
*/ VpcId: string; /** *子网id
*/ SubnetId: string; /** *可选。实例日志的最长保留时间,单位分钟,不填默认为1440(1天),可设置范围为1分钟到90天。
*/ MsgRetentionTime?: number; /** *创建实例时可以选择集群Id, 该入参表示集群Id
*/ ClusterId?: number; /** *预付费自动续费标记,0表示默认状态(用户未设置,即初始状态), 1表示自动续费,2表示明确不自动续费(用户设置)
*/ RenewFlag?: number; /** *CKafka版本号[2.4.1, 2.4.2, 2.8.1, 3.2.3], 默认取值是2.4.1。2.4.1 与 2.4.2 属于同一个版本,传任意一个均可。
*/ KafkaVersion?: string; /** *实例类型: [标准版实例]填写 "standard" (默认), [专业版实例]填写 "profession",[高级版实例]填写"premium"
*/ SpecificationsType?: string; /** *磁盘大小,如果跟控制台规格配比不相符,则无法创建成功。默认取值为500,步长设置为100。可以通过以下链接查看计费规格:https://cloud.tencent.com/document/product/597/122562
*/ DiskSize?: number; /** *实例带宽,默认值为40,单位MB/s; 最小值:20MB/s, 高级版最大值:360MB/s,专业版最大值:100000MB/s 标准版固定带宽规格: 40MB/s, 100MB/s, 150MB/s。可以通过以下链接查看计费规格:https://cloud.tencent.com/document/product/597/11745
*/ BandWidth?: number; /** *分区大小,如果跟控制台规格配比不相符,则无法创建成功。默认值为800,步长为100。可以通过以下链接查看计费规格:https://cloud.tencent.com/document/product/597/122563
*/ Partition?: number; /** *标签
*/ Tags?: Array专业版/高级版实例磁盘类型,标准版实例不需要填写。"CLOUD_SSD":SSD云硬盘;"CLOUD_BASIC":高性能云硬盘。不传默认为 "CLOUD_BASIC"
*/ DiskType?: string; /** *是否创建跨可用区实例,当前参数为 true 时,zoneIds必填
*/ MultiZoneFlag?: boolean; /** *可用区列表,购买多可用区实例时为必填项
*/ ZoneIds?: Array公网带宽大小,单位 Mbps。默认是没有加上免费 3Mbps 带宽。例如总共需要 3Mbps 公网带宽,此处传 0;总共需要 6Mbps 公网带宽,此处传 3。默认值为 0。需要保证传入参数为 3 的整数倍
*/ PublicNetworkMonthly?: number; /** *购买实例数量。非必填,默认值为 1。当传入该参数时,会创建多个 instanceName 加后缀区分的实例
*/ InstanceNum?: number; /** *是否自动选择代金券:1-是;0否。默认为0
*/ AutoVoucher?: number; /** *弹性带宽开关 0不开启 1开启(0默认)
*/ ElasticBandwidthSwitch?: number; /** *自定义证书Id,仅当SpecificationsType为profession时生效,支持自定义证书能力
可通过DescribeCertificateDetail接口获取
*/ CustomSSLCertId?: string; } /** * DeleteTopic返回参数结构体 */ export interface DeleteTopicResponse { /** * 返回的结果集 */ Result?: JgwOperateResponse; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 返回连接源的Id */ export interface ConnectResourceResourceIdResp { /** * 连接源的Id */ ResourceId?: string; } /** * 购买硬盘参数 */ export interface InquiryDiskParam { /** * 购买硬盘类型: SSD(SSD), CLOUD_SSD(SSD云硬盘), CLOUD_PREMIUM(高性能云硬盘), CLOUD_BASIC(云盘) */ DiskType?: string; /** * 购买硬盘大小: 单位GB */ DiskSize?: number; } /** * PostgreSQL连接源参数 */ export interface PostgreSQLConnectParam { /** * PostgreSQL的连接port */ Port: number; /** * PostgreSQL连接源的用户名 */ UserName: string; /** * PostgreSQL连接源的密码 */ Password: string; /** * PostgreSQL连接源的实例资源 */ Resource: string; /** * PostgreSQL连接源的实例vip,当为腾讯云实例时,必填 */ ServiceVip?: string; /** * PostgreSQL连接源的vpcId,当为腾讯云实例时,必填 */ UniqVpcId?: string; /** * 当type为TDSQL_C_POSTGRESQL时,必填 */ ClusterId?: string; /** * 是否更新到关联的Datahub任务 */ IsUpdate?: boolean; /** * PostgreSQL连接源是否为自建集群 */ SelfBuilt?: boolean; } /** * 订阅信息实体 */ export interface SubscribedInfo { /** * 订阅的主题名 */ TopicName?: string; /** * 订阅的分区 */ Partition?: Arrayckafka集群实例id,可通过DescribeInstances接口获取
*/ InstanceId: string; /** *路由网络类型(3:vpc路由;7:内部支撑路由;1:公网路由)
*/ VipType: number; /** *vpc网络Id,当vipType为3时必填
*/ VpcId?: string; /** *vpc子网id,当vipType为3时必填
*/ SubnetId?: string; /** *访问类型:0-plaintext;1-sasl_plaintext;3-sasl_ssl; 4-sasl_scram_sha_256; 5-sasl_scram_sha_512 默认为0vipType=3,支持 0,1,3,4,5vipType=7,支持0,1,3vipType=1,支持1,3
*/ AccessType?: number; /** *是否需要权限管理,该字段已废弃
*/ AuthFlag?: number; /** *调用方appId
*/ CallerAppid?: number; /** *公网带宽,公网路由必传,且是3的倍数,无默认值
*/ PublicNetwork?: number; /** *vip地址
*/ Ip?: string; /** *备注信息
*/ Note?: string; /** *关联安全组有序列表
*/ SecurityGroupIds?: Array返回结果
*/ Result?: JgwOperateResponse; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * CreateDatahubTopic请求参数结构体 */ export interface CreateDatahubTopicRequest { /** * 名称,是一个不超过 128 个字符的字符串,必须以“AppId-”为首字符,剩余部分可以包含字母、数字和横划线(-) */ Name: string; /** * Partition个数,大于0 */ PartitionNum: number; /** * 消息保留时间,单位ms,当前最小值为60000ms */ RetentionMs: number; /** * 主题备注,是一个不超过 64 个字符的字符串,必须以字母为首字符,剩余部分可以包含字母、数字和横划线(-) */ Note?: string; /** * 标签列表 */ Tags?: Array返回结果
*/ Result?: CreateInstancePreResp; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * Datahub Topic 响应 */ export interface DatahubTopicResp { /** * 主题名称 */ TopicName?: string; /** * 主题Id */ TopicId?: string; } /** * DescribeCvmInfo返回参数结构体 */ export interface DescribeCvmInfoResponse { /** * 返回结果 */ Result?: ListCvmAndIpInfoRsp; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DeleteRouteTriggerTime返回参数结构体 */ export interface DeleteRouteTriggerTimeResponse { /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 预付费/后付费接口中,订单和 CKafka 实例映射数据结构 */ export interface DealInstanceDTO { /** * 订单流水 */ DealName?: string; /** * 订单流水对应购买的 CKafka 实例 id 列表 */ InstanceIdList?: Arrayckafka集群实例Id
取值参考:DescribeInstances
*/ InstanceId: string; /** *按照名称过滤
支持模糊匹配
*/ SearchWord?: string; /** *偏移量
*/ Offset?: number; /** *返回数量
默认值:20
*/ Limit?: number; } /** * DescribeModifyType返回参数结构体 */ export interface DescribeModifyTypeResponse { /** *返回的变配类型结构
*/ Result?: DescModifyType; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeDatahubTopic请求参数结构体 */ export interface DescribeDatahubTopicRequest { /** * 弹性topic名称 */ Name: string; } /** * 高级配置对象 */ export interface Config { /** * 消息保留时间,单位ms。 */ Retention?: number; /** * 最小同步复制数 注意:此字段可能返回 null,表示取不到有效值。 */ MinInsyncReplicas?: number; /** * 日志清理模式,默认 delete。 delete:日志按保存时间删除;compact:日志按 key 压缩;compact, delete:日志按 key 压缩且会保存时间删除。 注意:此字段可能返回 null,表示取不到有效值。 */ CleanUpPolicy?: string; /** * Segment 分片滚动的时长,单位ms。 注意:此字段可能返回 null,表示取不到有效值。 */ SegmentMs?: number; /** * 0表示 false。 1表示 true。 注意:此字段可能返回 null,表示取不到有效值。 */ UncleanLeaderElectionEnable?: number; /** * Segment 分片滚动的字节数,单位bytes 注意:此字段可能返回 null,表示取不到有效值。 */ SegmentBytes?: number; /** * 最大消息字节数,单位bytes 注意:此字段可能返回 null,表示取不到有效值。 */ MaxMessageBytes?: number; /** * 消息保留文件大小,单位Bytes 注意:此字段可能返回 null,表示取不到有效值。 */ RetentionBytes?: number; /** * 消息保存的时间类型,CreateTime表示生产者创建这条消息的时间;LogAppendTime表示broker接收到消息的时间。 注意:此字段可能返回 null,表示取不到有效值。 */ LogMsgTimestampType?: string; } /** * ModifyPassword请求参数结构体 */ export interface ModifyPasswordRequest { /** * 实例Id,可通过[DescribeInstances](https://cloud.tencent.com/document/product/597/40835)接口获取 */ InstanceId: string; /** * 用户名称,可通过[DescribeUser](https://cloud.tencent.com/document/product/597/40855)接口获取。 */ Name: string; /** * 用户当前密码 */ Password: string; /** * 用户新密码 */ PasswordNew: string; } /** * DeleteDatahubTopic请求参数结构体 */ export interface DeleteDatahubTopicRequest { /** * Topic名称 */ Name: string; } /** * ModifyTopicAttributes返回参数结构体 */ export interface ModifyTopicAttributesResponse { /** *返回结果
*/ Result?: JgwOperateResponse; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeConsumerGroup请求参数结构体 */ export interface DescribeConsumerGroupRequest { /** * ckafka集群实例Id,可通过[DescribeInstances](https://cloud.tencent.com/document/product/597/40835)接口获取 */ InstanceId: string; /** * 用户需要查询的group名称。 */ GroupName?: string; /** * 用户需要查询的group中的对应的topic名称,如果指定了该参数,而group又未指定则忽略该参数。 */ TopicName?: string; /** * 返回消费组的限制数量,最大支持50 */ Limit?: number; /** * 消费组列表的起始偏移量 */ Offset?: number; } /** * 虚拟IP实体 */ export interface VipEntity { /** * 虚拟IP */ Vip?: string; /** * 虚拟端口 */ Vport?: string; } /** * DescribeTopicProduceConnection返回参数结构体 */ export interface DescribeTopicProduceConnectionResponse { /** * 链接信息返回结果集 */ Result?: Array返回结果
*/ Result?: JgwOperateResponse; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * Ctsdb类型入参 */ export interface CtsdbParam { /** * 连接管理实例资源 */ Resource?: string; /** * Ctsdb的metric */ CtsdbMetric?: string; } /** * EventBus配置 */ export interface EventBusParam { /** * 资源类型。COS/ES/CLS */ Type: string; /** * 是否为自建集群 */ SelfBuilt: boolean; /** * 实例资源 */ Resource: string; /** * SCF云函数命名空间 */ Namespace?: string; /** * SCF云函数函数名 */ FunctionName?: string; /** * SCF云函数版本及别名 */ Qualifier?: string; } /** * DescribeTopicFlowRanking返回参数结构体 */ export interface DescribeTopicFlowRankingResponse { /** * 流量排行返回结果 */ Result?: TopicFlowRankingResult; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * CreateDatahubTask请求参数结构体 */ export interface CreateDatahubTaskRequest { /** * 任务名称,只能以字母起始,允许包含字母、数字、- 、. 、 下划线且长度不超过64 (、为分割符号规则不包含) */ TaskName: string; /** * 任务类型,SOURCE数据接入,SINK数据流出 */ TaskType: string; /** * 数据源 */ SourceResource?: DatahubResource; /** * 数据目标 */ TargetResource?: DatahubResource; /** * 数据处理规则 */ TransformParam?: TransformParam; /** * 实例连接参数【已废弃】 * @deprecated */ PrivateLinkParam?: PrivateLinkParam; /** * 选择所要绑定的SchemaId */ SchemaId?: string; /** * 数据处理规则 */ TransformsParam?: TransformsParam; /** * 任务Id */ TaskId?: string; /** * 标签列表 */ Tags?: Array实例接入方式0:PLAINTEXT (明文方式,没有带用户信息老版本及社区版本都支持)1:SASL_PLAINTEXT(明文方式,不过在数据开始时,会通过SASL方式登录鉴权,仅社区版本支持)2:SSL(SSL加密通信,没有带用户信息,老版本及社区版本都支持)3:SASL_SSL(SSL加密通信,在数据开始时,会通过SASL方式登录鉴权,仅社区版本支持)
*/ AccessType?: number; /** *路由Id
*/ RouteId?: number; /** *路由网络类型(3:vpc路由;7:内部支撑路由;1:公网路由)
*/ VipType?: number; /** *虚拟IP列表
*/ VipList?: Array域名
注意:此字段可能返回 null,表示取不到有效值。 */ Domain?: string; /** *域名port
注意:此字段可能返回 null,表示取不到有效值。 */ DomainPort?: number; /** *时间戳
*/ DeleteTimestamp?: string; /** *子网Id
注意:此字段可能返回 null,表示取不到有效值。 */ Subnet?: string; /** *虚拟IP列表(1对1 broker节点)
*/ BrokerVipList?: Array私有网络Id
注意:此字段可能返回 null,表示取不到有效值。 */ VpcId?: string; /** *备注信息
注意:此字段可能返回 null,表示取不到有效值。 */ Note?: string; /** *路由的状态。1: 创建中,2: 创建成功,3: 创建失败,4: 删除中,6: 删除失败
注意:此字段可能返回 null,表示取不到有效值。 */ Status?: number; } /** * 表示ACL 规则的四元组信息 */ export interface AclRuleInfo { /** * Acl操作方式,枚举值(所有操作: All, 读:Read,写:Write) */ Operation: string; /** * 权限类型,Deny:拒绝,Allow:允许。 */ PermissionType: string; /** * 表示任何host都可以访问 */ Host: string; /** * 用户,User:*表示任何user都可以访问,当前用户只能是用户列表中包含的用户。传入格式需要带【User:】前缀。例如用户A,传入为User:A。 */ Principal: string; } /** * RenewCkafkaInstance请求参数结构体 */ export interface RenewCkafkaInstanceRequest { /** *ckafka集群实例Id,可通过DescribeInstances接口获取
*/ InstanceId: string; /** *续费时长, 默认为1, 单位是月
*/ TimeSpan?: number; } /** * ACL对象实体 */ export interface Acl { /** * Acl资源类型,(0:UNKNOWN,1:ANY,2:TOPIC,3:GROUP,4:CLUSTER,5:TRANSACTIONAL_ID)当前只有TOPIC, */ ResourceType?: number; /** * 资源名称,和resourceType相关如当resourceType为TOPIC时,则该字段表示topic名称,当resourceType为GROUP时,该字段表示group名称 */ ResourceName?: string; /** * 用户列表,默认为User:*,表示任何user都可以访问,当前用户只能是用户列表中包含的用户 */ Principal?: string; /** * 默认\*,表示任何host都可以访问,当前ckafka不支持host为\*,但是后面开源kafka的产品化会直接支持 */ Host?: string; /** * Acl操作方式(0:UNKNOWN,1:ANY,2:ALL,3:READ,4:WRITE,5:CREATE,6:DELETE,7:ALTER,8:DESCRIBE,9:CLUSTER_ACTION,10:DESCRIBE_CONFIGS,11:ALTER_CONFIGS,12:IDEMPOTEN_WRITE) */ Operation?: number; /** * 权限类型(0:UNKNOWN,1:ANY,2:DENY,3:ALLOW) */ PermissionType?: number; } /** * Topic消息保留时间配置返回信息 */ export interface TopicRetentionTimeConfigRsp { /** * 期望值,即用户配置的Topic消息保留时间(单位分钟) */ Expect?: number; /** * 当前值,即当前生效值(可能存在动态调整,单位分钟) */ Current?: number; /** * 最近变更时间 */ ModTimeStamp?: number; } /** * 数据处理——二次解析参数 */ export interface SecondaryAnalyseParam { /** * 分隔符 */ Regex: string; } /** * DeleteTopicIpWhiteList请求参数结构体 */ export interface DeleteTopicIpWhiteListRequest { /** * ckafka集群实例Id,可通过[DescribeInstances](https://cloud.tencent.com/document/product/597/40835)接口获取 */ InstanceId: string; /** * 主题名,可通过[DescribeTopic](https://cloud.tencent.com/document/product/597/40847)接口获取。 */ TopicName: string; /** * ip白名单列表 */ IpWhiteList: Array实例ID
取值参考:DescribeInstances
*/ InstanceId: string; /** *主题名称
取值参考:DescribeTopic
*/ TopicName: string; /** *偏移量,不填默认为0
*/ Offset?: number; /** *返回数量,默认值为20,必须大于0。
*/ Limit?: number; /** *仅筛选未同步副本
*/ OutOfSyncReplicaOnly?: boolean; } /** * ModifyDatahubTask请求参数结构体 */ export interface ModifyDatahubTaskRequest { /** * 任务id */ TaskId: string; /** * 任务名称 */ TaskName?: string; /** * 任务描述信息 */ Description?: string; } /** * CreatePrometheus请求参数结构体 */ export interface CreatePrometheusRequest { /** * ckafka集群实例Id,可通过[DescribeInstances](https://cloud.tencent.com/document/product/597/40835)接口获取 */ InstanceId: string; /** * 私有网络Id,可通过[DescribeVpcs](https://cloud.tencent.com/document/product/215/15778)接口获取 */ VpcId: string; /** * 子网Id,可通过[DescribeSubnets](https://cloud.tencent.com/document/product/215/15784)接口获取 */ SubnetId: string; } /** * AclRule列表接口返回结果 */ export interface AclRuleResp { /** * 总数据条数 */ TotalCount?: number; /** * AclRule列表 */ AclRuleList?: Array