tencentcloud-sdk-nodejs 4.0.853 → 4.0.854

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (33) hide show
  1. package/CHANGELOG.md +97 -0
  2. package/SERVICE_CHANGELOG.md +145 -13
  3. package/package.json +1 -1
  4. package/products.md +11 -11
  5. package/src/common/sdk_version.ts +1 -1
  6. package/src/services/ckafka/v20190819/ckafka_client.ts +2 -0
  7. package/src/services/ckafka/v20190819/ckafka_models.ts +260 -40
  8. package/src/services/cls/v20201016/cls_models.ts +1 -1
  9. package/src/services/csip/v20221121/csip_client.ts +13 -0
  10. package/src/services/csip/v20221121/csip_models.ts +80 -0
  11. package/src/services/cwp/v20180228/cwp_models.ts +6 -4
  12. package/src/services/dnspod/v20210323/dnspod_models.ts +1 -1
  13. package/src/services/ess/v20201111/ess_models.ts +4 -0
  14. package/src/services/essbasic/v20210526/essbasic_client.ts +1 -1
  15. package/src/services/tcss/v20201101/tcss_client.ts +19 -6
  16. package/src/services/tcss/v20201101/tcss_models.ts +109 -0
  17. package/tencentcloud/common/sdk_version.d.ts +1 -1
  18. package/tencentcloud/common/sdk_version.js +1 -1
  19. package/tencentcloud/services/ckafka/v20190819/ckafka_models.d.ts +258 -40
  20. package/tencentcloud/services/cls/v20201016/cls_models.d.ts +1 -1
  21. package/tencentcloud/services/csip/v20221121/csip_client.d.ts +5 -1
  22. package/tencentcloud/services/csip/v20221121/csip_client.js +6 -0
  23. package/tencentcloud/services/csip/v20221121/csip_models.d.ts +77 -0
  24. package/tencentcloud/services/cwp/v20180228/cwp_models.d.ts +6 -4
  25. package/tencentcloud/services/dnspod/v20210323/dnspod_models.d.ts +1 -1
  26. package/tencentcloud/services/ess/v20201111/ess_models.d.ts +4 -0
  27. package/tencentcloud/services/essbasic/v20210526/essbasic_client.d.ts +1 -1
  28. package/tencentcloud/services/essbasic/v20210526/essbasic_client.js +1 -1
  29. package/tencentcloud/services/tcss/v20201101/tcss_client.d.ts +7 -3
  30. package/tencentcloud/services/tcss/v20201101/tcss_client.js +9 -3
  31. package/tencentcloud/services/tcss/v20201101/tcss_models.d.ts +106 -0
  32. package/test/csip.v20221121.test.js +10 -0
  33. package/test/tcss.v20201101.test.js +12 -2
@@ -563,102 +563,107 @@ export interface DescribeConnectResourceResp {
563
563
  * 连接源的Id
564
564
  注意:此字段可能返回 null,表示取不到有效值。
565
565
  */
566
- ResourceId: string;
566
+ ResourceId?: string;
567
567
  /**
568
568
  * 连接源名称
569
569
  注意:此字段可能返回 null,表示取不到有效值。
570
570
  */
571
- ResourceName: string;
571
+ ResourceName?: string;
572
572
  /**
573
573
  * 连接源描述
574
574
  注意:此字段可能返回 null,表示取不到有效值。
575
575
  */
576
- Description: string;
576
+ Description?: string;
577
577
  /**
578
578
  * 连接源类型
579
579
  注意:此字段可能返回 null,表示取不到有效值。
580
580
  */
581
- Type: string;
581
+ Type?: string;
582
582
  /**
583
583
  * 连接源的状态
584
584
  注意:此字段可能返回 null,表示取不到有效值。
585
585
  */
586
- Status: number;
586
+ Status?: number;
587
587
  /**
588
588
  * 连接源的创建时间
589
589
  注意:此字段可能返回 null,表示取不到有效值。
590
590
  */
591
- CreateTime: string;
591
+ CreateTime?: string;
592
592
  /**
593
593
  * 连接源的异常信息
594
594
  注意:此字段可能返回 null,表示取不到有效值。
595
595
  */
596
- ErrorMessage: string;
596
+ ErrorMessage?: string;
597
597
  /**
598
598
  * 连接源的当前所处步骤
599
599
  注意:此字段可能返回 null,表示取不到有效值。
600
600
  */
601
- CurrentStep: string;
601
+ CurrentStep?: string;
602
602
  /**
603
603
  * 步骤列表
604
604
  注意:此字段可能返回 null,表示取不到有效值。
605
605
  */
606
- StepList: Array<string>;
606
+ StepList?: Array<string>;
607
607
  /**
608
608
  * MySQL配置,Type为MYSQL或TDSQL_C_MYSQL时返回
609
609
  注意:此字段可能返回 null,表示取不到有效值。
610
610
  */
611
- MySQLConnectParam: MySQLConnectParam;
611
+ MySQLConnectParam?: MySQLConnectParam;
612
612
  /**
613
613
  * PostgreSQL配置,Type为POSTGRESQL或TDSQL_C_POSTGRESQL时返回
614
614
  注意:此字段可能返回 null,表示取不到有效值。
615
615
  */
616
- PostgreSQLConnectParam: PostgreSQLConnectParam;
616
+ PostgreSQLConnectParam?: PostgreSQLConnectParam;
617
617
  /**
618
618
  * Dts配置,Type为DTS时返回
619
619
  注意:此字段可能返回 null,表示取不到有效值。
620
620
  */
621
- DtsConnectParam: DtsConnectParam;
621
+ DtsConnectParam?: DtsConnectParam;
622
622
  /**
623
623
  * MongoDB配置,Type为MONGODB时返回
624
624
  注意:此字段可能返回 null,表示取不到有效值。
625
625
  */
626
- MongoDBConnectParam: MongoDBConnectParam;
626
+ MongoDBConnectParam?: MongoDBConnectParam;
627
627
  /**
628
628
  * Es配置,Type为ES时返回
629
629
  注意:此字段可能返回 null,表示取不到有效值。
630
630
  */
631
- EsConnectParam: EsConnectParam;
631
+ EsConnectParam?: EsConnectParam;
632
632
  /**
633
633
  * ClickHouse配置,Type为CLICKHOUSE时返回
634
634
  注意:此字段可能返回 null,表示取不到有效值。
635
635
  */
636
- ClickHouseConnectParam: ClickHouseConnectParam;
636
+ ClickHouseConnectParam?: ClickHouseConnectParam;
637
637
  /**
638
638
  * MariaDB配置,Type为MARIADB时返回
639
639
  注意:此字段可能返回 null,表示取不到有效值。
640
640
  */
641
- MariaDBConnectParam: MariaDBConnectParam;
641
+ MariaDBConnectParam?: MariaDBConnectParam;
642
642
  /**
643
643
  * SQLServer配置,Type为SQLSERVER时返回
644
644
  注意:此字段可能返回 null,表示取不到有效值。
645
645
  */
646
- SQLServerConnectParam: SQLServerConnectParam;
646
+ SQLServerConnectParam?: SQLServerConnectParam;
647
647
  /**
648
648
  * Ctsdb配置,Type为CTSDB时返回
649
649
  注意:此字段可能返回 null,表示取不到有效值。
650
650
  */
651
- CtsdbConnectParam: CtsdbConnectParam;
651
+ CtsdbConnectParam?: CtsdbConnectParam;
652
652
  /**
653
653
  * Doris 配置,Type 为 DORIS 时返回
654
654
  注意:此字段可能返回 null,表示取不到有效值。
655
655
  */
656
- DorisConnectParam: DorisConnectParam;
656
+ DorisConnectParam?: DorisConnectParam;
657
657
  /**
658
658
  * Kafka配置,Type 为 KAFKA 时返回
659
659
  注意:此字段可能返回 null,表示取不到有效值。
660
660
  */
661
661
  KafkaConnectParam?: KafkaConnectParam;
662
+ /**
663
+ * MQTT配置,Type 为 MQTT 时返回
664
+ 注意:此字段可能返回 null,表示取不到有效值。
665
+ */
666
+ MqttConnectParam?: MqttConnectParam;
662
667
  }
