tencentcloud-sdk-nodejs
Version:
2,477 lines (2,476 loc) • 240 kB
TypeScript
/**
* 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;
/**
* 关键字匹配
* @deprecated
*/
SearchWord?: string;
}
/**
* DescribeTopicSyncReplica返回参数结构体
*/
export interface DescribeTopicSyncReplicaResponse {
/**
* <p>返回topic 副本详情</p>
*/
Result?: TopicInSyncReplicaResult;
/**
* 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* FetchMessageByOffset请求参数结构体
*/
export interface FetchMessageByOffsetRequest {
/**
* <p>ckafka集群实例Id，可通过<a href="https://cloud.tencent.com/document/product/597/40835">DescribeInstances</a>接口获取</p>
*/
InstanceId: string;
/**
* <p>主题名，可通过<a href="https://cloud.tencent.com/document/product/597/40847">DescribeTopic</a>接口获取</p>
*/
Topic: string;
/**
* <p>分区id</p>
*/
Partition: number;
/**
* <p>位点信息</p>
*/
Offset: number;
}
/**
* 查询连接源具体数据的返参
*/
export interface DescribeConnectResourceResp {
/**
* <p>连接源的Id</p>
*/
ResourceId?: string;
/**
* <p>连接源名称</p>
*/
ResourceName?: string;
/**
* <p>连接源描述</p>
*/
Description?: string;
/**
* <p>连接源类型</p>
*/
Type?: string;
/**
* <p>连接源的状态 枚举值: -1 (创建失败) 、0 (创建中) 、 1 (运行中)、 2 (删除中) 、 4 (删除失败) 、 5 (配置更改中) 、 6 (配置更改失败) 、 7 (异常)</p>
*/
Status?: number;
/**
* <p>连接源的创建时间</p>
*/
CreateTime?: string;
/**
* <p>连接源的异常信息</p>
*/
ErrorMessage?: string;
/**
* <p>连接源的当前所处步骤</p>
*/
CurrentStep?: string;
/**
* <p>步骤列表</p>
注意：此字段可能返回 null，表示取不到有效值。
*/
StepList?: Array<string>;
/**
* <p>MySQL配置，Type为MYSQL或TDSQL_C_MYSQL时返回</p>
注意：此字段可能返回 null，表示取不到有效值。
*/
MySQLConnectParam?: MySQLConnectParam;
/**
* <p>PostgreSQL配置，Type为POSTGRESQL或TDSQL_C_POSTGRESQL时返回</p>
注意：此字段可能返回 null，表示取不到有效值。
*/
PostgreSQLConnectParam?: PostgreSQLConnectParam;
/**
* <p>Dts配置，Type为DTS时返回</p>
注意：此字段可能返回 null，表示取不到有效值。
*/
DtsConnectParam?: DtsConnectParam;
/**
* <p>MongoDB配置，Type为MONGODB时返回</p>
注意：此字段可能返回 null，表示取不到有效值。
*/
MongoDBConnectParam?: MongoDBConnectParam;
/**
* <p>Es配置，Type为ES时返回</p>
注意：此字段可能返回 null，表示取不到有效值。
*/
EsConnectParam?: EsConnectParam;
/**
* <p>ClickHouse配置，Type为CLICKHOUSE时返回</p>
注意：此字段可能返回 null，表示取不到有效值。
*/
ClickHouseConnectParam?: ClickHouseConnectParam;
/**
* <p>MariaDB配置，Type为MARIADB时返回</p>
注意：此字段可能返回 null，表示取不到有效值。
*/
MariaDBConnectParam?: MariaDBConnectParam;
/**
* <p>SQLServer配置，Type为SQLSERVER时返回</p>
注意：此字段可能返回 null，表示取不到有效值。
*/
SQLServerConnectParam?: SQLServerConnectParam;
/**
* <p>Ctsdb配置，Type为CTSDB时返回</p>
注意：此字段可能返回 null，表示取不到有效值。
*/
CtsdbConnectParam?: CtsdbConnectParam;
/**
* <p>Doris 配置，Type 为 DORIS 时返回</p>
注意：此字段可能返回 null，表示取不到有效值。
*/
DorisConnectParam?: DorisConnectParam;
/**
* <p>Kafka配置，Type 为 KAFKA 时返回</p>
注意：此字段可能返回 null，表示取不到有效值。
*/
KafkaConnectParam?: KafkaConnectParam;
/**
* <p>MQTT配置，Type 为 MQTT 时返回</p>
注意：此字段可能返回 null，表示取不到有效值。
*/
MqttConnectParam?: MqttConnectParam;
/**
* <p>标签列表</p>
*/
Tags?: Array<Tag>;
}
/**
* AuthorizeToken返回参数结构体
*/
export interface AuthorizeTokenResponse {
/**
* 0 成功
*/
Result?: number;
/**
* 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* Es类型入参
*/
export interface EsParam {
/**
* Es实例资源Id
*/
Resource: string;
/**
* Es的连接port
*/
Port?: number;
/**
* Es用户名
*/
UserName?: string;
/**
* Es密码
*/
Password?: string;
/**
* 是否为自建集群
*/
SelfBuilt?: boolean;
/**
* 实例vip
*/
ServiceVip?: string;
/**
* 实例的vpcId
*/
UniqVpcId?: string;
/**
* Es是否抛弃解析失败的消息
*/
DropInvalidMessage?: boolean;
/**
* Es自定义index名称
*/
Index?: string;
/**
* Es自定义日期后缀
*/
DateFormat?: string;
/**
* 非json格式数据的自定义key
*/
ContentKey?: string;
/**
* Es是否抛弃非json格式的消息
*/
DropInvalidJsonMessage?: boolean;
/**
* 转储到Es中的文档ID取值字段名
*/
DocumentIdField?: string;
/**
* Es自定义index名称的类型，STRING，JSONPATH，默认为STRING
*/
IndexType?: string;
/**
* 当设置成员参数DropInvalidMessageToCls设置为true时,DropInvalidMessage参数失效
*/
DropCls?: DropCls;
/**
* 转储到ES的消息为Database的binlog时，如果需要同步数据库操作，即增删改的操作到ES时填写数据库表主键
*/
DatabasePrimaryKey?: string;
/**
* 死信队列
*/
DropDlq?: FailureParam;
/**
* 使用数据订阅格式导入 es 时，消息与 es 索引字段映射关系。不填默认为默认字段匹配
*/
RecordMappingList?: Array<EsRecordMapping>;
/**
* 消息要映射为 es 索引中 @timestamp 的字段，如果当前配置为空，则使用消息的时间戳进行映射
*/
DateField?: string;
/**
* 用来区分当前索引映射，属于新建索引还是存量索引。"EXIST_MAPPING"：从存量索引中选择；"NEW_MAPPING"：新建索引
*/
RecordMappingMode?: string;
}
/**
* DescribeAclRule返回参数结构体
*/
export interface DescribeAclRuleResponse {
/**
* 返回的AclRule结果集对象
*/
Result?: AclRuleResp;
/**
* 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* Dts类型入参
*/
export interface DtsParam {
/**
* Dts实例Id
*/
Resource: string;
/**
* Dts的连接ip
*/
Ip?: string;
/**
* Dts的连接port
*/
Port?: number;
/**
* Dts订阅的topic
*/
Topic?: string;
/**
* Dts消费分组的Id
*/
GroupId?: string;
/**
* Dts消费分组的账号
*/
GroupUser?: string;
/**
* Dts消费分组的密码
*/
GroupPassword?: string;
/**
* false同步原始数据，true同步解析后的json格式数据,默认true
*/
TranSql?: boolean;
}
/**
* CancelAuthorizationToken请求参数结构体
*/
export interface CancelAuthorizationTokenRequest {
/**
* ckafka集群实例Id,可通过[DescribeInstances](https://cloud.tencent.com/document/product/597/40835)接口获取
*/
InstanceId: string;
/**
* 用户
*/
User: string;
/**
* token串
*/
Tokens: string;
}
/**
* MongoDB类型入参
*/
export interface MongoDBParam {
/**
* MongoDB的数据库名称
*/
Database: string;
/**
* MongoDB的集群
*/
Collection: string;
/**
* 是否复制存量数据，默认传参true
*/
CopyExisting: boolean;
/**
* 实例资源
*/
Resource: string;
/**
* MongoDB的连接ip
*/
Ip?: string;
/**
* MongoDB的连接port
*/
Port?: number;
/**
* MongoDB数据库用户名
*/
UserName?: string;
/**
* MongoDB数据库密码
*/
Password?: string;
/**
* 监听事件类型，为空时表示全选。取值包括insert,update,replace,delete,invalidate,drop,dropdatabase,rename，多个类型间使用,逗号分隔
*/
ListeningEvent?: string;
/**
* 主从优先级，默认主节点
*/
ReadPreference?: string;
/**
* 聚合管道
*/
Pipeline?: string;
/**
* 是否为自建集群
*/
SelfBuilt?: boolean;
}
/**
* DeleteTopic请求参数结构体
*/
export interface DeleteTopicRequest {
/**
* ckafka 实例Id
*/
InstanceId: string;
/**
* ckafka 主题名称
*/
TopicName: string;
}
/**
* FetchMessageListByOffset请求参数结构体
*/
export interface FetchMessageListByOffsetRequest {
/**
* <p>ckafka集群实例Id</p><p>取值参考：<a href="https://cloud.tencent.com/document/api/597/40835">DescribeInstances</a></p>
*/
InstanceId: string;
/**
* <p>主题名</p>
*/
Topic: string;
/**
* <p>分区id</p>
*/
Partition: number;
/**
* <p>位点信息</p>
*/
Offset: number;
/**
* <p>最大查询条数，默认20，最大20</p>
*/
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<AclRuleInfo>;
/**
* 表示前缀匹配的前缀的值 (当PatternType取值为PREFIXED时，此参数必填)
*/
Pattern?: string;
/**
* 预设ACL规则是否应用到新增的topic中。默认为0，表示否。取值为1时表示是。
*/
IsApplied?: number;
/**
* ACL规则的备注
*/
Comment?: string;
}
/**
* 路由列表过滤器
*/
export interface RouteFilter {
/**
* 过滤名称,目前支持security-group-id,按安全组关联过滤
*/
Name?: string;
/**
* 过滤值,当过滤名称为security-group-id时仅支持传单个value
*/
Values?: Array<string>;
/**
* 过滤关系,支持IN和NOT_IN,默认为IN
*/
Relation?: string;
}
/**
* DescribeInstancesDetail返回参数结构体
*/
export interface DescribeInstancesDetailResponse {
/**
* <p>返回的实例详情结果对象</p>
*/
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 {
/**
* <p>任务id</p>
*/
TaskId: string;
}
/**
* 操作型结果返回值
*/
export interface JgwOperateResponse {
/**
* <p>返回的code，0为正常，非0为错误</p>
*/
ReturnCode?: string;
/**
* <p>成功消息</p>
*/
ReturnMessage?: string;
/**
* <p>操作型返回的Data数据,可能有flowId等</p>
注意：此字段可能返回 null，表示取不到有效值。
*/
Data?: OperateResponseData;
}
/**
* 创建MQTT 为Source的Data Hub Task参数
*/
export interface MqttParam {
/**
* <p>需要同步的MQTT Topic列表, CSV格式</p>
*/
Topics: string;
/**
* <p>用于控制会话的持久性。cleanSession 为true时，连接时会创建一个全新的会话。 cleanSession = false时，连接时会恢复之前的会话。</p>
*/
CleanSession: boolean;
/**
* <p>MQTT instance-id</p>
*/
Resource?: string;
/**
* <p>MQTT实例VIP</p>
*/
Ip?: string;
/**
* <p>MQTT VIP 端口</p>
*/
Port?: number;
/**
* <p>MQTT实例用户名</p>
*/
UserName?: string;
/**
* <p>MQTT实例内账户密码</p>
*/
Password?: string;
/**
* <p>QoS</p>
*/
Qos?: number;
/**
* <p>tasks.max 订阅Topic的并发Task个数, 默认为1; 当设置大于1时, 使用Shared Subscription</p>
*/
MaxTasks?: number;
/**
* <p>MQTT 实例的Service VIP</p>
*/
ServiceVip?: string;
/**
* <p>MQTT实例的VPC ID</p>
*/
UniqVpcId?: string;
/**
* <p>是否为自建集群, MQTT只支持非自建集群</p>
*/
SelfBuilt?: boolean;
/**
* <p>MQTT消息过滤sql语句</p>
*/
SqlFilter?: string;
}
/**
* 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 {
/**
* <p>规则的唯一表示Key</p>
*/
Result?: number;
/**
* 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* CreateMetaDataAndOffsetSyncDatahubTask请求参数结构体
*/
export interface CreateMetaDataAndOffsetSyncDatahubTaskRequest {
/**
* <p>任务名称</p><p>参数格式：task-test</p><p>64字符内</p>
*/
TaskName: string;
/**
* <p>同步源连接</p><p>参数格式：resource-test</p>
*/
SourceResourceId: string;
/**
* <p>同步目标链接</p><p>参数格式：resource-test</p>
*/
TargetResourceId: string;
/**
* <p>连接器任务描述</p><p>128字符内</p>
*/
Description?: string;
/**
* <p>Offset类型，最开始位置earliest，最新位置latest</p><p>枚举值：</p><ul><li>earliest： 最开始位置</li><li>latest： 最新位置</li></ul>
*/
OffsetType?: string;
/**
* <p>正则匹配Topic列表</p><p>与TopicList参数二选一</p>
*/
TopicRegularExpression?: string;
/**
* <p>多选topic列表</p><p>与TopicRegularExpression参数二选一</p>
*/
TopicList?: Array<string>;
/**
* <p>Topic 前缀</p>
*/
Prefix?: string;
/**
* <p>Topic前缀分隔符</p><p>仅支持 "." / "-" / "_"</p>
*/
Separator?: string;
/**
* <p>标签列表</p>
*/
Tags?: Array<Tag>;
}
/**
* 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<string>;
/**
* ckafka集群实例名称
*/
InstanceName?: string;
/**
* 路由vpcId
*/
VpcId?: string;
/**
* 路由vip
*/
Vip?: string;
}
/**
* MongoDB修改连接源参数
*/
export interface MongoDBModifyConnectParam {
/**
* MongoDB连接源的实例资源【不支持修改】
*/
Resource: string;
/**
* MongoDB的连接port【不支持修改】
*/
Port?: number;
/**
* MongoDB连接源的实例vip【不支持修改】
*/
ServiceVip?: string;
/**
* MongoDB连接源的vpcId【不支持修改】
*/
UniqVpcId?: string;
/**
* MongoDB连接源的用户名
*/
UserName?: string;
/**
* MongoDB连接源的密码
*/
Password?: string;
/**
* MongoDB连接源是否为自建集群【不支持修改】
*/
SelfBuilt?: boolean;
/**
* 是否更新到关联的Datahub任务
*/
IsUpdate?: boolean;
}
/**
* FetchMessageListByOffset返回参数结构体
*/
export interface FetchMessageListByOffsetResponse {
/**
* <p>返回结果。注意，列表中不返回具体的消息内容（key、value），如果需要查询具体消息内容，请使用FetchMessageByOffset接口</p>
*/
Result?: Array<ConsumerRecord>;
/**
* 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DeleteRouteTriggerTime请求参数结构体
*/
export interface DeleteRouteTriggerTimeRequest {
/**
* ckafka集群实例Id,可通过[DescribeInstances](https://cloud.tencent.com/document/product/597/40835)接口获取
*/
InstanceId: string;
/**
* 修改删除路由的定时时间
*/
DelayTime: string;
}
/**
* CreatePostPaidInstance请求参数结构体
*/
export interface CreatePostPaidInstanceRequest {
/**
* <p>私有网络Id,可通过<a href="https://cloud.tencent.com/document/product/215/15778">DescribeVpcs</a>接口获取</p>
*/
VpcId: string;
/**
* <p>子网Id,可通过<a href="https://cloud.tencent.com/document/product/215/15784">DescribeSubnets</a>接口获取</p>
*/
SubnetId: string;
/**
* <p>ckafka集群实例名称，是一个长度不超过128的任意字符。</p>
*/
InstanceName?: string;
/**
* <p>国际站标准版实例规格。目前只有国际站标准版使用当前字段区分规格，国内站标准版使用峰值带宽区分规格。除了国际站标准版外的所有实例填写 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。</p>
*/
InstanceType?: number;
/**
* <p>实例日志的默认最长保留时间，单位分钟。不传入该参数时默认为 1440 分钟（1天），最大30天。当 topic 显式设置消息保留时间时，以 topic 保留时间为准</p>
*/
MsgRetentionTime?: number;
/**
* <p>创建实例时可以选择集群Id, 该入参表示集群Id。不指定实例所在集群则不传入该参数</p>
*/
ClusterId?: number;
/**
* <p>实例版本。目前支持当前支持"2.4.1", "2.4.2","2.8.1", "3.2.3"，默认取值"2.4.1"。"2.4.1" 与 "2.4.2" 属于同一个版本，传任意一个均可。</p>
*/
KafkaVersion?: string;
/**
* <p>实例类型。"standard"：标准版，"profession"：专业版。 (标准版仅国际站支持，国内站目前支持专业版)</p>
*/
SpecificationsType?: string;
/**
* <p>专业版实例磁盘类型，标准版实例不需要填写。"CLOUD_SSD"：SSD云硬盘；"CLOUD_BASIC"：高性能云硬盘。不传默认值为 "CLOUD_BASIC"</p>
*/
DiskType?: string;
/**
* <p>实例内网峰值带宽，默认值为40。单位 MB/s。标准版需传入当前实例规格所对应的峰值带宽。注意如果创建的实例为专业版实例，峰值带宽，分区数等参数配置需要满足专业版的计费规格，可以通过以下链接查看计费规格：https://cloud.tencent.com/document/product/597/11745</p>
*/
BandWidth?: number;
/**
* <p>实例硬盘大小，默认取值为500，步长设置为100。需要满足当前实例的计费规格，可以通过以下链接查看计费规格：https://cloud.tencent.com/document/product/597/122562</p>
*/
DiskSize?: number;
/**
* <p>实例最大分区数量，需要满足当前实例的计费规格。默认值为800，步长为100。可以通过以下链接查看计费规格：https://cloud.tencent.com/document/product/597/122563</p>
*/
Partition?: number;
/**
* <p>实例最大 topic 数量，需要满足当前实例的计费规格。默认值为800，步长设置为100。</p>
*/
TopicNum?: number;
/**
* <p>实例所在的可用区。当创建多可用区实例时，该参数为创建的默认接入点所在子网的可用区 id。ZoneId、ZoneIds不能同时为空，可通过<a href="https://cloud.tencent.com/document/product/597/55246">DescribeCkafkaZone</a>接口获取。</p>
*/
ZoneId?: number;
/**
* <p>当前实例是否为多可用区实例。</p>
*/
MultiZoneFlag?: boolean;
/**
* <p>当实例为多可用区实例时，多可用区 id 列表。注意参数 ZoneId 对应的多可用区需要包含在该参数数组中。ZoneId、ZoneIds不能同时为空，可通过<a href="https://cloud.tencent.com/document/product/597/55246">DescribeCkafkaZone</a>接口获取。</p>
*/
ZoneIds?: Array<number | bigint>;
/**
* <p>购买实例数量。非必填，默认值为 1。当传入该参数时，会创建多个 instanceName 加后缀区分的实例</p>
*/
InstanceNum?: number;
/**
* <p>公网带宽大小，单位 Mbps。</p><p>单位：Mbps</p>
*/
PublicNetworkMonthly?: number;
/**
* <p>标签</p>
*/
Tags?: Array<Tag>;
/**
* <p>弹性带宽开关 0不开启 1开启（0默认)</p>
*/
ElasticBandwidthSwitch?: number;
/**
* <p>自定义证书Id,仅当SpecificationsType为profession时生效,支持自定义证书能力</p><p>可通过<a href="https://cloud.tencent.com/document/product/400/41673">DescribeCertificateDetail</a>接口获取</p>
*/
CustomSSLCertId?: string;
/**
* <p>弹性存储开关</p><p>枚举值：</p><ul><li>0： 关闭</li><li>1： 开启</li></ul><p>默认值：0</p>
*/
StoreQuantityType?: number;
}
/**
* 修改实例属性的配置对象
*/
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 {
/**
* <p>返回值</p>
*/
Result?: RenewCkafkaInstanceResp;
/**
* 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* CreatePartition返回参数结构体
*/
export interface CreatePartitionResponse {
/**
* 返回的结果集
*/
Result?: JgwOperateResponse;
/**
* 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* MySQL类型入参
*/
export interface MySQLParam {
/**
* MySQL的数据库名称，"*"为全数据库
*/
Database: string;
/**
* MySQL的数据表名称，"*"为所监听的所有数据库中的非系统表，可以","间隔，监听多个数据表，但数据表需要以"数据库名.数据表名"的格式进行填写，需要填入正则表达式时，格式为"数据库名\\.数据表名"
*/
Table: string;
/**
* 该MySQL在连接管理内的Id
*/
Resource: string;
/**
* 复制存量信息(schema_only不复制, initial全量)，默认值initial
*/
SnapshotMode?: string;
/**
* 存放MySQL的Ddl信息的Topic，为空则默认不存放
*/
DdlTopic?: string;
/**
* "TABLE" 表示读取项为 table，"QUERY" 表示读取项为 query
*/
DataSourceMonitorMode?: string;
/**
* 当 "DataMonitorMode"="TABLE" 时，传入需要读取的 Table；当 "DataMonitorMode"="QUERY" 时，传入需要读取的查询 sql 语句
*/
DataSourceMonitorResource?: string;
/**
* "TIMESTAMP" 表示增量列为时间戳类型，"INCREMENT" 表示增量列为自增 id 类型
*/
DataSourceIncrementMode?: string;
/**
* 传入需要监听的列名称
*/
DataSourceIncrementColumn?: string;
/**
* "HEAD" 表示复制存量 + 增量数据，"TAIL" 表示只复制增量数据
*/
DataSourceStartFrom?: string;
/**
* "INSERT" 表示使用 Insert 模式插入，"UPSERT" 表示使用 Upsert 模式插入
*/
DataTargetInsertMode?: string;
/**
* 当 "DataInsertMode"="UPSERT" 时，传入当前 upsert 时依赖的主键
*/
DataTargetPrimaryKeyField?: string;
/**
* 表与消息间的映射关系
*/
DataTargetRecordMapping?: Array<RecordMapping>;
/**
* 事件路由到特定主题的正则表达式，默认为(.*)
*/
TopicRegex?: string;
/**
* TopicRegex的引用组，指定$1、$2等
*/
TopicReplacement?: string;
/**
* 格式：库1.表1:字段1,字段2;库2.表2:字段2，表之间;（分号）隔开，字段之间,（逗号）隔开。不指定的表默认取表的主键
*/
KeyColumns?: string;
/**
* Mysql 是否抛弃解析失败的消息，默认为true
*/
DropInvalidMessage?: boolean;
/**
* 当设置成员参数DropInvalidMessageToCls设置为true时,DropInvalidMessage参数失效
*/
DropCls?: DropCls;
/**
* 输出格式，DEFAULT、CANAL_1、CANAL_2
*/
OutputFormat?: string;
/**
* 当Table输入的是前缀时，该项值为true，否则为false
*/
IsTablePrefix?: boolean;
/**
* 如果该值为all，则DDL数据以及DML数据也会写入到选中的topic；若该值为dml，则只有DML数据写入到选中的topic
*/
IncludeContentChanges?: string;
/**
* 如果该值为true，且MySQL中"binlog_rows_query_log_events"配置项的值为"ON"，则流入到topic的数据包含原SQL语句；若该值为false，流入到topic的数据不包含原SQL语句
*/
IncludeQuery?: boolean;
/**
* 如果该值为 true，则消息中会携带消息结构体对应的schema，如果该值为false则不会携带
*/
RecordWithSchema?: boolean;
/**
* 存放信令表的数据库名称
*/
SignalDatabase?: string;
/**
* 输入的table是否为正则表达式，如果该选项以及IsTablePrefix同时为true，该选项的判断优先级高于IsTablePrefix
*/
IsTableRegular?: boolean;
/**
* 信号表
注意：此字段可能返回 null，表示取不到有效值。
*/
SignalTable?: string;
/**
* datetime 类型字段转换为时间戳的时区
*/
DateTimeZone?: string;
/**
* 是否为自建集群
*/
SelfBuilt?: boolean;
}
/**
* partition信息
*/
export interface Partitions {
/**
* 分区
*/
Partition: number;
/**
* partition 消费位移
*/
Offset: number;
}
/**
* DescribeTopic返回参数结构体
*/
export interface DescribeTopicResponse {
/**
* <p>返回的结果</p>
*/
Result?: TopicResult;
/**
* 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 消费组返回结果实体
*/
export interface ConsumerGroupResponse {
/**
* 符合条件的消费组数量
*/
TotalCount?: number;
/**
* 主题列表
*/
TopicList?: Array<ConsumerGroupTopic>;
/**
* 消费分组List
*/
GroupList?: Array<ConsumerGroup>;
/**
* 所有分区数量
*/
TotalPartition?: number;
/**
* 监控的分区列表
*/
PartitionListForMonitor?: Array<Partition>;
/**
* 主题总数
*/
TotalTopic?: number;
/**
* 监控的主题列表
*/
TopicListForMonitor?: Array<ConsumerGroupTopic>;
/**
* 监控的组列表
*/
GroupListForMonitor?: Array<Group>;
}
/**
* CreateTopicIpWhiteList返回参数结构体
*/
export interface CreateTopicIpWhiteListResponse {
/**
* 删除主题IP白名单结果
*/
Result?: JgwOperateResponse;
/**
* 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 数据处理规则失败处理
*/
export interface FailureParam {
/**
* 类型，DLQ死信队列，IGNORE_ERROR保留，DROP丢弃
*/
Type: string;
/**
* Ckafka类型死信队列
*/
KafkaParam?: KafkaParam;
/**
* 重试间隔
*/
RetryInterval?: number;
/**
* 重试次数
*/
MaxRetryAttempts?: number;
/**
* DIP Topic类型死信队列
*/
TopicParam?: TopicParam;
/**
* 死信队列类型，CKAFKA，TOPIC
*/
DlqType?: string;
}
/**
* CreateTopic请求参数结构体
*/
export interface CreateTopicRequest {
/**
* <p>实例Id</p><p>取值参考：<a href="https://cloud.tencent.com/document/api/597/40835">DescribeInstances</a></p>
*/
InstanceId: string;
/**
* <p>只能包含字母、数字、下划线、“-”、“.”</p>
*/
TopicName: string;
/**
* <p>Partition个数，大于0</p>
*/
PartitionNum: number;
/**
* <p>副本个数，不能多于 broker 数，最大为3</p>
*/
ReplicaNum: number;
/**
* <p>ip白名单开关, 1:打开 0:关闭，默认不打开</p>
*/
EnableWhiteList?: number;
/**
* <p>Ip白名单列表，配额限制，enableWhileList=1时必选</p>
*/
IpWhiteList?: Array<string>;
/**
* <p>清理日志策略，日志清理模式，默认为"delete"。"delete"：日志按保存时间删除，"compact"：日志按 key 压缩，"compact, delete"：日志按 key 压缩且会按保存时间删除。</p>
*/
CleanUpPolicy?: string;
/**
* <p>主题备注</p><p>入参限制：不超过 64 个字符</p>
*/
Note?: string;
/**
* <p>最小同步副本数</p><p>默认值：1</p><p>最小值为1</p>
*/
MinInsyncReplicas?: number;
/**
* <p>是否允许未同步的副本选为leader，0:不允许，1:允许，默认取实例维度的值</p>
*/
UncleanLeaderElectionEnable?: number;
/**
* <p>可选参数，消息保留时间</p><p>取值范围：[60000, 7776000000]</p><p>单位：毫秒</p><p>默认值：7200000</p>
*/
RetentionMs?: number;
/**
* <p>Segment分片滚动的时长</p><p>单位：毫秒</p><p>默认值：86400000</p><p>最小值为86400000ms（1天）</p>
*/
SegmentMs?: number;
/**
* <p>主题消息最大值，单位为 Byte，最小值1024Bytes(即1KB)，最大值为12582912Bytes（即12MB）</p>
*/
MaxMessageBytes?: number;
/**
* <p>预设ACL规则, 1:打开 0:关闭，默认不打开</p>
*/
EnableAclRule?: number;
/**
* <p>预设ACL规则的名称</p>
*/
AclRuleName?: string;
/**
* <p>可选, 保留文件大小. 默认为-1,单位Byte, 当前最小值为1073741824。</p><p>取值范围：[1073741824, 1099511627776]</p><p>单位：字节</p><p>特殊值：-1表示无限制</p>
*/
RetentionBytes?: number;
/**
* <p>标签列表</p>
*/
Tags?: Array<Tag>;
/**
* <p>消息保存的时间类型:CreateTime/LogAppendTime</p>
*/
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?: Array<InstanceDetail>;
}
/**
* DescribeDatahubGroupOffsets返回参数结构体
*/
export interface DescribeDatahubGroupOffsetsResponse {
/**
* 返回的结果对象
*/
Result?: GroupOffsetResponse;
/**
* 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 公网带宽参数
*/
export interface InquiryPublicNetworkParam {
/**
* 公网计费模式: BANDWIDTH_PREPAID(包年包月), BANDWIDTH_POSTPAID_BY_HOUR(带宽按小时计费)
*/
PublicNetworkChargeType?: string;
/**
* 公网带宽, 单位MB 取值需是0，或是3的倍数
*/
PublicNetworkMonthly?: number;
}
/**
* DeleteConnectResource返回参数结构体
*/
export interface DeleteConnectResourceResponse {
/**
* <p>连接源的Id</p>
*/
Result?: ConnectResourceResourceIdResp;
/**
* 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* RestartDatahubTask返回参数结构体
*/
export interface RestartDatahubTaskResponse {
/**
* <p>任务id</p>
注意：此字段可能返回 null，表示取不到有效值。
*/
Result?: DatahubTaskIdRes;
/**
* 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* CreateMetaAndDataSyncDatahubTask请求参数结构体
*/
export interface CreateMetaAndDataSyncDatahubTaskRequest {
/**
* <p>任务名称</p><p>64字符内</p>
*/
TaskName: string;
/**
* <p>同步源连接</p><p>参数格式：resource-test</p>
*/
SourceResourceId: string;
/**
* <p>同步目标连接</p><p>参数格式：resource-test</p>
*/
TargetResourceId: string;
/**
* <p>标签列表</p>
*/
Tags?: Array<Tag>;
/**
* <p>Offset类型，最开始位置earliest，最新位置latest，时间点位置timestamp</p><p>枚举值：</p><ul><li>earliest： 最开始位置</li><li>latest： 最新位置</li><li>timestamp： 时间点位置</li></ul>
*/
OffsetType?: string;
/**
* <p>正则匹配Topic列表</p><p>与TopicList参数二选一</p>
*/
TopicRegularExpression?: string;
/**
* <p>多选topic列表</p><p>与TopicRegularExpression参数二选一</p>
*/
TopicList?: Array<string>;
/**
* <p>Topic 前缀</p>
*/
Prefix?: string;
/**
* <p>Topic前缀分隔符</p><p>仅支持 "." / "-" / "_"</p>
*/
Separator?: string;
/**
* <p>连接器任务描述</p><p>128字符内</p>
*/
Description?: string;
}
/**
* 批量发送消息内容
*/
export interface BatchContent {
/**
* 发送的消息体
*/
Body: string;
/**
* 发送消息的键名
*/
Key?: string;
}
/**
* Scf类型入参
*/
export interface ScfParam {
/**
* SCF云函数函数名
*/
FunctionName: string;
/**
* SCF云函数命名空间, 默认为default
*/
Namespace?: string;
/**
* SCF云函数版本及别名, 默认为$DEFAULT
*/
Qualifier?: string;
/**
* 每批最大发送消息数, 默认为1000
*/
BatchSize?: number;
/**
* SCF调用失败后重试次数, 默认为5
*/
MaxRetries?: number;
}
/**
* DescribeTopic请求参数结构体
*/
export interface DescribeTopicRequest {
/**
* <p>ckafka集群实例Id</p><p>取值参考：<a href="https://cloud.tencent.com/document/api/597/40835">DescribeInstances</a></p>
*/
InstanceId: string;
/**
* <p>过滤条件，按照 topicName 过滤，支持模糊查询</p>
*/
SearchWord?: string;
/**
* <p>偏移量，不填默认为0</p>
*/
Offset?: number;
/**
* <p>返回数量，不填则默认为20，最大值为50</p>
*/
Limit?: number;
/**
* <p>Acl预设策略名称</p>
*/
AclRuleName?: string;
}
/**
* IsolatedInstancePre请求参数结构体
*/
export interface IsolatedInstancePreRequest {
/**
* ckafka集群实例Id
*/
InstanceId: 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 {
/**
* <p>ckafka集群实例Id</p><p>取值参考：<a href="https://cloud.tencent.com/document/api/597/40835">DescribeInstances</a></p>
*/
InstanceId: string;
/**
* <p>ACL规则名</p>
*/
RuleName: string;
/**
* <p>修改预设规则时传入,是否应用到新增的Topic</p><p>枚举值：</p><ul><li>0： 不允许应用到新增的topic</li><li>1： 允许应用到新增的topic</li></ul><p>默认值：0</p>
*/
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<TopicDetail>;
/**
* 符合条件的所有主题详情数量
*/
TotalCount?: number;
}
/**
* MariaDB连接源参数
*/
export interface MariaDBModifyConnectParam {
/**
* MariaDB连接源的实例资源【不支持修改】
*/
Resource: string;
/**
* MariaDB的连接port【不支持修改】
*/
Port?: number;
/**
* MariaDB连接源的实例vip【不支持修改】
*/
ServiceVip?: string;
/**
* MariaDB连接源的vpcId【不支持修改】
*/
UniqVpcId?: string;
/**
* MariaDB连接源的用户名
*/
UserName?: string;
/**
* MariaDB连接源的密码
*/
Password?: string;
/**
* 是否更新到关联的Datahub任务
*/
IsUpdate?: boolean;
}
/**
* DescribeRegion返回参数结构体
*/
export interface DescribeRegionResponse {
/**
* <p>返回地域枚举结果列表</p>
*/
Result?: Array<Region>;
/**
* 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* CreateTopic返回参数结构体
*/
export interface CreateTopicResponse {
/**
* <p>返回创建结果</p>
*/
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 {
/**
* <p>任务Id</p>
*/
TaskId?: string;
/**
* <p>任务名称</p>
*/
TaskName?: string;
/**
* <p>任务类型，SOURCE数据接入，SINK数据流出</p>
*/
TaskType?: string;
/**
* <p>状态，-1创建失败，0创建中，1运行中，2删除中，3已删除，4删除失败，5暂停中，6已暂停，7暂停失败，8恢复中，9恢复失败</p>
*/
Status?: number;
/**
* <p>数据源</p>
*/
SourceResource?: DatahubResource;
/**
* <p>数据目标</p>
*/
TargetResource?: DatahubResource;
/**
* <p>任务创建时间</p>
*/
CreateTime?: string;
/**
* <p>异常信息</p>
*/
ErrorMessage?: string;
/**
* <p>创建进度百分比</p>
*/
TaskProgress?: number;
/**
* <p>任务当前处于的步骤</p>
*/
TaskCurrentStep?: string;
/**
* <p>Datahub转储Id</p>
*/
DatahubId?: string;
/**
* <p>步骤列表</p>
*/
StepList?: Array<string>;
/**
* <p>任务描述信息</p>
*/
Description?: string;
/**
* <p>任务并发数</p><p>默认值：1</p>
*/
TaskMax?: number;
/**
* <p>任务同步限流值,单位MB/s</p><p>默认值：20MB/s</p>
*/
SyncThrottleLimit?: number;
/**
* <p>任务是否自动扩容标识</p><p>枚举值：</p><ul><li>true： 自动扩容</li><li>false： 手动扩容</li></ul><p>默认值：true</p>
*/
AutoExpandFlag?: boolean;
}
/**
* UpgradeBrokerVersion返回参数结构体
*/
export interface UpgradeBrokerVersionResponse {
/**
* <p>升配结果</p>
*/
Result?: JgwOperateResponse;
/**
* 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeConsumerGroup返回参数结构体
*/
export interface DescribeConsumerGroupResponse {
/**
* 返回的消费分组信息
*/
Result?: ConsumerGroupResponse;
/**
* 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 创建后付费接口返回的 Data 数据结构
*/
export interface CreateInstancePostData {
/**
* <p>CreateInstancePre返回固定为0，不能作为CheckTaskStatus的查询条件。只是为了保证和后台数据结构对齐。</p>
*/
FlowId?: number;
/**
* <p>订单号列表</p>
*/
DealNames?: Array<string>;
/**
* <p>ckafka集群实例Id，当购买多个实例时，默认返回购买的第一个实例 id</p>
*/
InstanceId?: string;
/**
* <p>订单和购买实例对应映射列表</p>
*/
DealNameInstanceIdMapping?: Array<DealInstanceDTO>;
/**
* <p>CAM鉴权返回的eventId</p>
*/
EventId?: string;
}
/**
* 变配类型查询出参
*/
export interface DescModifyType {
/**
* 变配类型
*/
ModifyType?: number;
/**
* 是否迁移标志
*/
MigrateFlag?: boolean;
}
/**
* 实例公网路由IP白名单返回结果对象
*/
export interface ExternalAccessInfoWrapper {
/**
* <p>IP白名单放通规则数</p>
*/
TotalCount?: number;
/**
* <p>IP白名单</p>
*/
IpWhitelist?: Array<IpWhitelistDTO>;
}
/**
* 实例属性返回结果对象
*/
export interface InstanceAttributesResponse {
/**
* <p>ckafka集群实例Id</p>
*/
InstanceId?: string;
/**
* <p>ckafka集群实例Name</p>
*/
InstanceName?: string;
/**
* <p>接入点 VIP 列表信息</p>
*/
VipList?: Array<VipEntity>;
/**
* <p>虚拟IP</p>
*/
Vip?: string;
/**
* <p>虚拟端口</p>
*/
Vport?: string;
/**
* <p>实例的状态。0: 创建中，1: 运行中，2: 删除中, 3: 已删除, 5: 隔离中, 7: 升级中, -1: 创建失败</p>
*/
Status?: number;
/**
* <p>实例带宽，单位：Mbps</p>
*/
Bandwidth?: number;
/**
* <p>实例的存储大小，单位：GB</p>
*/
DiskSize?: number;
/**
* <p>可用区</p>
*/
ZoneId?: number;
/**
* <p>VPC 的 ID，为空表示是基础网络</p>
*/
VpcId?: string;
/**
* <p>子网 ID， 为空表示基础网络</p>
*/
SubnetId?: string;
/**
* <p>实例健康状态， 1：健康，2：告警，3：异常</p>
*/
Healthy?: number;
/**
* <p>实例健康信息，当前会展示磁盘利用率，最大长度为256</p>
*/
HealthyMessage?: string;
/**
* <p>创建时间</p>
*/
CreateTime?: number;
/**
* <p>消息保存时间,单位为分钟</p>
*/
MsgRetentionTime?: number;
/**
* <p>自动创建 Topic 配置， 若该字段为空，则表示未开启自动创建</p>
*/
Config?: InstanceConfigDO;
/**
* <p>剩余创建分区数</p>
*/
RemainderPartitions?: number;
/**
* <p>剩余创建主题数</p>
*/
RemainderTopics?: number;
/**
* <p>当前创建分区数</p>
*/
CreatedPartitions?: number;
/**
* <p>当前创建主题数</p>
*/
CreatedTopics?: number;
/**
* <p>标签数组</p>
*/
Tags?: Array<Tag>;
/**
* <p>过期时间</p>
*/
ExpireTime?: number;
/**
* <p>可用区列表</p>
*/
ZoneIds?: Array<number | bigint>;
/**
* <p>ckafka集群实例版本</p>
*/
Version?: string;
/**
* <p>最大分组数</p>
*/
MaxGroupNum?: number;
/**
* <p>售卖类型,0:标准版,1:专业版</p>
*/
Cvm?: number;
/**
* <p>实例类型</p><p>枚举值：</p><ul><li>profession： 专业版</li><li>premium： 高级版</li><li>serverless： serverless版</li><li>其他： 标准版（如:standards2/standard，该版本已停售）</li></ul>
*/
InstanceType?: string;
/**
* <p>表示该实例支持的特性。FEATURE_SUBNET_ACL:表示acl策略支持设置子网。</p>
*/
Features?: Array<string>;
/**
* <p>动态消息保留策略</p>
*/
RetentionTimeConfig?: DynamicRetentionTime;
/**
* <p>最大连接数</p>
*/
MaxConnection?: number;
/**
* <p>公网带宽</p>
*/
PublicNetwork?: number;
/**
* <p>该字段已废弃,无实际含义</p>
*/
DeleteRouteTimestamp?: string;
/**
* <p>剩余创建分区数</p>
*/
RemainingPartitions?: number;
/**
* <p>剩余创建主题数</p>
*/
RemainingTopics?: number;
/**
* <p>动态硬盘扩容策略</p>
*/
DynamicDiskConfig?: DynamicDiskConfig;
/**
* <p>系统维护时间</p>
*/
SystemMaintenanceTime?: string;
/**
* <p>实例级别消息最大大小</p>
*/
MaxMessageByte?: number;
/**
* <p>实例计费类型 POSTPAID_BY_HOUR 按小时付费; PREPAID 包年包月</p>
*/
InstanceChargeType?: string;
/**
* <p>是否开启弹性带宽白名单<br>1:已开启弹性带宽白名单;<br>0:未开启弹性带宽白名单;</p>
*/
ElasticBandwidthSwitch?: number;
/**
* <p>弹性带宽开通状态<br>1:未开启弹性带宽;<br>16: 开启弹性带宽中;<br>32:开启弹性带宽成功;<br>33:关闭弹性带宽中;<br>34:关闭弹性带宽成功;<br>64:开启弹性带宽失败;<br>65:关闭弹性带宽失败;</p>
*/
ElasticBandwidthOpenStatus?: number;
/**
* <p>集群类型<br>CLOUD_IDC IDC集群<br>CLOUD_CVM_SHARE CVM共享集群<br>CLOUD_CVM_YUNTI 云梯CVM集群<br>CLOUD_CVM CVM集群<br>CLOUD_CDC CDC集群<br>CLOUD_EKS_TSE EKS集群</p>
*/
ClusterType?: string;
/**
* <p>免费分区数量</p>
*/
FreePartitionNumber?: number;
/**
* <p>弹性带宽上浮值</p>
*/
ElasticFloatBandwidth?: number;
/**
* <p>ssl自定义证书id 仅自定义证书实例集群返回</p>
*/
CustomCertId?: string;
/**
* <p>集群topic默认 unclean.leader.election.enable配置: 1 开启 0 关闭</p>
*/
UncleanLeaderElectionEnable?: number;
/**
* <p>实例删除保护开关: 1 开启 0 关闭</p>
*/
DeleteProtectionEnable?: number;
/**
* <p>实例级别消息保留大小</p><p>单位：bytes</p><p>默认值：-1</p>
*/
RetentionBytes?: number;
/**
* <p>事务ID最大空闲时间，超时未提交的事务将被标记为过期</p><p>单位：ms</p>
*/
TransactionalIdExpirationMs?: number;
}
/**
* DescribeDatahubTopics返回参数结构体
*/
export interface DescribeDatahubTopicsResponse {
/**
* <p>主题列表</p>
*/
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 {
/**
* <p>是否为自建集群</p>
*/
SelfBuilt: boolean;
/**
* <p>ckafka集群实例Id</p>
*/
Resource: string;
/**
* <p>主题名，多个以“,”分隔</p>
*/
Topic?: string;
/**
* <p>Offset类型，最开始位置earliest，最新位置latest，时间点位置timestamp</p>
注意：此字段可能返回 null，表示取不到有效值。
*/
OffsetType?: string;
/**
* <p>Offset类型为timestamp时必传，传时间戳，精确到秒</p>
注意：此字段可能返回 null，表示取不到有效值。
*/
StartTime?: number;
/**
* <p>实例资源名称</p>
注意：此字段可能返回 null，表示取不到有效值。
*/
ResourceName?: string;
/**
* <p>可用区</p>
注意：此字段可能返回 null，表示取不到有效值。
*/
ZoneId?: number;
/**
* <p>主题Id</p>
注意：此字段可能返回 null，表示取不到有效值。
*/
TopicId?: string;
/**
* <p>Topic的分区数</p>
注意：此字段可能返回 null，表示取不到有效值。
*/
PartitionNum?: number;
/**
* <p>启用容错实例/开启死信队列</p>
注意：此字段可能返回 null，表示取不到有效值。
*/
EnableToleration?: boolean;
/**
* <p>Qps 限制</p>
*/
QpsLimit?: number;
/**
* <p>Table到Topic的路由，「分发到多个topic」开关打开时必传</p>
注意：此字段可能返回 null，表示取不到有效值。
*/
TableMappings?: Array<TableMapping>;
/**
* <p>「分发到多个topic」开关，默认为false</p>
*/
UseTableMapping?: boolean;
/**
* <p>使用的Topic是否需要自动创建（目前只支持SOURCE流入任务，如果不使用分发到多个topic，需要在Topic字段填写需要自动创建的topic名）</p>
*/
UseAutoCreateTopic?: boolean;
/**
* <p>写入Topic时是否进行压缩，不开启填"none"，开启的话，填写"open"。</p>
*/
CompressionType?: string;
/**
* <p>源topic消息1条扩增成msgMultiple条写入目标topic(该参数目前只有ckafka流入ckafka适用)</p>
*/
MsgMultiple?: number;
/**
* <p>数据同步专用参数, 正常数据处理可为空, 实例级别同步: 仅同步元数据填写"META_SYNC_INSTANCE_TYPE", 同步元数据及全部topic内消息的填写"META_AND_DATA_SYNC_INSTANCE_TYPE"; topic级别同步: 选中的源和目标topic中的消息(需要目标实例也包含该topic)填写"DATA_SYNC_TYPE"</p>
*/
ConnectorSyncType?: string;
/**
* <p>数据同步专用参数, 当通过时,希望下游的消息写入分区与上游的一致,则填true,但下游分区小于上游时,会报错; 不需要一致则为false, 默认为false</p>
*/
KeepPartition?: boolean;
/**
* <p>正则匹配Topic列表</p>
*/
TopicRegularExpression?: string;
/**
* <p>Topic 前缀</p>
*/
Prefix?: string;
/**
* <p>Topic前缀分隔符</p>
*/
Separator?: string;
/**
* <p>多选topic列表</p>
*/
TopicList?: Array<string>;
}
/**
* Connection信息
*/
export interface Connection {
/**
* 主题名
*/
TopicName?: string;
/**
* 消费组ID
*/
GroupId?: string;
/**
* 主题Id
*/
TopicId?: string;
}
/**
* BatchCreateAcl返回参数结构体
*/
export interface BatchCreateAclResponse {
/**
* 状态码：0-修改成功，否则修改失败
*/
Result?: number;
/**
* 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* ModifyAccessPolicy返回参数结构体
*/
export interface ModifyAccessPolicyResponse {
/**
* <p>修改公网IP白名单结果</p>
*/
Result?: string;
/**
* 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 实例公网路由IP白名单列表对象
*/
export interface IpWhitelistDTO {
/**
* <p>放通IP或网段</p>
*/
CidrBlock?: string;
/**
* <p>描述</p>
*/
PolicyDescription?: string;
}
/**
* DeleteRoute请求参数结构体
*/
export interface DeleteRouteRequest {
/**
* ckafka集群实例Id,可通过[DescribeInstances](https://cloud.tencent.com/document/product/597/40835)接口获取
*/
InstanceId: string;
/**
* 路由id,可通过[DescribeRoute](https://cloud.tencent.com/document/product/597/45484)接口获取
*/
RouteId: number;
/**
* 调用方appId
*/
CallerAppid?: number;
/**
* 设置定时删除路由时间,仅类型为公网路由支持定时删除,可选择未来的24小时的任意时间
*/
DeleteRouteTime?: string;
}
/**
* MongoDB连接源参数
*/
export interface MongoDBConnectParam {
/**
* MongoDB的连接port
*/
Port: number;
/**
* MongoDB连接源的用户名
*/
UserName: string;
/**
* MongoDB连接源的密码
*/
Password: string;
/**
* MongoDB连接源的实例资源
*/
Resource: string;
/**
* MongoDB连接源是否为自建集群
*/
SelfBuilt: boolean;
/**
* MongoDB连接源的实例vip，当为腾讯云实例时，必填
*/
ServiceVip?: string;