@nocobase/plugin-verification

/** * 主题详情 */ export interface TopicDetail { /** * 主题名称 */ TopicName: string; /** * 主题ID */ TopicId: string; /** * 分区数 */ PartitionNum: number; /** * 副本数 */ ReplicaNum: number; /** * 备注注意：此字段可能返回 null，表示取不到有效值。 */ Note: string; /** * 创建时间 */ CreateTime: number; /** * 是否开启ip鉴权白名单，true表示开启，false表示不开启 */ EnableWhiteList: boolean; /** * ip白名单中ip个数 */ IpWhiteListCount: number; /** * 数据备份cos bucket: 转存到cos 的bucket地址注意：此字段可能返回 null，表示取不到有效值。 */ ForwardCosBucket: string; /** * 数据备份cos 状态： 1 不开启数据备份，0 开启数据备份 */ ForwardStatus: number; /** * 数据备份到cos的周期频率 */ ForwardInterval: number; /** * 高级配置注意：此字段可能返回 null，表示取不到有效值。 */ Config: Config; /** * 消息保留时间配置(用于动态配置变更记录) 注意：此字段可能返回 null，表示取不到有效值。 */ RetentionTimeConfig: TopicRetentionTimeConfigRsp; /** * 0:正常，1：已删除，2：删除中注意：此字段可能返回 null，表示取不到有效值。 */ Status: number; /** * 标签列表注意：此字段可能返回 null，表示取不到有效值。 */ Tags: Array<Tag>; } /** * DeleteAcl请求参数结构体 */ export interface DeleteAclRequest { /** * 实例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)，当前ckakfa支持ALLOW(相当于白名单)，其它用于后续兼容开源kafka的acl时使用 */ PermissionType: number; /** * 默认为\*，表示任何host都可以访问，当前ckafka不支持host为\*，但是后面开源kafka的产品化会直接支持 */ Host?: string; /** * 用户列表，默认为*，表示任何user都可以访问，当前用户只能是用户列表中包含的用户 */ Principal?: string; } /** * CreateInstancePost返回参数结构体 */ export interface CreateInstancePostResponse { /** * 返回结果 */ Result?: JgwOperateResponse; /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * dip失败消息写入cls的配置 */ export interface DropCls { /** * 是否投递到cls 注意：此字段可能返回 null，表示取不到有效值。 */ DropInvalidMessageToCls?: boolean; /** * 投递cls的地域注意：此字段可能返回 null，表示取不到有效值。 */ DropClsRegion?: string; /** * 投递cls的账号注意：此字段可能返回 null，表示取不到有效值。 */ DropClsOwneruin?: string; /** * 投递cls的主题注意：此字段可能返回 null，表示取不到有效值。 */ DropClsTopicId?: string; /** * 投递cls的日志集id 注意：此字段可能返回 null，表示取不到有效值。 */ DropClsLogSet?: string; } /** * 预付费/后付费接口中，订单和 CKafka 实例映射数据结构 */ export interface DealInstanceDTO { /** * 订单流水注意：此字段可能返回 null，表示取不到有效值。 */ DealName?: string; /** * 订单流水对应购买的 CKafka 实例 id 列表注意：此字段可能返回 null，表示取不到有效值。 */ InstanceIdList?: Array<string>; } /** * consumer信息 */ export interface GroupInfoMember { /** * coordinator 为消费分组中的消费者生成的唯一 ID */ MemberId: string; /** * 客户消费者 SDK 自己设置的 client.id 信息 */ ClientId: string; /** * 一般存储客户的 IP 地址 */ ClientHost: string; /** * 存储着分配给该消费者的 partition 信息 */ Assignment: Assignment; } /** * 数据处理ROW输出格式配置 */ export interface RowParam { /** * 行内容，KEY_VALUE，VALUE */ RowContent: string; /** * key和value间的分隔符注意：此字段可能返回 null，表示取不到有效值。 */ KeyValueDelimiter?: string; /** * 元素建的分隔符注意：此字段可能返回 null，表示取不到有效值。 */ EntryDelimiter?: string; } /** * RouteDTO */ export interface RouteDTO { /** * RouteId11 注意：此字段可能返回 null，表示取不到有效值。 */ RouteId?: number; } /** * Es连接源参数 */ export interface EsConnectParam { /** * Es的连接port 注意：此字段可能返回 null，表示取不到有效值。 */ Port: number; /** * Es连接源的用户名注意：此字段可能返回 null，表示取不到有效值。 */ UserName: string; /** * Es连接源的密码注意：此字段可能返回 null，表示取不到有效值。 */ Password: string; /** * Es连接源的实例资源注意：此字段可能返回 null，表示取不到有效值。 */ Resource: string; /** * Es连接源是否为自建集群注意：此字段可能返回 null，表示取不到有效值。 */ SelfBuilt: boolean; /** * Es连接源的实例vip，当为腾讯云实例时，必填注意：此字段可能返回 null，表示取不到有效值。 */ ServiceVip?: string; /** * Es连接源的vpcId，当为腾讯云实例时，必填注意：此字段可能返回 null，表示取不到有效值。 */ UniqVpcId?: string; /** * 是否更新到关联的Datahub任务注意：此字段可能返回 null，表示取不到有效值。 */ IsUpdate?: boolean; } /** * BatchCreateAcl请求参数结构体 */ export interface BatchCreateAclRequest { /** * 实例ID */ InstanceId: string; /** * Acl资源类型，(2:TOPIC） */ ResourceType: number; /** * 资源列表数组 */ ResourceNames: Array<string>; /** * 设置的ACL规则列表 */ RuleList: Array<AclRuleInfo>; } /** * DescribeDatahubTask返回参数结构体 */ export interface DescribeDatahubTaskResponse { /** * 返回结果 */ Result: DescribeDatahubTaskRes; /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DeleteUser请求参数结构体 */ export interface DeleteUserRequest { /** * 实例Id */ InstanceId: string; /** * 用户名称 */ Name: string; } /** * 分区和位移 */ export interface PartitionOffset { /** * Partition,例如"0"或"1" 注意：此字段可能返回 null，表示取不到有效值。 */ Partition: string; /** * Offset,例如100 注意：此字段可能返回 null，表示取不到有效值。 */ Offset: number; } /** * SQLServer连接源参数 */ export interface SQLServerConnectParam { /** * SQLServer的连接port 注意：此字段可能返回 null，表示取不到有效值。 */ Port: number; /** * SQLServer连接源的用户名注意：此字段可能返回 null，表示取不到有效值。 */ UserName: string; /** * SQLServer连接源的密码注意：此字段可能返回 null，表示取不到有效值。 */ Password: string; /** * SQLServer连接源的实例资源注意：此字段可能返回 null，表示取不到有效值。 */ Resource: string; /** * SQLServer连接源的实例vip，当为腾讯云实例时，必填注意：此字段可能返回 null，表示取不到有效值。 */ ServiceVip?: string; /** * SQLServer连接源的vpcId，当为腾讯云实例时，必填注意：此字段可能返回 null，表示取不到有效值。 */ UniqVpcId?: string; /** * 是否更新到关联的Dip任务注意：此字段可能返回 null，表示取不到有效值。 */ IsUpdate?: boolean; } /** * 删除实例返回任务 */ export interface InstanceDeleteResponse { /** * 删除实例返回的任务Id 注意：此字段可能返回 null，表示取不到有效值。 */ FlowId: number; } /** * CreateConnectResource返回参数结构体 */ export interface CreateConnectResourceResponse { /** * 连接源的Id */ Result?: ConnectResourceResourceIdResp; /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * Es修改连接源参数 */ export interface EsModifyConnectParam { /** * Es连接源的实例资源【不支持修改】注意：此字段可能返回 null，表示取不到有效值。 */ Resource: string; /** * Es的连接port【不支持修改】注意：此字段可能返回 null，表示取不到有效值。 */ Port?: number; /** * Es连接源的实例vip【不支持修改】注意：此字段可能返回 null，表示取不到有效值。 */ ServiceVip?: string; /** * Es连接源的vpcId【不支持修改】注意：此字段可能返回 null，表示取不到有效值。 */ UniqVpcId?: string; /** * Es连接源的用户名注意：此字段可能返回 null，表示取不到有效值。 */ UserName?: string; /** * Es连接源的密码注意：此字段可能返回 null，表示取不到有效值。 */ Password?: string; /** * Es连接源是否为自建集群【不支持修改】注意：此字段可能返回 null，表示取不到有效值。 */ SelfBuilt?: boolean; /** * 是否更新到关联的Datahub任务注意：此字段可能返回 null，表示取不到有效值。 */ IsUpdate?: boolean; } /** * Topic消息保留时间配置返回信息 */ export interface TopicRetentionTimeConfigRsp { /** * 期望值，即用户配置的Topic消息保留时间(单位分钟) 注意：此字段可能返回 null，表示取不到有效值。 */ Expect: number; /** * 当前值，即当前生效值(可能存在动态调整，单位分钟) 注意：此字段可能返回 null，表示取不到有效值。 */ Current: number; /** * 最近变更时间注意：此字段可能返回 null，表示取不到有效值。 */ ModTimeStamp: number; } /** * 批量修改topic属性结果 */ export interface BatchModifyTopicResultDTO { /** * 实例id 注意：此字段可能返回 null，表示取不到有效值。 */ InstanceId: string; /** * topic名称注意：此字段可能返回 null，表示取不到有效值。 */ TopicName: string; /** * 状态码注意：此字段可能返回 null，表示取不到有效值。 */ ReturnCode: string; /** * 状态消息 */ Message: string; } /** * 订阅信息实体 */ export interface SubscribedInfo { /** * 订阅的主题名 */ TopicName: string; /** * 订阅的分区注意：此字段可能返回 null，表示取不到有效值。 */ Partition: Array<number | bigint>; /** * 分区offset信息注意：此字段可能返回 null，表示取不到有效值。 */ PartitionOffset: Array<PartitionOffset>; /** * 订阅的主题ID 注意：此字段可能返回 null，表示取不到有效值。 */ TopicId: string; } /** * DescribeTopicAttributes请求参数结构体 */ export interface DescribeTopicAttributesRequest { /** * 实例 ID */ InstanceId: string; /** * 主题名称 */ TopicName: string; } /** * DescribeDatahubGroupOffsets返回参数结构体 */ export interface DescribeDatahubGroupOffsetsResponse { /** * 返回的结果对象 */ Result: GroupOffsetResponse; /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 值支持一拆多，即将一个值拆为一个数组 */ export interface SplitParam { /** * 分隔符 */ Regex: string; } /** * 用户组实体 */ export interface ConsumerGroup { /** * 用户组名称 */ ConsumerGroupName: string; /** * 订阅信息实体 */ SubscribedInfo: Array<SubscribedInfo>; } /** * 存储着分配给该消费者的 partition 信息 */ export interface Assignment { /** * assingment版本信息 */ Version: number; /** * topic信息列表注意：此字段可能返回 null，表示取不到有效值。 */ Topics: Array<GroupInfoTopics>; } /** * 查询连接源具体数据的返参 */ export interface DescribeConnectResourceResp { /** * 连接源的Id 注意：此字段可能返回 null，表示取不到有效值。 */ ResourceId: string; /** * 连接源名称注意：此字段可能返回 null，表示取不到有效值。 */ ResourceName: string; /** * 连接源描述注意：此字段可能返回 null，表示取不到有效值。 */ Description: string; /** * 连接源类型注意：此字段可能返回 null，表示取不到有效值。 */ Type: string; /** * 连接源的状态注意：此字段可能返回 null，表示取不到有效值。 */ Status: number; /** * 连接源的创建时间注意：此字段可能返回 null，表示取不到有效值。 */ CreateTime: string; /** * 连接源的异常信息注意：此字段可能返回 null，表示取不到有效值。 */ ErrorMessage: string; /** * 连接源的当前所处步骤注意：此字段可能返回 null，表示取不到有效值。 */ 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; } /** * AuthorizeToken返回参数结构体 */ export interface AuthorizeTokenResponse { /** * 0 成功注意：此字段可能返回 null，表示取不到有效值。 */ Result: number; /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeDatahubTask请求参数结构体 */ export interface DescribeDatahubTaskRequest { /** * 任务id */ TaskId: string; } /** * Url解析 */ export interface UrlDecodeParam { /** * 编码注意：此字段可能返回 null，表示取不到有效值。 */ CharsetName?: string; } /** * FetchLatestDatahubMessageList返回参数结构体 */ export interface FetchLatestDatahubMessageListResponse { /** * 返回结果。 */ Result: Array<ConsumerRecord>; /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * Es类型入参 */ export interface EsParam { /** * 实例资源 */ 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?: 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; } /** * DescribeTopicSubscribeGroup返回参数结构体 */ export interface DescribeTopicSubscribeGroupResponse { /** * 返回结果 */ Result: TopicSubscribeGroup; /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * CancelAuthorizationToken请求参数结构体 */ export interface CancelAuthorizationTokenRequest { /** * 实例ID */ InstanceId: string; /** * 用户 */ User: string; /** * token串 */ Tokens: string; } /** * CancelAuthorizationToken返回参数结构体 */ export interface CancelAuthorizationTokenResponse { /** * 0 成功注意：此字段可能返回 null，表示取不到有效值。 */ Result: number; /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * FetchMessageListByOffset返回参数结构体 */ export interface FetchMessageListByOffsetResponse { /** * 返回结果。注意，列表中不返回具体的消息内容（key、value），如果需要查询具体消息内容，请使用FetchMessageByOffset接口 */ Result?: Array<ConsumerRecord>; /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * InquireCkafkaPrice接口询价返回值 */ export interface InquireCkafkaPriceResp { /** * 实例价格注意：此字段可能返回 null，表示取不到有效值。 */ InstancePrice: InquiryPrice; /** * 公网带宽价格注意：此字段可能返回 null，表示取不到有效值。 */ PublicNetworkBandwidthPrice: InquiryPrice; } /** * CreateRoute请求参数结构体 */ export interface CreateRouteRequest { /** * 实例唯一id */ InstanceId: string; /** * 路由网络类型(3:vpc路由;4:标准版支撑路由;7:专业版支撑路由) */ VipType: number; /** * vpc网络Id */ VpcId?: string; /** * vpc子网id */ SubnetId?: string; /** * 访问类型：0-plaintext；1-sasl_plaintext；2-ssl；3-sasl_ssl */ AccessType?: number; /** * 是否需要权限管理 */ AuthFlag?: number; /** * 调用方appId */ CallerAppid?: number; /** * 公网带宽 */ PublicNetwork?: number; /** * vip地址 */ Ip?: string; } /** * SQLServer修改连接源参数 */ export interface SQLServerModifyConnectParam { /** * SQLServer连接源的实例资源【不支持修改】注意：此字段可能返回 null，表示取不到有效值。 */ Resource: string; /** * SQLServer的连接port【不支持修改】注意：此字段可能返回 null，表示取不到有效值。 */ Port?: number; /** * SQLServer连接源的实例vip【不支持修改】注意：此字段可能返回 null，表示取不到有效值。 */ ServiceVip?: string; /** * SQLServer连接源的vpcId【不支持修改】注意：此字段可能返回 null，表示取不到有效值。 */ UniqVpcId?: string; /** * SQLServer连接源的用户名注意：此字段可能返回 null，表示取不到有效值。 */ UserName?: string; /** * SQLServer连接源的密码注意：此字段可能返回 null，表示取不到有效值。 */ Password?: string; /** * 是否更新到关联的Dip任务注意：此字段可能返回 null，表示取不到有效值。 */ IsUpdate?: boolean; } /** * DeleteTopic请求参数结构体 */ export interface DeleteTopicRequest { /** * ckafka 实例Id */ InstanceId: string; /** * ckafka 主题名称 */ TopicName: string; } /** * DescribeDatahubTasks请求参数结构体 */ export interface DescribeDatahubTasksRequest { /** * 返回数量，默认为20，最大值为100 */ Limit?: number; /** * 分页偏移量，默认为0 */ Offset?: number; /** * 过滤条件，按照 TaskName 过滤，支持模糊查询 */ SearchWord?: string; /** * 转储的目标类型 */ TargetType?: string; /** * 任务类型，SOURCE数据接入，SINK数据流出 */ TaskType?: string; /** * 转储的源类型 */ SourceType?: string; /** * 转储的资源 */ Resource?: string; } /** * DescribeInstances返回参数结构体 */ export interface DescribeInstancesResponse { /** * 返回的结果 */ Result: InstanceResponse; /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * Datahub资源配置 */ export interface DatahubResource { /** * 资源类型 */ Type: string; /** * ckafka配置，Type为KAFKA时必填注意：此字段可能返回 null，表示取不到有效值。 */ KafkaParam?: KafkaParam; /** * EB配置，Type为EB时必填注意：此字段可能返回 null，表示取不到有效值。 */ EventBusParam?: EventBusParam; /** * MongoDB配置，Type为MONGODB时必填注意：此字段可能返回 null，表示取不到有效值。 */ MongoDBParam?: MongoDBParam; /** * Es配置，Type为ES时必填注意：此字段可能返回 null，表示取不到有效值。 */ EsParam?: EsParam; /** * Tdw配置，Type为TDW时必填注意：此字段可能返回 null，表示取不到有效值。 */ TdwParam?: TdwParam; /** * Dts配置，Type为DTS时必填注意：此字段可能返回 null，表示取不到有效值。 */ DtsParam?: DtsParam; /** * ClickHouse配置，Type为CLICKHOUSE时必填注意：此字段可能返回 null，表示取不到有效值。 */ ClickHouseParam?: ClickHouseParam; /** * Cls配置，Type为CLS时必填注意：此字段可能返回 null，表示取不到有效值。 */ ClsParam?: ClsParam; /** * Cos配置，Type为COS时必填注意：此字段可能返回 null，表示取不到有效值。 */ CosParam?: CosParam; /** * MySQL配置，Type为MYSQL时必填注意：此字段可能返回 null，表示取不到有效值。 */ MySQLParam?: MySQLParam; /** * PostgreSQL配置，Type为POSTGRESQL或TDSQL_C_POSTGRESQL时必填注意：此字段可能返回 null，表示取不到有效值。 */ PostgreSQLParam?: PostgreSQLParam; /** * Topic配置，Type为Topic时必填注意：此字段可能返回 null，表示取不到有效值。 */ TopicParam?: TopicParam; /** * MariaDB配置，Type为MARIADB时必填注意：此字段可能返回 null，表示取不到有效值。 */ MariaDBParam?: MariaDBParam; /** * SQLServer配置，Type为SQLSERVER时必填注意：此字段可能返回 null，表示取不到有效值。 */ SQLServerParam?: SQLServerParam; /** * Ctsdb配置，Type为CTSDB时必填注意：此字段可能返回 null，表示取不到有效值。 */ CtsdbParam?: CtsdbParam; /** * Scf配置，Type为SCF时必填注意：此字段可能返回 null，表示取不到有效值。 */ ScfParam?: ScfParam; } /** * BatchModifyTopicAttributes返回参数结构体 */ export interface BatchModifyTopicAttributesResponse { /** * 返回结果 */ Result: Array<BatchModifyTopicResultDTO>; /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * ClickHouse类型入参 */ export interface ClickHouseParam { /** * ClickHouse的集群注意：此字段可能返回 null，表示取不到有效值。 */ Cluster: string; /** * ClickHouse的数据库名注意：此字段可能返回 null，表示取不到有效值。 */ Database: string; /** * ClickHouse的数据表名注意：此字段可能返回 null，表示取不到有效值。 */ Table: string; /** * ClickHouse的schema 注意：此字段可能返回 null，表示取不到有效值。 */ Schema: Array<ClickHouseSchema>; /** * 实例资源注意：此字段可能返回 null，表示取不到有效值。 */ Resource: string; /** * ClickHouse的连接ip 注意：此字段可能返回 null，表示取不到有效值。 */ Ip?: string; /** * ClickHouse的连接port 注意：此字段可能返回 null，表示取不到有效值。 */ Port?: number; /** * ClickHouse的用户名注意：此字段可能返回 null，表示取不到有效值。 */ UserName?: string; /** * ClickHouse的密码注意：此字段可能返回 null，表示取不到有效值。 */ Password?: string; /** * 实例vip 注意：此字段可能返回 null，表示取不到有效值。 */ ServiceVip?: string; /** * 实例的vpcId 注意：此字段可能返回 null，表示取不到有效值。 */ UniqVpcId?: string; /** * 是否为自建集群注意：此字段可能返回 null，表示取不到有效值。 */ SelfBuilt?: boolean; /** * ClickHouse是否抛弃解析失败的消息，默认为true 注意：此字段可能返回 null，表示取不到有效值。 */ DropInvalidMessage?: boolean; /** * ClickHouse 类型，emr-clickhouse : "emr";cdw-clickhouse : "cdwch";自建 : "" 注意：此字段可能返回 null，表示取不到有效值。 */ Type?: string; /** * 当设置成员参数DropInvalidMessageToCls设置为true时,DropInvalidMessage参数失效注意：此字段可能返回 null，表示取不到有效值。 */ DropCls?: DropCls; /** * 每批次投递到 ClickHouse 表消息数量，默认为 1000 条。提高该参数值，有利于减少往 ClickHouse 投递的次数，但在错误消息过多及网络不稳定等极端情况下时，可能导致频繁重试影响效率。注意：此字段可能返回 null，表示取不到有效值。 */ BatchSize?: number; /** * 每次从 topic 中拉取消息大小，默认为 1MB，即至少要从 topic 中批量拉取 1MB 消息，才进行数据投递到 ClickHouse 操作。提高该参数值，有利于减少往 ClickHouse 投递的次数，但在错误消息过多及网络不稳定等极端情况下时，可能导致频繁重试影响效率。注意：此字段可能返回 null，表示取不到有效值。 */ ConsumerFetchMinBytes?: number; /** * 每次从 topic 拉取消息最大等待时间，当超过当前最大等待时间时，即使没有拉取到 ConsumerFetchMinBytes 大小，也将进行 ClickHouse 投递操作。提高该参数值，有利于减少往 ClickHouse 投递的次数，但在错误消息过多及网络不稳定等极端情况下时，可能导致频繁重试影响效率。注意：此字段可能返回 null，表示取不到有效值。 */ ConsumerFetchMaxWaitMs?: number; } /** * 过滤器参数 */ export interface FilterMapParam { /** * Key值 */ Key: string; /** * 匹配模式，前缀匹配PREFIX，后缀匹配SUFFIX，包含匹配CONTAINS，EXCEPT除外匹配，数值匹配NUMBER，IP匹配IP */ MatchMode: string; /** * Value值 */ Value: string; /** * 固定REGULAR */ Type?: string; } /** * 预付费实例相关接口返回结构 */ export interface CreateInstancePreResp { /** * 返回的code，0为正常，非0为错误 */ ReturnCode: string; /** * 成功消息 */ ReturnMessage: string; /** * 操作型返回的Data数据注意：此字段可能返回 null，表示取不到有效值。 */ Data: CreateInstancePreData; /** * 删除时间。目前该参数字段已废弃，将会在未来被删除注意：此字段可能返回 null，表示取不到有效值。 * @deprecated */ DeleteRouteTimestamp?: string; } /** * 消息字段与 es 索引的映射关系 */ export interface EsRecordMapping { /** * es 索引成员名称 */ ColumnName?: string; /** * 消息字段名称 */ JsonKey?: string; } /** * ModifyDatahubTask返回参数结构体 */ export interface ModifyDatahubTaskResponse { /** * 任务id 注意：此字段可能返回 null，表示取不到有效值。 */ Result: DatahubTaskIdRes; /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * GroupInfo内部topic对象 */ export interface GroupInfoTopics { /** * 分配的 topic 名称 */ Topic: string; /** * 分配的 partition 信息注意：此字段可能返回 null，表示取不到有效值。 */ Partitions: Array<number | bigint>; } /** * InstanceScalingDown请求参数结构体 */ export interface InstanceScalingDownRequest { /** * 实例id */ InstanceId: string; /** * 缩容模式 1:稳定变配 2.高速变配 */ UpgradeStrategy: number; /** * 磁盘大小单位 GB */ DiskSize?: number; /** * 峰值带宽单位 MB/s */ BandWidth?: number; /** * 分区上限 */ Partition?: number; } /** * FetchMessageListByOffset请求参数结构体 */ export interface FetchMessageListByOffsetRequest { /** * 实例Id */ InstanceId: string; /** * 主题名 */ Topic: string; /** * 分区id */ Partition: number; /** * 位点信息 */ Offset: number; /** * 最大查询条数，默认20，最大20 */ SinglePartitionRecordNumber?: number; } /** * 地域实体对象 */ export interface Region { /** * 地域ID */ RegionId: number; /** * 地域名称 */ RegionName: string; /** * 区域名称 */ AreaName: string; /** * 地域代码注意：此字段可能返回 null，表示取不到有效值。 */ RegionCode: string; /** * 地域代码（V3版本）注意：此字段可能返回 null，表示取不到有效值。 */ RegionCodeV3: string; /** * NONE:默认值不支持任何特殊机型\nCVM:支持CVM类型注意：此字段可能返回 null，表示取不到有效值。 */ Support: string; /** * 是否支持ipv6, 0：表示不支持，1：表示支持注意：此字段可能返回 null，表示取不到有效值。 */ Ipv6: number; /** * 是否支持跨可用区, 0：表示不支持，1：表示支持注意：此字段可能返回 null，表示取不到有效值。 */ MultiZone: number; } /** * ModifyInstancePre请求参数结构体 */ export interface ModifyInstancePreRequest { /** * 实例名称 */ InstanceId: string; /** * 预计磁盘，根据磁盘步长，规格向上调整。 */ DiskSize: number; /** * 预计带宽，根据带宽步长，规格向上调整。 */ BandWidth: number; /** * 预计分区，根据带宽步长，规格向上调整。 */ Partition?: number; } /** * CreateAclRule请求参数结构体 */ export interface CreateAclRuleRequest { /** * 实例id信息 */ InstanceId: string; /** * Acl资源类型,目前只支持Topic,枚举值列表：Topic */ ResourceType: string; /** * 匹配类型，目前支持前缀匹配与预设策略，枚举值列表：PREFIXED/PRESET */ PatternType: string; /** * 规则名称 */ RuleName: string; /** * 设置的ACL规则列表 */ RuleList: Array<AclRuleInfo>; /** * 表示前缀匹配的前缀的值 */ Pattern?: string; /** * 预设ACL规则是否应用到新增的topic中 */ IsApplied?: number; /** * ACL规则的备注 */ Comment?: string; } /** * 数据处理参数 */ export interface TransformsParam { /** * 原始数据 */ Content: string; /** * 处理链 */ FieldChain: Array<FieldParam>; /** * 过滤器注意：此字段可能返回 null，表示取不到有效值。 */ FilterParam?: Array<FilterMapParam>; /** * 失败处理注意：此字段可能返回 null，表示取不到有效值。 */ FailureParam?: FailureParam; /** * 测试结果注意：此字段可能返回 null，表示取不到有效值。 */ Result?: string; /** * 数据来源注意：此字段可能返回 null，表示取不到有效值。 */ SourceType?: string; /** * 输出格式，JSON，ROW，默认为JSON 注意：此字段可能返回 null，表示取不到有效值。 */ OutputFormat?: string; /** * 输出格式为ROW必填注意：此字段可能返回 null，表示取不到有效值。 */ RowParam?: RowParam; /** * 是否保留数据源Topic元数据信息（源Topic、Partition、Offset），默认为false 注意：此字段可能返回 null，表示取不到有效值。 */ KeepMetadata?: boolean; /** * 数组解析注意：此字段可能返回 null，表示取不到有效值。 */ BatchAnalyse?: BatchAnalyseParam; } /** * ClickHouse修改连接源参数 */ export interface ClickHouseModifyConnectParam { /** * ClickHouse连接源的实例资源【不支持修改】注意：此字段可能返回 null，表示取不到有效值。 */ Resource: string; /** * ClickHouse的连接port【不支持修改】注意：此字段可能返回 null，表示取不到有效值。 */ Port?: number; /** * ClickHouse连接源的实例vip【不支持修改】注意：此字段可能返回 null，表示取不到有效值。 */ ServiceVip?: string; /** * ClickHouse连接源的vpcId【不支持修改】注意：此字段可能返回 null，表示取不到有效值。 */ UniqVpcId?: string; /** * ClickHouse连接源的用户名注意：此字段可能返回 null，表示取不到有效值。 */ UserName?: string; /** * ClickHouse连接源的密码注意：此字段可能返回 null，表示取不到有效值。 */ Password?: string; /** * ClickHouse连接源是否为自建集群【不支持修改】注意：此字段可能返回 null，表示取不到有效值。 */ SelfBuilt?: boolean; /** * 是否更新到关联的Datahub任务，默认为true 注意：此字段可能返回 null，表示取不到有效值。 */ IsUpdate?: boolean; } /** * ModifyAclRule请求参数结构体 */ export interface ModifyAclRuleRequest { /** * 实例Id */ InstanceId: string; /** * ACL策略名 */ RuleName: string; /** * 是否应用到新增的Topic */ IsApplied: number; } /** * 查询Datahub任务列表 */ export interface DescribeDatahubTasksRes { /** * 任务总数 */ TotalCount: number; /** * Datahub任务信息列表注意：此字段可能返回 null，表示取不到有效值。 */ TaskList: Array<DatahubTaskInfo>; } /** * DescribeInstancesDetail返回参数结构体 */ export interface DescribeInstancesDetailResponse { /** * 返回的实例详情结果对象 */ Result?: InstanceDetailResponse; /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 创建预付费接口返回的Data */ export interface CreateInstancePreData { /** * CreateInstancePre返回固定为0，不能作为CheckTaskStatus的查询条件。只是为了保证和后台数据结构对齐。注意：此字段可能返回 null，表示取不到有效值。 */ FlowId: number; /** * 订单号列表注意：此字段可能返回 null，表示取不到有效值。 */ DealNames: Array<string>; /** * 实例Id，当购买多个实例时，默认返回购买的第一个实例 id 注意：此字段可能返回 null，表示取不到有效值。 */ InstanceId: string; /** * 订单和购买实例对应映射列表注意：此字段可能返回 null，表示取不到有效值。 */ DealNameInstanceIdMapping?: Array<DealInstanceDTO>; } /** * DescribeAppInfo请求参数结构体 */ export interface DescribeAppInfoRequest { /** * 偏移位置 */ Offset?: number; /** * 本次查询用户数目最大数量限制，最大值为50，默认50 */ Limit?: number; } /** * AclRule列表接口出参 */ export interface AclRule { /** * Acl规则名称注意：此字段可能返回 null，表示取不到有效值。 */ RuleName: string; /** * 实例ID 注意：此字段可能返回 null，表示取不到有效值。 */ InstanceId: string; /** * 匹配类型，目前只支持前缀匹配，枚举值列表：PREFIXED 注意：此字段可能返回 null，表示取不到有效值。 */ PatternType: string; /** * 表示前缀匹配的前缀的值注意：此字段可能返回 null，表示取不到有效值。 */ Pattern: string; /** * Acl资源类型,目前只支持Topic,枚举值列表：Topic 注意：此字段可能返回 null，表示取不到有效值。 */ ResourceType: string; /** * 该规则所包含的ACL信息注意：此字段可能返回 null，表示取不到有效值。 */ AclList: string; /** * 规则所创建的时间注意：此字段可能返回 null，表示取不到有效值。 */ CreateTimeStamp: string; /** * 预设ACL规则是否应用到新增的topic中注意：此字段可能返回 null，表示取不到有效值。 */ IsApplied: number; /** * 规则更新时间注意：此字段可能返回 null，表示取不到有效值。 */ UpdateTimeStamp: string; /** * 规则的备注注意：此字段可能返回 null，表示取不到有效值。 */ Comment: string; /** * 其中一个显示的对应的TopicName 注意：此字段可能返回 null，表示取不到有效值。 */ TopicName: string; /** * 应用该ACL规则的Topic数注意：此字段可能返回 null，表示取不到有效值。 */ TopicCount: number; /** * patternType的中文显示注意：此字段可能返回 null，表示取不到有效值。 */ PatternTypeTitle: string; } /** * 数据处理——数据处理参数 */ export interface SMTParam { /** * 数据处理KEY */ Key: string; /** * 操作，DATE系统预设-时间戳，CUSTOMIZE自定义，MAPPING映射，JSONPATH */ Operate: string; /** * 数据类型，ORIGINAL原始，STRING，INT64，FLOAT64，BOOLEAN，MAP，ARRAY */ SchemeType: string; /** * 数据处理VALUE 注意：此字段可能返回 null，表示取不到有效值。 */ Value?: string; /** * VALUE处理注意：此字段可能返回 null，表示取不到有效值。 */ ValueOperate?: ValueParam; /** * 原始VALUE 注意：此字段可能返回 null，表示取不到有效值。 */ OriginalValue?: string; /** * VALUE处理链注意：此字段可能返回 null，表示取不到有效值。 */ ValueOperates?: Array<ValueParam>; } /** * CheckCdcCluster返回参数结构体 */ export interface CheckCdcClusterResponse { /** * 返回结果状态Success 注意：此字段可能返回 null，表示取不到有效值。 */ Result: string; /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * Ctsdb连接源参数(更新) */ export interface CtsdbModifyConnectParam { /** * Ctsdb的连接port 注意：此字段可能返回 null，表示取不到有效值。 */ Port?: number; /** * Ctsdb连接源的实例vip 注意：此字段可能返回 null，表示取不到有效值。 */ ServiceVip?: string; /** * Ctsdb连接源的vpcId 注意：此字段可能返回 null，表示取不到有效值。 */ UniqVpcId?: string; /** * Ctsdb连接源的用户名注意：此字段可能返回 null，表示取不到有效值。 */ UserName?: string; /** * Ctsdb连接源的密码注意：此字段可能返回 null，表示取不到有效值。 */ Password?: string; /** * Ctsdb连接源的实例资源注意：此字段可能返回 null，表示取不到有效值。 */ Resource?: string; } /** * CreateToken返回参数结构体 */ export interface CreateTokenResponse { /** * token串注意：此字段可能返回 null，表示取不到有效值。 */ Result: string; /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeTopicFlowRanking请求参数结构体 */ export interface DescribeTopicFlowRankingRequest { /** * 实例ID */ InstanceId: string; /** * 排行类别(PRO-Topic生产流量/CON-Topic消费流量) */ RankingType: string; /** * 排行起始日期 */ BeginDate?: string; /** * 排行结束日期 */ EndDate?: string; /** * Broker IP 地址 */ BrokerIp?: string; } /** * 动态硬盘扩容配置 */ export interface DynamicDiskConfig { /** * 动态硬盘扩容配置开关（0: 关闭，1: 开启）注意：此字段可能返回 null，表示取不到有效值。 */ Enable?: number; /** * 每次磁盘动态扩容大小百分比注意：此字段可能返回 null，表示取不到有效值。 */ StepForwardPercentage?: number; /** * 磁盘配额百分比触发条件，即消息达到此值触发硬盘自动扩容事件注意：此字段可能返回 null，表示取不到有效值。 */ DiskQuotaPercentage?: number; /** * 最大扩容硬盘大小，以 GB 为单位注意：此字段可能返回 null，表示取不到有效值。 */ MaxDiskSpace?: number; } /** * topic消息堆积、占用磁盘排行 */ export interface TopicMessageHeapRanking { /** * 主题ID 注意：此字段可能返回 null，表示取不到有效值。 */ TopicId: string; /** * 主题名称注意：此字段可能返回 null，表示取不到有效值。 */ TopicName: string; /** * 分区数注意：此字段可能返回 null，表示取不到有效值。 */ PartitionNum: number; /** * 副本数注意：此字段可能返回 null，表示取不到有效值。 */ ReplicaNum: number; /** * Topic 流量注意：此字段可能返回 null，表示取不到有效值。 */ TopicTraffic: string; /** * topic消息堆积/占用磁盘注意：此字段可能返回 null，表示取不到有效值。 */ MessageHeap: number; } /** * Doris 连接源参数 */ export interface DorisConnectParam { /** * Doris jdbc 负载均衡连接 port，通常映射到 fe 的 9030 端口注意：此字段可能返回 null，表示取不到有效值。 */ Port: number; /** * Doris 连接源的用户名注意：此字段可能返回 null，表示取不到有效值。 */ UserName: string; /** * Doris 连接源的密码注意：此字段可能返回 null，表示取不到有效值。 */ Password: string; /** * Doris 连接源的实例资源注意：此字段可能返回 null，表示取不到有效值。 */ Resource: string; /** * Doris 连接源的实例vip，当为腾讯云实例时，必填注意：此字段可能返回 null，表示取不到有效值。 */ ServiceVip?: string; /** * Doris 连接源的vpcId，当为腾讯云实例时，必填注意：此字段可能返回 null，表示取不到有效值。 */ UniqVpcId?: string; /** * 是否更新到关联的Datahub任务注意：此字段可能返回 null，表示取不到有效值。 */ IsUpdate?: boolean; /** * Doris 连接源是否为自建集群注意：此字段可能返回 null，表示取不到有效值。 */ SelfBuilt?: boolean; /** * Doris 的 http 负载均衡连接 port，通常映射到 be 的 8040 端口注意：此字段可能返回 null，表示取不到有效值。 */ BePort?: number; } /** * SendMessage请求参数结构体 */ export interface SendMessageRequest { /** * DataHub接入ID */ DataHubId: string; /** * 发送消息内容(单次请求最多500条) */ Message: Array<BatchContent>; } /** * topic 流量排行 */ export interface TopicFlowRanking { /** * 主题Id */ TopicId: string; /** * 主题名称 */ TopicName: string; /** * 分区数 */ PartitionNum: number; /** * 副本数 */ ReplicaNum: number; /** * Topic 流量 */ TopicTraffic: string; /** * Topic 消息堆积 */ MessageHeap: number; } /** * broker维度topic 流量排行指标 */ export interface BrokerTopicFlowData { /** * Topic 名称注意：此字段可能返回 null，表示取不到有效值。 */ TopicName?: string; /** * Topic Id 注意：此字段可能返回 null，表示取不到有效值。 */ TopicId?: string; /** * Topic 流量(MB) 注意：此字段可能返回 null，表示取不到有效值。 */ TopicTraffic?: string; } /** * DeleteAclRule请求参数结构体 */ export interface DeleteAclRuleRequest { /** * 实例id信息 */ InstanceId: string; /** * acl规则名称 */ RuleName: string; } /** * DescribeConnectResources请求参数结构体 */ export interface DescribeConnectResourcesRequest { /** * 连接源类型 */ Type?: string; /** * 连接源名称的关键字查询 */ SearchWord?: string; /** * 分页偏移量，默认为0 */ Offset?: number; /** * 返回数量，默认为20，最大值为100 */ Limit?: number; /** * 连接源的关键字查询, 根据地域查询本地域内连接管理列表中的连接(仅支持包含region输入的连接源) */ ResourceRegion?: string; } /** * DescribeRoute请求参数结构体 */ export interface DescribeRouteRequest { /** * 实例唯一id */ InstanceId: string; /** * 路由id */ RouteId?: number; } /** * 返回的topic对象 */ export interface Topic { /** * 主题的ID */ TopicId: string; /** * 主题的名称 */ TopicName: string; /** * 备注注意：此字段可能返回 null，表示取不到有效值。 */ Note: string; } /** * 实例详情中的标签对象 */ export interface Tag { /** * 标签的key */ TagKey: string; /** * 标签的值 */ TagValue: string; } /** * ModifyAclRule返回参数结构体 */ export interface ModifyAclRuleResponse { /** * 规则的唯一表示Key */ Result: number; /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * PostgreSQL修改连接源参数 */ export interface PostgreSQLModifyConnectParam { /** * PostgreSQL连接源的实例资源【不支持修改】注意：此字段可能返回 null，表示取不到有效值。 */ Resource: string; /** * PostgreSQL的连接port【不支持修改】注意：此字段可能返回 null，表示取不到有效值。 */ Port?: number; /** * PostgreSQL连接源的实例vip【不支持修改】注意：此字段可能返回 null，表示取不到有效值。 */ ServiceVip?: string; /** * PostgreSQL连接源的vpcId【不支持修改】注意：此字段可能返回 null，表示取不到有效值。 */ UniqVpcId?: string; /** * PostgreSQL连接源的用户名注意：此字段可能返回 null，表示取不到有效值。 */ UserName?: string; /** * PostgreSQL连接源的密码注意：此字段可能返回 null，表示取不到有效值。 */ Password?: string; /** * 当type为TDSQL_C_POSTGRESQL时，该参数才有值【不支持修改】注意：此字段可能返回 null，表示取不到有效值。 */ ClusterId?: string; /** * 是否更新到关联的Datahub任务注意：此字段可能返回 null，表示取不到有效值。 */ IsUpdate?: boolean; /** * 是否为自建集群注意：此字段可能返回 null，表示取不到有效值。 */ SelfBuilt?: boolean; } /** * 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; } /** * ModifyInstanceAttributes返回参数结构体 */ export interface ModifyInstanceAttributesResponse { /** * 返回结果 */ Result?: JgwOperateResponse; /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeACL返回参数结构体 */ export interface DescribeACLResponse { /** * 返回的ACL结果集对象 */ Result: AclResponse; /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * BatchModifyGroupOffsets返回参数结构体 */ export interface BatchModifyGroupOffsetsResponse { /** * 返回结果 */ Result: JgwOperateResponse; /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeGroup的返回 */ export interface GroupResponse { /** * 计数注意：此字段可能返回 null，表示取不到有效值。 */ TotalCount: number; /** * GroupList 注意：此字段可能返回 null，表示取不到有效值。 */ GroupList: Array<DescribeGroup>; /** * 消费分组配额注意：此字段可能返回 null，表示取不到有效值。 */ GroupCountQuota?: number; } /** * 实例详情返回结果 */ export interface InstanceDetailResponse { /** * 符合条件的实例总数 */ TotalCount: number; /** * 符合条件的实例详情列表 */ InstanceList: Array<InstanceDetail>; } /** * 消费组偏移量返回结果 */ export interface GroupOffsetResponse { /** * 符合调节的总结果数 */ TotalCount: number; /** * 该主题分区数组，其中每个元素为一个 json object 注意：此字段可能返回 null，表示取不到有效值。 */ TopicList: Array<GroupOffsetTopic>; } /** * CreateDatahubTopic请求参数结构体 */ export interface CreateDatahubTopicRequest { /** * 名称，是一个不超过 128 个字符的字符串，必须以字母为首字符，剩余部分可以包含字母、数字和横划线(-) */ Name: string; /** * Partition个数，大于0 */ PartitionNum: number; /** * 消息保留时间，单位ms，当前最小值为60000ms */ RetentionMs: number; /** * 主题备注，是一个不超过 64 个字符的字符串，必须以字母为首字符，剩余部分可以包含字母、数字和横划线(-) */ Note?: string; /** * 标签列表 */ Tags?: Array<Tag>; } /** * DescribeTopic返回参数结构体 */ export interface DescribeTopicResponse { /** * 返回的结果注意：此字段可能返回 null，表示取不到有效值。 */ Result: TopicResult; /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 后付费实例相关接口返回结构 */ export interface CreateInstancePostResp { /** * 返回的code，0为正常，非0为错误 */ ReturnCode: string; /** * 接口返回消息，当接口报错时提示错误信息 */ ReturnMessage: string; /** * 返回的Data数据注意：此字段可能返回 null，表示取不到有效值。 */ Data: CreateInstancePostData; } /** * MongoDB修改连接源参数 */ export interface MongoDBModifyConnectParam { /** * MongoDB连接源的实例资源【不支持修改】注意：此字段可能返回 null，表示取不到有效值。 */ Resource: string; /** * MongoDB的连接port【不支持修改】注意：此字段可能返回 null，表示取不到有效值。 */ Port?: number; /** * MongoDB连接源的实例vip【不支持修改】注意：此字段可能返回 null，表示取不到有效值。 */ ServiceVip?: string; /** * MongoDB连接源的vpcId【不支持修改】注意：此字段可能返回 null，表示取不到有效值。 */ UniqVpcId?: string; /** * MongoDB连接源的用户名注意：此字段可能返回 null，表示取不到有效值。 */ UserName?: string; /** * MongoDB连接源的密码注意：此字段可能返回 null，表示取不到有效值。 */ Password?: string; /** * MongoDB连接源是否为自建集群【不支持修改】注意：此字段可能返回 null，表示取不到有效值。 */ SelfBuilt?: boolean; /** * 是否更新到关联的Datahub任务注意：此字段可能返回 null，表示取不到有效值。 */ IsUpdate?: boolean; } /** * 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; } /** * ModifyGroupOffsets请求参数结构体 */ export interface ModifyGroupOffsetsRequest { /** * kafka实例id */ InstanceId: string; /** * kafka 消费分组 */ Group: string; /** * 重置offset的策略，入参含义 0. 对齐shift-by参数，代表把offset向前或向后移动shift条 1. 对齐参考(by-duration,to-datetime,to-earliest,to-latest),代表把offset移动到指定timestamp的位置 2. 对齐参考(to-offset)，代表把offset移动到指定的offset位置 */ Strategy: number; /** * 表示需要重置的topics，不填表示全部 */ Topics?: Array<string>; /** * 当strategy为0时，必须包含该字段，可以大于零代表会把offset向后移动shift条，小于零则将offset向前回溯shift条数。正确重置后新的offset应该是(old_offset + shift)，需要注意的是如果新的offset小于partition的earliest则会设置为earliest，如果大于partition 的latest则会设置为latest */ Shift?: number; /** * 单位ms。当strategy为1时，必须包含该字段，其中-2表示重置offset到最开始的位置，-1表示重置到最新的位置(相当于清空)，其它值则代表指定的时间，会获取topic中指定时间的offset然后进行重置，需要注意的时，如果指定的时间不存在消息，则获取最末尾的offset。 */ ShiftTimestamp?: number; /** * 需要重新设置的offset位置。当strategy为2，必须包含该字段。 */ Offset?: number; /** * 需要重新设置的partition的列表，如果没有指定Topics参数。则重置全部topics的对应的Partition列表里的partition。指定Topics时则重置指定的topic列表的对应的Partitions列表的partition。 */ Partitions?: Array<number | bigint>; } /** * DescribeDatahubTopic返回参数结构体 */ export interface DescribeDatahubTopicResponse { /** * 返回的结果对象 */ Result: DescribeDatahubTopicResp; /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeCkafkaZone请求参数结构体 */ export interface DescribeCkafkaZoneRequest { /** * cdc专业集群业务参数 */ CdcId?: string; } /** * FetchDatahubMessageByOffset返回参数结构体 */ export interface FetchDatahubMessageByOffsetResponse { /** * 返回结果 */ Result: ConsumerRecord; /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * CreateConsumer返回参数结构体 */ export interface CreateConsumerResponse { /** * 创建group描述 */ Result: JgwOperateResponse; /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * CreatePostPaidInstance请求参数结构体 */ export interface CreatePostPaidInstanceRequest { /** * 实例名称，是一个不超过 64 个字符的字符串，必须以字母为首字符，剩余部分可以包含字母、数字和横划线(-) */ InstanceName?: string; /** * 创建的实例默认接入点所在的 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; } /** * CreateCdcCluster返回参数结构体 */ export interface CreateCdcClusterResponse { /** * 无 */ Result: CdcClusterResponse; /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeGroup返回参数结构体 */ export interface DescribeGroupResponse { /** * 返回结果集列表 */ Result?: GroupResponse; /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 创建CDC 标准版共享集群出参 */ export interface CdcClusterResponse { /** * 任务ID 注意：此字段可能返回 null，表示取不到有效值。 */ TaskId: number; } /** * ModifyPassword返回参数结构体 */ export interface ModifyPasswordResponse { /** * 返回结果 */ Result?: JgwOperateResponse; /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 修改实例属性的配置对象 */ export interface ModifyInstanceAttributesConfig { /** * 自动创建 true 表示开启，false 表示不开启 */ AutoCreateTopicEnable?: boolean; /** * 可选，如果auto.create.topic.enable设置为true没有设置该值时，默认设置为3 */ DefaultNumPartitions?: number; /** * 如果auto.create.topic.enable设置为true没有指定该值时默认设置为2 */ DefaultReplicationFactor?: number; } /** * DescribeTaskStatus返回参数结构体 */ export interface DescribeTaskStatusResponse { /** * 返回结果 */ Result?: TaskStatusResponse; /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * AuthorizeToken请求参数结构体 */ export interface AuthorizeTokenRequest { /** * 实例ID */ InstanceId: string; /** * 用户 */ User: string; /** * token串 */ Tokens: string; } /** * RenewCkafkaInstance接口出参bigDealIds */ export interface RenewCkafkaInstanceResp { /** * 订单号注意：此字段可能返回 null，表示取不到有效值。 */ BigDealId?: string; /** * 子订单号注意：此字段可能返回 null，表示取不到有效值。 */ DealName?: string; } /** * 操作类型返回的Data结构 */ export interface OperateResponseData { /** * FlowId11 注意：此字段可能返回 null，表示取不到有效值。 */ FlowId: number; /** * RouteIdDto 注意：此字段可能返回 null，表示取不到有效值。 */ RouteDTO?: RouteDTO; } /** * RenewCkafkaInstance返回参数结构体 */ export interface RenewCkafkaInstanceResponse { /** * 返回值 */ Result?: RenewCkafkaInstanceResp; /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeACL请求参数结构体 */ export interface DescribeACLRequest { /** * 实例Id */ InstanceId: string; /** *