663
668
  /**
664
669
  * AuthorizeToken返回参数结构体
@@ -712,82 +717,102 @@ export interface FetchLatestDatahubMessageListResponse {
712
717
  export interface EsParam {
713
718
  /**
714
719
  * 实例资源
720
+ 注意:此字段可能返回 null,表示取不到有效值。
715
721
  */
716
722
  Resource: string;
717
723
  /**
718
724
  * Es的连接port
725
+ 注意:此字段可能返回 null,表示取不到有效值。
719
726
  */
720
727
  Port?: number;
721
728
  /**
722
729
  * Es用户名
730
+ 注意:此字段可能返回 null,表示取不到有效值。
723
731
  */
724
732
  UserName?: string;
725
733
  /**
726
734
  * Es密码
735
+ 注意:此字段可能返回 null,表示取不到有效值。
727
736
  */
728
737
  Password?: string;
729
738
  /**
730
739
  * 是否为自建集群
740
+ 注意:此字段可能返回 null,表示取不到有效值。
731
741
  */
732
742
  SelfBuilt?: boolean;
733
743
  /**
734
744
  * 实例vip
745
+ 注意:此字段可能返回 null,表示取不到有效值。
735
746
  */
736
747
  ServiceVip?: string;
737
748
  /**
738
749
  * 实例的vpcId
750
+ 注意:此字段可能返回 null,表示取不到有效值。
739
751
  */
740
752
  UniqVpcId?: string;
741
753
  /**
742
754
  * Es是否抛弃解析失败的消息
755
+ 注意:此字段可能返回 null,表示取不到有效值。
743
756
  */
744
757
  DropInvalidMessage?: boolean;
745
758
  /**
746
759
  * Es自定义index名称
760
+ 注意:此字段可能返回 null,表示取不到有效值。
747
761
  */
748
762
  Index?: string;
749
763
  /**
750
764
  * Es自定义日期后缀
765
+ 注意:此字段可能返回 null,表示取不到有效值。
751
766
  */
752
767
  DateFormat?: string;
753
768
  /**
754
769
  * 非json格式数据的自定义key
770
+ 注意:此字段可能返回 null,表示取不到有效值。
755
771
  */
756
772
  ContentKey?: string;
757
773
  /**
758
774
  * Es是否抛弃非json格式的消息
775
+ 注意:此字段可能返回 null,表示取不到有效值。
759
776
  */
760
777
  DropInvalidJsonMessage?: boolean;
761
778
  /**
762
779
  * 转储到Es中的文档ID取值字段名
780
+ 注意:此字段可能返回 null,表示取不到有效值。
763
781
  */
764
782
  DocumentIdField?: string;
765
783
  /**
766
784
  * Es自定义index名称的类型,STRING,JSONPATH,默认为STRING
785
+ 注意:此字段可能返回 null,表示取不到有效值。
767
786
  */
768
787
  IndexType?: string;
769
788
  /**
770
789
  * 当设置成员参数DropInvalidMessageToCls设置为true时,DropInvalidMessage参数失效
790
+ 注意:此字段可能返回 null,表示取不到有效值。
771
791
  */
772
792
  DropCls?: DropCls;
773
793
  /**
774
794
  * 转储到ES的消息为Database的binlog时,如果需要同步数据库操作,即增删改的操作到ES时填写数据库表主键
795
+ 注意:此字段可能返回 null,表示取不到有效值。
775
796
  */
776
797
  DatabasePrimaryKey?: string;
777
798
  /**
778
799
  * 死信队列
800
+ 注意:此字段可能返回 null,表示取不到有效值。
779
801
  */
780
802
  DropDlq?: FailureParam;
781
803
  /**
782
804
  * 使用数据订阅格式导入 es 时,消息与 es 索引字段映射关系。不填默认为默认字段匹配
805
+ 注意:此字段可能返回 null,表示取不到有效值。
783
806
  */
784
807
  RecordMappingList?: Array<EsRecordMapping>;
785
808
  /**
786
809
  * 消息要映射为 es 索引中 @timestamp 的字段,如果当前配置为空,则使用消息的时间戳进行映射
810
+ 注意:此字段可能返回 null,表示取不到有效值。
787
811
  */
788
812
  DateField?: string;
789
813
  /**
790
814
  * 用来区分当前索引映射,属于新建索引还是存量索引。"EXIST_MAPPING":从存量索引中选择;"NEW_MAPPING":新建索引
815
+ 注意:此字段可能返回 null,表示取不到有效值。
791
816
  */
792
817
  RecordMappingMode?: string;
793
818
  }
@@ -810,34 +835,42 @@ export interface DescribeAclRuleResponse {
810
835
  export interface DtsParam {
811
836
  /**
812
837
  * Dts实例Id
838
+ 注意:此字段可能返回 null,表示取不到有效值。
813
839
  */
814
840
  Resource: string;
815
841
  /**
816
842
  * Dts的连接ip
843
+ 注意:此字段可能返回 null,表示取不到有效值。
817
844
  */
818
845
  Ip?: string;
819
846
  /**
820
847
  * Dts的连接port
848
+ 注意:此字段可能返回 null,表示取不到有效值。
821
849
  */
822
850
  Port?: number;
823
851
  /**
824
852
  * Dts订阅的topic
853
+ 注意:此字段可能返回 null,表示取不到有效值。
825
854
  */
826
855
  Topic?: string;
827
856
  /**
828
857
  * Dts消费分组的Id
858
+ 注意:此字段可能返回 null,表示取不到有效值。
829
859
  */
830
860
  GroupId?: string;
831
861
  /**
832
862
  * Dts消费分组的账号
863
+ 注意:此字段可能返回 null,表示取不到有效值。
833
864
  */
834
865
  GroupUser?: string;
835
866
  /**
836
867
  * Dts消费分组的密码
868
+ 注意:此字段可能返回 null,表示取不到有效值。
837
869
  */
838
870
  GroupPassword?: string;
839
871
  /**
840
872
  * false同步原始数据,true同步解析后的json格式数据,默认true
873
+ 注意:此字段可能返回 null,表示取不到有效值。
841
874
  */
842
875
  TranSql?: boolean;
843
876
  }
@@ -1138,6 +1171,11 @@ export interface DatahubResource {
1138
1171
  注意:此字段可能返回 null,表示取不到有效值。
1139
1172
  */
1140
1173
  ScfParam?: ScfParam;
1174
+ /**
1175
+ * MQTT配置,Type为 MQTT 时必填
1176
+ 注意:此字段可能返回 null,表示取不到有效值。
1177
+ */
1178
+ MqttParam?: MqttParam;
1141
1179
  }
1142
1180
  /**
1143
1181
  * BatchModifyTopicAttributes返回参数结构体
@@ -1301,10 +1339,12 @@ export interface CreateInstancePreResp {
1301
1339
  export interface EsRecordMapping {
1302
1340
  /**
1303
1341
  * es 索引成员名称
1342
+ 注意:此字段可能返回 null,表示取不到有效值。
1304
1343
  */
1305
1344
  ColumnName?: string;
1306
1345
  /**
1307
1346
  * 消息字段名称
1347
+ 注意:此字段可能返回 null,表示取不到有效值。
1308
1348
  */
1309
1349
  JsonKey?: string;
1310
1350
  }
@@ -1985,6 +2025,71 @@ export interface DorisConnectParam {
1985
2025
  */
1986
2026
  BePort?: number;
1987
2027
  }
2028
+ /**
2029
+ * 创建MQTT 为Source的Data Hub Task参数
2030
+ */
2031
+ export interface MqttParam {
2032
+ /**
2033
+ * 需要同步的MQTT Topic列表, CSV格式
2034
+ 注意:此字段可能返回 null,表示取不到有效值。
2035
+ */
2036
+ Topics: string;
2037
+ /**
2038
+ * MQTT clean-session
2039
+ 注意:此字段可能返回 null,表示取不到有效值。
2040
+ */
2041
+ CleanSession: boolean;
2042
+ /**
2043
+ * MQTT instance-id
2044
+ 注意:此字段可能返回 null,表示取不到有效值。
2045
+ */
2046
+ Resource?: string;
2047
+ /**
2048
+ * MQTT实例VIP
2049
+ 注意:此字段可能返回 null,表示取不到有效值。
2050
+ */
2051
+ Ip?: string;
2052
+ /**
2053
+ * MQTT VIP 端口
2054
+ 注意:此字段可能返回 null,表示取不到有效值。
2055
+ */
2056
+ Port?: number;
2057
+ /**
2058
+ * MQTT实例用户名
2059
+ 注意:此字段可能返回 null,表示取不到有效值。
2060
+ */
2061
+ UserName?: string;
2062
+ /**
2063
+ * MQTT实例内账户密码
2064
+ 注意:此字段可能返回 null,表示取不到有效值。
2065
+ */
2066
+ Password?: string;
2067
+ /**
2068
+ * QoS
2069
+ 注意:此字段可能返回 null,表示取不到有效值。
2070
+ */
2071
+ Qos?: number;
2072
+ /**
2073
+ * tasks.max 订阅Topic的并发Task个数, 默认为1; 当设置大于1时, 使用Shared Subscription
2074
+ 注意:此字段可能返回 null,表示取不到有效值。
2075
+ */
2076
+ MaxTasks?: number;
2077
+ /**
2078
+ * MQTT 实例的Service VIP
2079
+ 注意:此字段可能返回 null,表示取不到有效值。
2080
+ */
2081
+ ServiceVip?: string;
2082
+ /**
2083
+ * MQTT实例的VPC ID
2084
+ 注意:此字段可能返回 null,表示取不到有效值。
2085
+ */
2086
+ UniqVpcId?: string;
2087
+ /**
2088
+ * 是否为自建集群, MQTT只支持非自建集群
2089
+ 注意:此字段可能返回 null,表示取不到有效值。
2090
+ */
2091
+ SelfBuilt?: boolean;
2092
+ }
1988
2093
  /**
1989
2094
  * SendMessage请求参数结构体
1990
2095
  */
@@ -2451,22 +2556,27 @@ export interface MongoDBModifyConnectParam {
2451
2556
  export interface TdwParam {
2452
2557
  /**
2453
2558
  * Tdw的bid
2559
+ 注意:此字段可能返回 null,表示取不到有效值。
2454
2560
  */
2455
2561
  Bid: string;
2456
2562
  /**
2457
2563
  * Tdw的tid
2564
+ 注意:此字段可能返回 null,表示取不到有效值。
2458
2565
  */
2459
2566
  Tid: string;
2460
2567
  /**
2461
2568
  * 默认true
2569
+ 注意:此字段可能返回 null,表示取不到有效值。
2462
2570
  */
2463
2571
  IsDomestic?: boolean;
2464
2572
  /**
2465
2573
  * TDW地址,默认tl-tdbank-tdmanager.tencent-distribute.com
2574
+ 注意:此字段可能返回 null,表示取不到有效值。
2466
2575
  */
2467
2576
  TdwHost?: string;
2468
2577
  /**
2469
2578
  * TDW端口,默认8099
2579
+ 注意:此字段可能返回 null,表示取不到有效值。
2470
2580
  */
2471
2581
  TdwPort?: number;
2472
2582
  }
@@ -3304,42 +3414,52 @@ export interface CreateConnectResourceRequest {
3304
3414
  export interface MariaDBParam {
3305
3415
  /**
3306
3416
  * MariaDB的数据库名称,"*"为全数据库
3417
+ 注意:此字段可能返回 null,表示取不到有效值。
3307
3418
  */
3308
3419
  Database: string;
3309
3420
  /**
3310
3421
  * MariaDB的数据表名称,"*"为所监听的所有数据库中的非系统表,可以","间隔,监听多个数据表,但数据表需要以"数据库名.数据表名"的格式进行填写
3422
+ 注意:此字段可能返回 null,表示取不到有效值。
3311
3423
  */
3312
3424
  Table: string;
3313
3425
  /**
3314
3426
  * 该MariaDB在连接管理内的Id
3427
+ 注意:此字段可能返回 null,表示取不到有效值。
3315
3428
  */
3316
3429
  Resource: string;
3317
3430
  /**
3318
3431
  * 复制存量信息(schema_only不复制, initial全量),默认位initial
3432
+ 注意:此字段可能返回 null,表示取不到有效值。
3319
3433
  */
3320
3434
  SnapshotMode?: string;
3321
3435
  /**
3322
3436
  * 格式:库1.表1:字段1,字段2;库2.表2:字段2,表之间;(分号)隔开,字段之间,(逗号)隔开。不指定的表默认取表的主键
3437
+ 注意:此字段可能返回 null,表示取不到有效值。
3323
3438
  */
3324
3439
  KeyColumns?: string;
3325
3440
  /**
3326
3441
  * 当Table输入的是前缀时,该项值为true,否则为false
3442
+ 注意:此字段可能返回 null,表示取不到有效值。
3327
3443
  */
3328
3444
  IsTablePrefix?: boolean;
3329
3445
  /**
3330
3446
  * 输出格式,DEFAULT、CANAL_1、CANAL_2
3447
+ 注意:此字段可能返回 null,表示取不到有效值。
3331
3448
  */
3332
3449
  OutputFormat?: string;
3333
3450
  /**
3334
3451
  * 如果该值为all,则DDL数据以及DML数据也会写入到选中的topic;若该值为dml,则只有DML数据写入到选中的topic
3452
+ 注意:此字段可能返回 null,表示取不到有效值。
3335
3453
  */
3336
3454
  IncludeContentChanges?: string;
3337
3455
  /**
3338
3456
  * 如果该值为true,且MySQL中"binlog_rows_query_log_events"配置项的值为"ON",则流入到topic的数据包含原SQL语句;若该值为false,流入到topic的数据不包含原SQL语句
3457
+ 注意:此字段可能返回 null,表示取不到有效值。
3339
3458
  */
3340
3459
  IncludeQuery?: boolean;
3341
3460
  /**
3342
3461
  * 如果该值为 true,则消息中会携带消息结构体对应的schema,如果该值为false则不会携带
3462
+ 注意:此字段可能返回 null,表示取不到有效值。
3343
3463
  */
3344
3464
  RecordWithSchema?: boolean;
3345
3465
  }
@@ -3918,6 +4038,46 @@ export interface TopicInSyncReplicaInfo {
3918
4038
  */
3919
4039
  OutOfSyncReplica: string;
3920
4040
  }
4041
+ /**
4042
+ * MQTT连接源参数
4043
+ */
4044
+ export interface MqttConnectParam {
4045
+ /**
4046
+ * MQTT连接源的用户名
4047
+ 注意:此字段可能返回 null,表示取不到有效值。
4048
+ */
4049
+ UserName: string;
4050
+ /**
4051
+ * MQTT连接源的密码
4052
+ 注意:此字段可能返回 null,表示取不到有效值。
4053
+ */
4054
+ Password: string;
4055
+ /**
4056
+ * MQTT连接源的实例资源
4057
+ 注意:此字段可能返回 null,表示取不到有效值。
4058
+ */
4059
+ Resource: string;
4060
+ /**
4061
+ * MQTT Instance vpc-id
4062
+ 注意:此字段可能返回 null,表示取不到有效值。
4063
+ */
4064
+ UniqVpcId: string;
4065
+ /**
4066
+ * 是否为自建集群
4067
+ 注意:此字段可能返回 null,表示取不到有效值。
4068
+ */
4069
+ SelfBuilt?: boolean;
4070
+ /**
4071
+ * 是否更新到关联的Dip任务
4072
+ 注意:此字段可能返回 null,表示取不到有效值。
4073
+ */
4074
+ IsUpdate?: boolean;
4075
+ /**
4076
+ * MQTT连接源的实例资源地域, 跨地域时必填
4077
+ 注意:此字段可能返回 null,表示取不到有效值。
4078
+ */
4079
+ Region?: string;
4080
+ }
3921
4081
  /**
3922
4082
  * DeleteConnectResource返回参数结构体
3923
4083
  */
@@ -4470,34 +4630,42 @@ export interface DescribeAppInfoResponse {
4470
4630
  export interface CosParam {
4471
4631
  /**
4472
4632
  * cos 存储桶名称
4633
+ 注意:此字段可能返回 null,表示取不到有效值。
4473
4634
  */
4474
4635
  BucketName: string;
4475
4636
  /**
4476
4637
  * 地域代码
4638
+ 注意:此字段可能返回 null,表示取不到有效值。
4477
4639
  */
4478
4640
  Region: string;
4479
4641
  /**
4480
4642
  * 对象名称
4643
+ 注意:此字段可能返回 null,表示取不到有效值。
4481
4644
  */
4482
4645
  ObjectKey?: string;
4483
4646
  /**
4484
4647
  * 汇聚消息量的大小(单位:MB)
4648
+ 注意:此字段可能返回 null,表示取不到有效值。
4485
4649
  */
4486
4650
  AggregateBatchSize?: number;
4487
4651
  /**
4488
4652
  * 汇聚的时间间隔(单位:小时)
4653
+ 注意:此字段可能返回 null,表示取不到有效值。
4489
4654
  */
4490
4655
  AggregateInterval?: number;
4491
4656
  /**
4492
4657
  * 消息汇聚后的文件格式(支持csv, json)
4658
+ 注意:此字段可能返回 null,表示取不到有效值。
4493
4659
  */
4494
4660
  FormatOutputType?: string;
4495
4661
  /**
4496
4662
  * 转储的对象目录前缀
4663
+ 注意:此字段可能返回 null,表示取不到有效值。
4497
4664
  */
4498
4665
  ObjectKeyPrefix?: string;
4499
4666
  /**
4500
4667
  * 根据strptime 时间格式化的分区格式
4668
+ 注意:此字段可能返回 null,表示取不到有效值。
4501
4669
  */
4502
4670
  DirectoryTimeFormat?: string;
4503
4671
  }
@@ -4741,18 +4909,22 @@ export interface Config {
4741
4909
  export interface ClickHouseSchema {
4742
4910
  /**
4743
4911
  * 表的列名
4912
+ 注意:此字段可能返回 null,表示取不到有效值。
4744
4913
  */
4745
4914
  ColumnName: string;
4746
4915
  /**
4747
4916
  * 该列对应的jsonKey名
4917
+ 注意:此字段可能返回 null,表示取不到有效值。
4748
4918
  */
4749
4919
  JsonKey: string;
4750
4920
  /**
4751
4921
  * 表列项的类型
4922
+ 注意:此字段可能返回 null,表示取不到有效值。
4752
4923
  */
4753
4924
  Type: string;
4754
4925
  /**
4755
4926
  * 列项是否允许为空
4927
+ 注意:此字段可能返回 null,表示取不到有效值。
4756
4928
  */
4757
4929
  AllowNull: boolean;
4758
4930
  }
@@ -4960,7 +5132,7 @@ export interface VipEntity {
4960
5132
  */
4961
5133
  export interface KafkaConnectParam {
4962
5134
  /**
4963
- * Kafka连接源的实例资源, 非自建时必填
5135
+ * Kafka连接源的实例资源, 非自建时必填,NetworkType=VPC时传clb实例id
4964
5136
  注意:此字段可能返回 null,表示取不到有效值。
4965
5137
  */
4966
5138
  Resource?: string;
@@ -4975,7 +5147,7 @@ export interface KafkaConnectParam {
4975
5147
  */
4976
5148
  IsUpdate?: boolean;
4977
5149
  /**
4978
- * Kafka连接的broker地址, 自建时必填
5150
+ * Kafka连接的broker地址, NetworkType=PUBLIC公网时必填
4979
5151
  注意:此字段可能返回 null,表示取不到有效值。
4980
5152
  */
4981
5153
  BrokerAddress?: string;
@@ -6847,54 +7019,67 @@ export interface CreateRouteResponse {
6847
7019
  export interface PostgreSQLParam {
6848
7020
  /**
6849
7021
  * PostgreSQL的数据库名称
7022
+ 注意:此字段可能返回 null,表示取不到有效值。
6850
7023
  */
6851
7024
  Database: string;
6852
7025
  /**
6853
7026
  * PostgreSQL的数据表名称,"*"为所监听的所有数据库中的非系统表,可以","间隔,监听多个数据表,但数据表需要以"Schema名.数据表名"的格式进行填写,需要填入正则表达式时,格式为"Schema名\\.数据表名"
7027
+ 注意:此字段可能返回 null,表示取不到有效值。
6854
7028
  */
6855
7029
  Table: string;
6856
7030
  /**
6857
7031
  * 该PostgreSQL在连接管理内的Id
7032
+ 注意:此字段可能返回 null,表示取不到有效值。
6858
7033
  */
6859
7034
  Resource: string;
6860
7035
  /**
6861
7036
  * 插件名(decoderbufs/pgoutput),默认为decoderbufs
7037
+ 注意:此字段可能返回 null,表示取不到有效值。
6862
7038
  */
6863
7039
  PluginName: string;
6864
7040
  /**
6865
7041
  * 复制存量信息(never增量, initial全量),默认为initial
7042
+ 注意:此字段可能返回 null,表示取不到有效值。
6866
7043
  */
6867
7044
  SnapshotMode?: string;
6868
7045
  /**
6869
7046
  * 上游数据格式(JSON/Debezium), 当数据库同步模式为默认字段匹配时,必填
7047
+ 注意:此字段可能返回 null,表示取不到有效值。
6870
7048
  */
6871
7049
  DataFormat?: string;
6872
7050
  /**
6873
7051
  * "INSERT" 表示使用 Insert 模式插入,"UPSERT" 表示使用 Upsert 模式插入
7052
+ 注意:此字段可能返回 null,表示取不到有效值。
6874
7053
  */
6875
7054
  DataTargetInsertMode?: string;
6876
7055
  /**
6877
7056
  * 当 "DataInsertMode"="UPSERT" 时,传入当前 upsert 时依赖的主键
7057
+ 注意:此字段可能返回 null,表示取不到有效值。
6878
7058
  */
6879
7059
  DataTargetPrimaryKeyField?: string;
6880
7060
  /**
6881
7061
  * 表与消息间的映射关系
7062
+ 注意:此字段可能返回 null,表示取不到有效值。
6882
7063
  */
6883
7064
  DataTargetRecordMapping?: Array<RecordMapping>;
6884
7065
  /**
6885
7066
  * 是否抛弃解析失败的消息,默认为true
7067
+ 注意:此字段可能返回 null,表示取不到有效值。
6886
7068
  */
6887
7069
  DropInvalidMessage?: boolean;
6888
7070
  /**
6889
7071
  * 输入的table是否为正则表达式
7072
+ 注意:此字段可能返回 null,表示取不到有效值。
6890
7073
  */
6891
7074
  IsTableRegular?: boolean;
6892
7075
  /**
6893
7076
  * 格式:库1.表1:字段1,字段2;库2.表2:字段2,表之间;(分号)隔开,字段之间,(逗号)隔开。不指定的表默认取表的主键
7077
+ 注意:此字段可能返回 null,表示取不到有效值。
6894
7078
  */
6895
7079
  KeyColumns?: string;
6896
7080
  /**
6897
7081
  * 如果该值为 true,则消息中会携带消息结构体对应的schema,如果该值为false则不会携带
7082
+ 注意:此字段可能返回 null,表示取不到有效值。
6898
7083
  */
6899
7084
  RecordWithSchema?: boolean;
6900
7085
  }
@@ -6983,23 +7168,28 @@ export interface DescribeGroup {
6983
7168
  export interface ClsParam {
6984
7169
  /**
6985
7170
  * 生产的信息是否为json格式
7171
+ 注意:此字段可能返回 null,表示取不到有效值。
6986
7172
  */
6987
7173
  DecodeJson: boolean;
6988
7174
  /**
6989
7175
  * cls日志主题id
7176
+ 注意:此字段可能返回 null,表示取不到有效值。
6990
7177
  */
6991
7178
  Resource: string;
6992
7179
  /**
6993
7180
  * cls日志集id
7181
+ 注意:此字段可能返回 null,表示取不到有效值。
6994
7182
  */
6995
7183
  LogSet?: string;
6996
7184
  /**
6997
7185
  * 当DecodeJson为false时必填
7186
+ 注意:此字段可能返回 null,表示取不到有效值。
6998
7187
  */
6999
7188
  ContentKey?: string;
7000
7189
  /**
7001
7190
  * 指定消息中的某字段内容作为cls日志的时间。
7002
7191
  字段内容格式需要是秒级时间戳
7192
+ 注意:此字段可能返回 null,表示取不到有效值。
7003
7193
  */
7004
7194
  TimeField?: string;
7005
7195
  }
@@ -7396,10 +7586,12 @@ export interface DescribeGroupOffsetsResponse {
7396
7586
  export interface CtsdbParam {
7397
7587
  /**
7398
7588
  * 连接管理实例资源
7589
+ 注意:此字段可能返回 null,表示取不到有效值。
7399
7590
  */
7400
7591
  Resource?: string;
7401
7592
  /**
7402
7593
  * Ctsdb的metric
7594
+ 注意:此字段可能返回 null,表示取不到有效值。
7403
7595
  */
7404
7596
  CtsdbMetric?: string;
7405
7597
  }
@@ -7706,50 +7898,62 @@ export interface DescribeAclRuleRequest {
7706
7898
  export interface MongoDBParam {
7707
7899
  /**
7708
7900
  * MongoDB的数据库名称
7901
+ 注意:此字段可能返回 null,表示取不到有效值。
7709
7902
  */
7710
7903
  Database: string;
7711
7904
  /**
7712
7905
  * MongoDB的集群
7906
+ 注意:此字段可能返回 null,表示取不到有效值。
7713
7907
  */
7714
7908
  Collection: string;
7715
7909
  /**
7716
7910
  * 是否复制存量数据,默认传参true
7911
+ 注意:此字段可能返回 null,表示取不到有效值。
7717
7912
  */
7718
7913
  CopyExisting: boolean;
7719
7914
  /**
7720
7915
  * 实例资源
7916
+ 注意:此字段可能返回 null,表示取不到有效值。
7721
7917
  */
7722
7918
  Resource: string;
7723
7919
  /**
7724
7920
  * MongoDB的连接ip
7921
+ 注意:此字段可能返回 null,表示取不到有效值。
7725
7922
  */
7726
7923
  Ip?: string;
7727
7924
  /**
7728
7925
  * MongoDB的连接port
7926
+ 注意:此字段可能返回 null,表示取不到有效值。
7729
7927
  */
7730
7928
  Port?: number;
7731
7929
  /**
7732
7930
  * MongoDB数据库用户名
7931
+ 注意:此字段可能返回 null,表示取不到有效值。
7733
7932
  */
7734
7933
  UserName?: string;
7735
7934
  /**
7736
7935
  * MongoDB数据库密码
7936
+ 注意:此字段可能返回 null,表示取不到有效值。
7737
7937
  */
7738
7938
  Password?: string;
7739
7939
  /**
7740
7940
  * 监听事件类型,为空时表示全选。取值包括insert,update,replace,delete,invalidate,drop,dropdatabase,rename,多个类型间使用,逗号分隔
7941
+ 注意:此字段可能返回 null,表示取不到有效值。
7741
7942
  */
7742
7943
  ListeningEvent?: string;
7743
7944
  /**
7744
7945
  * 主从优先级,默认主节点
7946
+ 注意:此字段可能返回 null,表示取不到有效值。
7745
7947
  */
7746
7948
  ReadPreference?: string;
7747
7949
  /**
7748
7950
  * 聚合管道
7951
+ 注意:此字段可能返回 null,表示取不到有效值。
7749
7952
  */
7750
7953
  Pipeline?: string;
7751
7954
  /**
7752
7955
  * 是否为自建集群
7956
+ 注意:此字段可能返回 null,表示取不到有效值。
7753
7957
  */
7754
7958
  SelfBuilt?: boolean;
7755
7959
  }
@@ -8104,22 +8308,27 @@ export interface MySQLConnectParam {
8104
8308
  export interface ScfParam {
8105
8309
  /**
8106
8310
  * SCF云函数函数名
8311
+ 注意:此字段可能返回 null,表示取不到有效值。
8107
8312
  */
8108
8313
  FunctionName: string;
8109
8314
  /**
8110
8315
  * SCF云函数命名空间, 默认为default
8316
+ 注意:此字段可能返回 null,表示取不到有效值。
8111
8317
  */
8112
8318
  Namespace?: string;
8113
8319
  /**
8114
8320
  * SCF云函数版本及别名, 默认为$DEFAULT
8321
+ 注意:此字段可能返回 null,表示取不到有效值。
8115
8322
  */
8116
8323
  Qualifier?: string;
8117
8324
  /**
8118
8325
  * 每批最大发送消息数, 默认为1000
8326
+ 注意:此字段可能返回 null,表示取不到有效值。
8119
8327
  */
8120
8328
  BatchSize?: number;
8121
8329
  /**
8122
8330
  * SCF调用失败后重试次数, 默认为5
8331
+ 注意:此字段可能返回 null,表示取不到有效值。
8123
8332
  */
8124
8333
  MaxRetries?: number;
8125
8334
  }
@@ -8275,47 +8484,47 @@ export interface DescribeConnectResource {
8275
8484
  * 连接源的Id
8276
8485
  注意:此字段可能返回 null,表示取不到有效值。
8277
8486
  */
8278
- ResourceId: string;
8487
+ ResourceId?: string;
8279
8488
  /**
8280
8489
  * 连接源名称
8281
8490
  注意:此字段可能返回 null,表示取不到有效值。
8282
8491
  */
8283
- ResourceName: string;
8492
+ ResourceName?: string;
8284
8493
  /**
8285
8494
  * 连接源描述
8286
8495
  注意:此字段可能返回 null,表示取不到有效值。
8287
8496
  */
8288
- Description: string;
8497
+ Description?: string;
8289
8498
  /**
8290
8499
  * 连接源类型
8291
8500
  注意:此字段可能返回 null,表示取不到有效值。
8292
8501
  */
8293
- Type: string;
8502
+ Type?: string;
8294
8503
  /**
8295
8504
  * 连接源的状态
8296
8505
  注意:此字段可能返回 null,表示取不到有效值。
8297
8506
  */
8298
- Status: number;
8507
+ Status?: number;
8299
8508
  /**
8300
8509
  * 连接源的创建时间
8301
8510
  注意:此字段可能返回 null,表示取不到有效值。
8302
8511
  */
8303
- CreateTime: string;
8512
+ CreateTime?: string;
8304
8513
  /**
8305
8514
  * 连接源的异常信息
8306
8515
  注意:此字段可能返回 null,表示取不到有效值。
8307
8516
  */
8308
- ErrorMessage: string;
8517
+ ErrorMessage?: string;
8309
8518
  /**
8310
8519
  * 该连接源关联的Datahub任务数
8311
8520
  注意:此字段可能返回 null,表示取不到有效值。
8312
8521
  */
8313
- DatahubTaskCount: number;
8522
+ DatahubTaskCount?: number;
8314
8523
  /**
8315
8524
  * 连接源的当前所处步骤
8316
8525
  注意:此字段可能返回 null,表示取不到有效值。
8317
8526
  */
8318
- CurrentStep: string;
8527
+ CurrentStep?: string;
8319
8528
  /**
8320
8529
  * 创建进度百分比
8321
8530
  注意:此字段可能返回 null,表示取不到有效值。
@@ -8330,57 +8539,62 @@ export interface DescribeConnectResource {
8330
8539
  * Dts配置,Type为DTS时返回
8331
8540
  注意:此字段可能返回 null,表示取不到有效值。
8332
8541
  */
8333
- DtsConnectParam: DtsConnectParam;
8542
+ DtsConnectParam?: DtsConnectParam;
8334
8543
  /**
8335
8544
  * MongoDB配置,Type为MONGODB时返回
8336
8545
  注意:此字段可能返回 null,表示取不到有效值。
8337
8546
  */
8338
- MongoDBConnectParam: MongoDBConnectParam;
8547
+ MongoDBConnectParam?: MongoDBConnectParam;
8339
8548
  /**
8340
8549
  * Es配置,Type为ES时返回
8341
8550
  注意:此字段可能返回 null,表示取不到有效值。
8342
8551
  */
8343
- EsConnectParam: EsConnectParam;
8552
+ EsConnectParam?: EsConnectParam;
8344
8553
  /**
8345
8554
  * ClickHouse配置,Type为CLICKHOUSE时返回
8346
8555
  注意:此字段可能返回 null,表示取不到有效值。
8347
8556
  */
8348
- ClickHouseConnectParam: ClickHouseConnectParam;
8557
+ ClickHouseConnectParam?: ClickHouseConnectParam;
8349
8558
  /**
8350
8559
  * MySQL配置,Type为MYSQL或TDSQL_C_MYSQL时返回
8351
8560
  注意:此字段可能返回 null,表示取不到有效值。
8352
8561
  */
8353
- MySQLConnectParam: MySQLConnectParam;
8562
+ MySQLConnectParam?: MySQLConnectParam;
8354
8563
  /**
8355
8564
  * PostgreSQL配置,Type为POSTGRESQL或TDSQL_C_POSTGRESQL时返回
8356
8565
  注意:此字段可能返回 null,表示取不到有效值。
8357
8566
  */
8358
- PostgreSQLConnectParam: PostgreSQLConnectParam;
8567
+ PostgreSQLConnectParam?: PostgreSQLConnectParam;
8359
8568
  /**
8360
8569
  * MariaDB配置,Type为MARIADB时返回
8361
8570
  注意:此字段可能返回 null,表示取不到有效值。
8362
8571
  */
8363
- MariaDBConnectParam: MariaDBConnectParam;
8572
+ MariaDBConnectParam?: MariaDBConnectParam;
8364
8573
  /**
8365
8574
  * SQLServer配置,Type为SQLSERVER时返回
8366
8575
  注意:此字段可能返回 null,表示取不到有效值。
8367
8576
  */
8368
- SQLServerConnectParam: SQLServerConnectParam;
8577
+ SQLServerConnectParam?: SQLServerConnectParam;
8369
8578
  /**
8370
8579
  * Ctsdb配置,Type为CTSDB时返回
8371
8580
  注意:此字段可能返回 null,表示取不到有效值。
8372
8581
  */
8373
- CtsdbConnectParam: CtsdbConnectParam;
8582
+ CtsdbConnectParam?: CtsdbConnectParam;
8374
8583
  /**
8375
8584
  * Doris 配置,Type 为 DORIS 时返回
8376
8585
  注意:此字段可能返回 null,表示取不到有效值。
8377
8586
  */
8378
- DorisConnectParam: DorisConnectParam;
8587
+ DorisConnectParam?: DorisConnectParam;
8379
8588
  /**
8380
8589
  * Kafka配置,Type 为 KAFKA 时返回
8381
8590
  注意:此字段可能返回 null,表示取不到有效值。
8382
8591
  */
8383
8592
  KafkaConnectParam?: KafkaConnectParam;
8593
+ /**
8594
+ * MQTT配置,Type 为 MQTT 时返回
8595
+ 注意:此字段可能返回 null,表示取不到有效值。
8596
+ */
8597
+ MqttConnectParam?: MqttConnectParam;
8384
8598
  }
8385
8599
  /**
8386
8600
  * ModifyDatahubTask请求参数结构体
@@ -8510,18 +8724,22 @@ export interface AclRuleResp {
8510
8724
  export interface SQLServerParam {
8511
8725
  /**
8512
8726
  * SQLServer的数据库名称
8727
+ 注意:此字段可能返回 null,表示取不到有效值。
8513
8728
  */
8514
8729
  Database: string;
8515
8730
  /**
8516
8731
  * SQLServer的数据表名称,"*"为所监听的所有数据库中的非系统表,可以","间隔,监听多个数据表,但数据表需要以"数据库名.数据表名"的格式进行填写
8732
+ 注意:此字段可能返回 null,表示取不到有效值。
8517
8733
  */
8518
8734
  Table: string;
8519
8735
  /**
8520
8736
  * 该SQLServer在连接管理内的Id
8737
+ 注意:此字段可能返回 null,表示取不到有效值。
8521
8738
  */
8522
8739
  Resource: string;
8523
8740
  /**
8524
8741
  * 复制存量信息(schema_only增量, initial全量),默认为initial
8742
+ 注意:此字段可能返回 null,表示取不到有效值。
8525
8743
  */
8526
8744
  SnapshotMode?: string;
8527
8745
  }