@ucloud-sdks/ucloud-sdk-js 0.2.10 → 0.2.11

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.
@@ -75,6 +75,12 @@ export default class UDBClient extends Client {
75
75
  * See also: https://docs.ucloud.cn/api/udb-api/create_udb_instance_by_recovery
76
76
  */
77
77
  createUDBInstanceByRecovery(request?: CreateUDBInstanceByRecoveryRequest): Promise<CreateUDBInstanceByRecoveryResponse>;
78
+ /**
79
+ * CreateUDBMySQLInstance - 创建UDB实例(包括创建mysql NVMe、共享型和O2实例以及从备份恢复实例)
80
+ *
81
+ * See also: https://docs.ucloud.cn/api/udb-api/create_udb_my_sql_instance
82
+ */
83
+ createUDBMySQLInstance(request?: CreateUDBMySQLInstanceRequest): Promise<CreateUDBMySQLInstanceResponse>;
78
84
  /**
79
85
  * CreateUDBParamGroup - 从已有配置文件创建新配置文件
80
86
  *
@@ -93,6 +99,12 @@ export default class UDBClient extends Client {
93
99
  * See also: https://docs.ucloud.cn/api/udb-api/create_udb_route_instance
94
100
  */
95
101
  createUDBRouteInstance(request?: CreateUDBRouteInstanceRequest): Promise<CreateUDBRouteInstanceResponse>;
102
+ /**
103
+ * CreateUDBSQLServerInstance - 创建UDB实例(包括创建SQLServer实例以及从备份恢复实例)
104
+ *
105
+ * See also: https://docs.ucloud.cn/api/udb-api/create_udb_sql_server_instance
106
+ */
107
+ createUDBSQLServerInstance(request?: CreateUDBSQLServerInstanceRequest): Promise<CreateUDBSQLServerInstanceResponse>;
96
108
  /**
97
109
  * CreateUDBSlave - 创建UDB实例的slave
98
110
  *
@@ -118,7 +130,7 @@ export default class UDBClient extends Client {
118
130
  */
119
131
  deleteUDBParamGroup(request?: DeleteUDBParamGroupRequest): Promise<DeleteUDBParamGroupResponse>;
120
132
  /**
121
- * DescribeUDBBackup - 列表UDB实例备份信息
133
+ * DescribeUDBBackup - 列表UDB实例备份信息.Zone不填表示多可用区,填代表单可用区
122
134
  *
123
135
  * See also: https://docs.ucloud.cn/api/udb-api/describe_udb_backup
124
136
  */
@@ -130,7 +142,13 @@ export default class UDBClient extends Client {
130
142
  */
131
143
  describeUDBBackupBlacklist(request?: DescribeUDBBackupBlacklistRequest): Promise<DescribeUDBBackupBlacklistResponse>;
132
144
  /**
133
- * DescribeUDBBinlogBackupURL - 获取UDBBinlog备份地址
145
+ * DescribeUDBBinlogBackup - 列表UDB实例Binlog自动备份信息
146
+ *
147
+ * See also: https://docs.ucloud.cn/api/udb-api/describe_udb_binlog_backup
148
+ */
149
+ describeUDBBinlogBackup(request?: DescribeUDBBinlogBackupRequest): Promise<DescribeUDBBinlogBackupResponse>;
150
+ /**
151
+ * DescribeUDBBinlogBackupURL - 获取UDB的Binlog或者错误日志或者慢查询日志的备份地址
134
152
  *
135
153
  * See also: https://docs.ucloud.cn/api/udb-api/describe_udb_binlog_backup_url
136
154
  */
@@ -190,7 +208,7 @@ export default class UDBClient extends Client {
190
208
  */
191
209
  describeUDBInstanceUpgradePrice(request?: DescribeUDBInstanceUpgradePriceRequest): Promise<DescribeUDBInstanceUpgradePriceResponse>;
192
210
  /**
193
- * DescribeUDBLogBackupURL - 获取UDB的slowlog备份地址
211
+ * DescribeUDBLogBackupURL - 获取UDB的错误日志或者慢查询日志备份地址
194
212
  *
195
213
  * See also: https://docs.ucloud.cn/api/udb-api/describe_udb_log_backup_url
196
214
  */
@@ -255,6 +273,24 @@ export default class UDBClient extends Client {
255
273
  * See also: https://docs.ucloud.cn/api/udb-api/get_udb_client_conn_num
256
274
  */
257
275
  getUDBClientConnNum(request?: GetUDBClientConnNumRequest): Promise<GetUDBClientConnNumResponse>;
276
+ /**
277
+ * GetUDBInstanceSSLCertURL - 获取SSL证书下载地址
278
+ *
279
+ * See also: https://docs.ucloud.cn/api/udb-api/get_udb_instance_ssl_cert_url
280
+ */
281
+ getUDBInstanceSSLCertURL(request?: GetUDBInstanceSSLCertURLRequest): Promise<GetUDBInstanceSSLCertURLResponse>;
282
+ /**
283
+ * ListUDBMachineType - 获取UDB云数据库支持的计算规格列表,暂不支持获取跨可用区实例的计算规格,目前支持的数据库品类包括:NVMe版和SSD云盘版MySQL
284
+ *
285
+ * See also: https://docs.ucloud.cn/api/udb-api/list_udb_machine_type
286
+ */
287
+ listUDBMachineType(request?: ListUDBMachineTypeRequest): Promise<ListUDBMachineTypeResponse>;
288
+ /**
289
+ * ListUDBUserTables - 查看udb实例所有的用户表集合 (只包括引擎为innodb和myisam的表)
290
+ *
291
+ * See also: https://docs.ucloud.cn/api/udb-api/list_udb_user_tables
292
+ */
293
+ listUDBUserTables(request?: ListUDBUserTablesRequest): Promise<ListUDBUserTablesResponse>;
258
294
  /**
259
295
  * ModifyUDBInstanceName - 重命名UDB实例
260
296
  *
@@ -267,6 +303,18 @@ export default class UDBClient extends Client {
267
303
  * See also: https://docs.ucloud.cn/api/udb-api/modify_udb_instance_password
268
304
  */
269
305
  modifyUDBInstancePassword(request?: ModifyUDBInstancePasswordRequest): Promise<ModifyUDBInstancePasswordResponse>;
306
+ /**
307
+ * ModifyUDBInstanceRemarkName - 修改UDB实例备注信息
308
+ *
309
+ * See also: https://docs.ucloud.cn/api/udb-api/modify_udb_instance_remark_name
310
+ */
311
+ modifyUDBInstanceRemarkName(request?: ModifyUDBInstanceRemarkNameRequest): Promise<ModifyUDBInstanceRemarkNameResponse>;
312
+ /**
313
+ * ModifyUDBInstanceSSL - 调整SSL的信息
314
+ *
315
+ * See also: https://docs.ucloud.cn/api/udb-api/modify_udb_instance_ssl
316
+ */
317
+ modifyUDBInstanceSSL(request?: ModifyUDBInstanceSSLRequest): Promise<ModifyUDBInstanceSSLResponse>;
270
318
  /**
271
319
  * PromoteUDBInstanceToHA - 普通db升级为高可用(只针对mysql5.5及以上版本SSD机型的实例) ,对于NVMe机型的单点升级高可用,虽然也能使用该操作再加上SwitchUDBInstanceToHA,但是更建议直接调用新的API接口(UpgradeUDBInstanceToHA)
272
320
  *
@@ -297,6 +345,12 @@ export default class UDBClient extends Client {
297
345
  * See also: https://docs.ucloud.cn/api/udb-api/restart_udb_instance
298
346
  */
299
347
  restartUDBInstance(request?: RestartUDBInstanceRequest): Promise<RestartUDBInstanceResponse>;
348
+ /**
349
+ * RollbackUDBInstance - 在原实例回档指定库表
350
+ *
351
+ * See also: https://docs.ucloud.cn/api/udb-api/rollback_udb_instance
352
+ */
353
+ rollbackUDBInstance(request?: RollbackUDBInstanceRequest): Promise<RollbackUDBInstanceResponse>;
300
354
  /**
301
355
  * SetUDBRWSplitting - 设置读写分离的模式
302
356
  *
@@ -351,6 +405,12 @@ export default class UDBClient extends Client {
351
405
  * See also: https://docs.ucloud.cn/api/udb-api/upgrade_udb_instance_to_ha
352
406
  */
353
407
  upgradeUDBInstanceToHA(request?: UpgradeUDBInstanceToHARequest): Promise<UpgradeUDBInstanceToHAResponse>;
408
+ /**
409
+ * UpgradeUDBVersion - 升级db实例版本
410
+ *
411
+ * See also: https://docs.ucloud.cn/api/udb-api/upgrade_udb_version
412
+ */
413
+ upgradeUDBVersion(request?: UpgradeUDBVersionRequest): Promise<UpgradeUDBVersionResponse>;
354
414
  /**
355
415
  * UploadUDBParamGroup - 导入UDB配置
356
416
  *
@@ -363,7 +423,7 @@ export default class UDBClient extends Client {
363
423
  */
364
424
  export interface BackupUDBInstanceRequest {
365
425
  /**
366
- * 可用区。参见 [可用区列表](../summary/regionlist.html)
426
+ * 可用区。参见 [可用区列表](https://docs.ucloud.cn/api/summary/regionlist)
367
427
  */
368
428
  Zone?: string;
369
429
  /**
@@ -379,7 +439,7 @@ export interface BackupUDBInstanceRequest {
379
439
  */
380
440
  UseBlacklist?: boolean;
381
441
  /**
382
- * 使用的备份方式。(快照备份即物理备份。注意只有SSD版本的mysql实例支持设置为snapshot)
442
+ * 使用的备份方式。默认使用逻辑备份(快照备份即物理备份。SSD版本的mysql/mongodb实例支持设置为snapshot,NVMe版本的mysql实例支持设置为xtrabackup
383
443
  */
384
444
  BackupMethod?: string;
385
445
  /**
@@ -401,7 +461,7 @@ export interface BackupUDBInstanceResponse {
401
461
  */
402
462
  export interface BackupUDBInstanceBinlogRequest {
403
463
  /**
404
- * 可用区。参见 [可用区列表](../summary/regionlist.html)
464
+ * 可用区。参见 [可用区列表](https://docs.ucloud.cn/api/summary/regionlist)
405
465
  */
406
466
  Zone?: string;
407
467
  /**
@@ -427,7 +487,7 @@ export interface BackupUDBInstanceBinlogResponse {
427
487
  */
428
488
  export interface BackupUDBInstanceErrorLogRequest {
429
489
  /**
430
- * 可用区。参见 [可用区列表](../summary/regionlist.html)
490
+ * 可用区。参见 [可用区列表](https://docs.ucloud.cn/api/summary/regionlist)
431
491
  */
432
492
  Zone?: string;
433
493
  /**
@@ -475,7 +535,7 @@ export interface BackupUDBInstanceSlowLogResponse {
475
535
  */
476
536
  export interface ChangeUDBParamGroupRequest {
477
537
  /**
478
- * 可用区。参见 [可用区列表](../summary/regionlist.html)
538
+ * 可用区。参见 [可用区列表](https://docs.ucloud.cn/api/summary/regionlist)
479
539
  */
480
540
  Zone?: string;
481
541
  /**
@@ -497,11 +557,11 @@ export interface ChangeUDBParamGroupResponse {
497
557
  */
498
558
  export interface CheckRecoverUDBInstanceRequest {
499
559
  /**
500
- * 可用区。参见 [可用区列表](../summary/regionlist.html)
560
+ * 可用区。参见 [可用区列表](https://docs.ucloud.cn/api/summary/regionlist)
501
561
  */
502
562
  Zone?: string;
503
563
  /**
504
- * 源实例的Id
564
+ * 源实例的Id(只支持普通版DB不支持高可用)
505
565
  */
506
566
  SrcDBId: string;
507
567
  }
@@ -537,7 +597,7 @@ export interface CheckUDBInstanceToHAAllowanceResponse {
537
597
  */
538
598
  export interface ClearUDBLogRequest {
539
599
  /**
540
- * 可用区。参见 [可用区列表](../summary/regionlist.html)
600
+ * 可用区。参见 [可用区列表](https://docs.ucloud.cn/api/summary/regionlist)
541
601
  */
542
602
  Zone?: string;
543
603
  /**
@@ -563,7 +623,7 @@ export interface ClearUDBLogResponse {
563
623
  */
564
624
  export interface CreateMongoDBReplicaSetRequest {
565
625
  /**
566
- * 可用区。参见 [可用区列表](../summary/regionlist.html)
626
+ * 可用区。参见 [可用区列表](https://docs.ucloud.cn/api/summary/regionlist)
567
627
  */
568
628
  Zone: string;
569
629
  /**
@@ -575,7 +635,7 @@ export interface CreateMongoDBReplicaSetRequest {
575
635
  */
576
636
  AdminPassword: string;
577
637
  /**
578
- * DB类型id对应的字符串形式(例如:mongodb-2.6)注意:当前仅支持mongodb
638
+ * DB类型id对应的字符串形式 mongodb-3.4,mongodb-3.6,mongodb-4.0
579
639
  */
580
640
  DBTypeId: string;
581
641
  /**
@@ -587,7 +647,7 @@ export interface CreateMongoDBReplicaSetRequest {
587
647
  */
588
648
  ParamGroupId: number;
589
649
  /**
590
- * 内存限制(MB),目前支持以下几档 1000M/2000M/4000M/ 6000M/8000M/12000M/16000M/ 24000M/32000M/48000M/ 64000M/96000M
650
+ * 内存限制(MB),目前支持以下几档 2000M/4000M/ 6000M/8000M/12000M/16000M/ 24000M/32000M/48000M/ 64000M/96000M
591
651
  */
592
652
  MemoryLimit: number;
593
653
  /**
@@ -618,22 +678,10 @@ export interface CreateMongoDBReplicaSetRequest {
618
678
  * 备份策略,备份时间间隔,单位小时计,默认24小时
619
679
  */
620
680
  BackupDuration?: number;
621
- /**
622
- * 是否使用SSD,默认为true
623
- */
624
- UseSSD?: boolean;
625
- /**
626
- * SSD类型,可选值为"SATA"、"PCI-E",如果UseSSD为true ,则必选
627
- */
628
- SSDType?: string;
629
681
  /**
630
682
  * cpu核数
631
683
  */
632
684
  CPU?: number;
633
- /**
634
- * UDB数据库机型
635
- */
636
- InstanceType?: string;
637
685
  /**
638
686
  * 子网ID
639
687
  */
@@ -665,7 +713,7 @@ export interface CreateMongoDBReplicaSetResponse {
665
713
  */
666
714
  export interface CreateUDBInstanceRequest {
667
715
  /**
668
- * 可用区。参见 [可用区列表](../summary/regionlist.html)
716
+ * 可用区。参见 [可用区列表](https://docs.ucloud.cn/api/summary/regionlist)
669
717
  */
670
718
  Zone: string;
671
719
  /**
@@ -677,11 +725,11 @@ export interface CreateUDBInstanceRequest {
677
725
  */
678
726
  AdminPassword: string;
679
727
  /**
680
- * DB类型id,mysql/mongodb/postgesql按版本细分 1:mysql-5.1,2:mysql-5.5,3:percona-5.5,4:mysql-5.6,5:percona-5.6,6:mysql-5.7,7:percona-5.7,8:mariadb-10.0,9:mongodb-2.4,10:mongodb-2.6,11:mongodb-3.0,12:mongodb-3.2,13:postgresql-9.4,14:postgresql-9.6,14:postgresql-10.4
728
+ * DB类型,mysql/sqlserver按版本细分 mysql-8.0, mysql-5.6, percona-5.6, mysql-5.7, percona-5.7, sqlserver-2017
681
729
  */
682
730
  DBTypeId: string;
683
731
  /**
684
- * 端口号,mysql默认3306,mongodb默认27017,postgresql默认5432
732
+ * 端口号,mysql默认3306,sqlserver默认1433
685
733
  */
686
734
  Port: number;
687
735
  /**
@@ -693,9 +741,9 @@ export interface CreateUDBInstanceRequest {
693
741
  */
694
742
  ParamGroupId: number;
695
743
  /**
696
- * 内存限制(MB),目前支持以下几档 1000M/2000M/4000M/ 6000M/8000M/12000M/16000M/ 24000M/32000M/48000M/ 64000M/96000M/128000M/192000M/256000M/320000M
744
+ * 内存限制(MB)(待废弃,请通过指定MachineType和SpecificationType创建),目前支持以下几档 2000M/4000M/ 6000M/8000M/12000M/16000M/ 24000M/32000M/48000M/ 64000M/96000M/128000M/192000M/256000M/320000M
697
745
  */
698
- MemoryLimit: number;
746
+ MemoryLimit?: number;
699
747
  /**
700
748
  * Year, Month, Dynamic,Trial,默认: Month
701
749
  */
@@ -725,11 +773,11 @@ export interface CreateUDBInstanceRequest {
725
773
  */
726
774
  BackupId?: number;
727
775
  /**
728
- * 是否使用SSD,默认为true。目前主要可用区、海外机房、新机房只提供SSD资源,非SSD资源不再提供。
776
+ * 对于快杰机型,请使用最新的 SpecificationClass 和 StorageClass 字段进行创建。目前仅有少量地域支持 SATA_SSD 存储类型;若创建的是 SATA_SSD 机型,可通过该字段指定。字段说明:SATA_SSD:SATA SSD 机型(仅部分地域支持)NVMe_SSD:快杰机型
729
777
  */
730
- UseSSD?: boolean;
778
+ InstanceType?: string;
731
779
  /**
732
- * SSD类型,可选值为"SATA"、“NVMe”,如果UseSSD为true ,则必选
780
+ * 已废弃
733
781
  */
734
782
  SSDType?: string;
735
783
  /**
@@ -737,15 +785,11 @@ export interface CreateUDBInstanceRequest {
737
785
  */
738
786
  InstanceMode?: string;
739
787
  /**
740
- * 专区ID信息(如果这个参数存在这说明是在专区中创建DB)
741
- */
742
- UDBCId?: string;
743
- /**
744
- * cpu核数
788
+ * cpu核数,如果db类型为sqlserver,必传参数
745
789
  */
746
790
  CPU?: number;
747
791
  /**
748
- * 跨可用区高可用备库所在可用区,参见 [可用区列表](../summary/regionlist.html)
792
+ * 跨可用区高可用备库所在可用区,参见 [可用区列表](https://docs.ucloud.cn/api/summary/regionlist)
749
793
  */
750
794
  BackupZone?: string;
751
795
  /**
@@ -761,21 +805,62 @@ export interface CreateUDBInstanceRequest {
761
805
  */
762
806
  DisableSemisync?: boolean;
763
807
  /**
764
- * 当DB类型(DBTypeId)为mongodb时,需要指定mongo的角色,可选值为configsrv (配置节点),shardsrv (数据节点)
808
+ * 已废弃
765
809
  */
766
810
  ClusterRole?: string;
767
- /**
768
- * 高可用架构:1) haproxy(默认): 当前仅支持mysql。2) sentinel: 基于vip和哨兵节点的架构,当前支持mysql和pg。
769
- */
770
- HAArch?: string;
771
811
  /**
772
812
  * 实例所在的业务组名称
773
813
  */
774
814
  Tag?: string;
775
815
  /**
776
- * 是否创建使用ipv6 资源, 默认为false, 或者不填, 创建ipv6为true
816
+ * MySQL 小版本号,支持指定小版本进行创建,请通过 DescribeUDBType 接口获取可用版本。
777
817
  */
778
- EnableIpV6?: boolean;
818
+ DBSubVersion?: string;
819
+ /**
820
+ * mysql大小写参数, 0 为大小写敏感, 1 为大小写不敏感, 目前只针对mysql8.0有效
821
+ */
822
+ CaseSensitivityParam?: number;
823
+ /**
824
+ * 实例计算规格类型,0或不传代表使用内存方式购买,1代表使用内存-cpu可选配比方式购买,需要填写MachineType
825
+ */
826
+ SpecificationType?: string;
827
+ /**
828
+ * 规格类型 ID,当 SpecificationType = 1 时生效,请通过 ListUDBMachineType 接口获取。
829
+ */
830
+ MachineType?: string;
831
+ /**
832
+ * 告警模版id
833
+ */
834
+ AlarmTemplateId?: string;
835
+ /**
836
+ * 备份文件的US3内网下载地址
837
+ */
838
+ BackupURL?: string;
839
+ /**
840
+ * 存储类型 CLOUD_SSD: SSD云盘, CLOUD_RSSD: RSSD 云盘, CLOUD_SSD_ESSENTIAL: SSD Essential云盘 ,该字段和SpecificationClass组合优先级比InstanceType字段高
841
+ */
842
+ StorageClass?: string;
843
+ /**
844
+ * 规格类型 O: NVMe型, OM: 共享型,N: 通用型
845
+ */
846
+ SpecificationClass?: string;
847
+ /**
848
+ * 半同步开启开关 1:表示开启半同步,2:表示关闭半同步,0:表示默认值,默认也是开启半同步
849
+ */
850
+ SemisyncFlag?: number;
851
+ /**
852
+ *
853
+ */
854
+ Labels?: {
855
+ /**
856
+ * 用户资源标签的键值
857
+ */
858
+ Key?: string;
859
+ /**
860
+ * 用户资源标签值
861
+ */
862
+ Value?: string;
863
+ }[];
779
864
  /**
780
865
  * 使用的代金券id
781
866
  */
@@ -795,7 +880,7 @@ export interface CreateUDBInstanceResponse {
795
880
  */
796
881
  export interface CreateUDBInstanceByRecoveryRequest {
797
882
  /**
798
- * 可用区。参见 [可用区列表](../summary/regionlist.html)
883
+ * 可用区。参见 [可用区列表](https://docs.ucloud.cn/api/summary/regionlist)
799
884
  */
800
885
  Zone?: string;
801
886
  /**
@@ -838,6 +923,22 @@ export interface CreateUDBInstanceByRecoveryRequest {
838
923
  * 是否创建使用ipv6 资源, 默认为false, 或者不填, 创建ipv6为true
839
924
  */
840
925
  EnableIpV6?: boolean;
926
+ /**
927
+ * 指定需要恢复的表, 如果指定该字段则回档实例只有指定的表数据,格式为(库名.表名), 指定多个用逗号隔开,eg: [ udb.test, mysql_school.my_student]
928
+ */
929
+ Tables?: string;
930
+ /**
931
+ * 管理员密码 (指定库表回档到新实例时有效)
932
+ */
933
+ AdminPassword?: string;
934
+ /**
935
+ * 实例计算规格类型,0或不传代表使用内存方式购买,1代表使用内存-cpu可选配比方式购买,需要填写MachineType
936
+ */
937
+ SpecificationType?: number;
938
+ /**
939
+ * 规格类型ID,当SpecificationType为1时有效
940
+ */
941
+ MachineType?: string;
841
942
  /**
842
943
  * 使用的代金券id
843
944
  */
@@ -852,6 +953,145 @@ export interface CreateUDBInstanceByRecoveryResponse {
852
953
  */
853
954
  DBId?: string;
854
955
  }
956
+ /**
957
+ * CreateUDBMySQLInstance - 创建UDB实例(包括创建mysql NVMe、共享型和O2实例以及从备份恢复实例)
958
+ */
959
+ export interface CreateUDBMySQLInstanceRequest {
960
+ /**
961
+ * 可用区。参见 [可用区列表](https://docs.ucloud.cn/api/summary/regionlist)
962
+ */
963
+ Zone: string;
964
+ /**
965
+ * 实例名称,至少6位
966
+ */
967
+ Name: string;
968
+ /**
969
+ * 管理员密码
970
+ */
971
+ AdminPassword: string;
972
+ /**
973
+ * DB类型,mysql按版本细分 mysql-8.4, mysql-8.0, mysql-5.7, percona-5.7, mysql-5.6, percona-5.6、mysql-5.5
974
+ */
975
+ DBTypeId: string;
976
+ /**
977
+ * 端口号,mysql默认3306
978
+ */
979
+ Port: number;
980
+ /**
981
+ * 磁盘空间(GB), 暂时支持20G - 32T
982
+ */
983
+ DiskSpace: number;
984
+ /**
985
+ * DB实例使用的配置参数组id
986
+ */
987
+ ParamGroupId: number;
988
+ /**
989
+ * 规格类型 ID,请通过 ListUDBMachineType 接口获取,返回体中的ID字段为MachineType的值。
990
+ */
991
+ MachineType: string;
992
+ /**
993
+ * 存储类型 CLOUD_RSSD: RSSD 云盘, CLOUD_SSD_ESSENTIAL: SSD Essential云盘 ,该字段和SpecificationClass组合使用,CLOUD_RSSD对应O型,CLOUD_SSD_ESSENTIAL对应OM型(北京2、乌兰察布支持),注:圣保罗、丹佛、哈萨克斯坦地域仅支持O2机型,CLOUD_RSSD对应O2型
994
+ */
995
+ StorageClass: string;
996
+ /**
997
+ * 规格类型 O: NVMe型, O2: O2 ,OM: 共享型
998
+ */
999
+ SpecificationClass: string;
1000
+ /**
1001
+ * Year, Month, Dynamic,Trial,默认: Month
1002
+ */
1003
+ ChargeType?: string;
1004
+ /**
1005
+ * 购买时长,默认值1
1006
+ */
1007
+ Quantity?: number;
1008
+ /**
1009
+ * 备份策略,每周备份数量,默认7次
1010
+ */
1011
+ BackupCount?: number;
1012
+ /**
1013
+ * 备份策略,备份开始时间,单位小时计,默认1点
1014
+ */
1015
+ BackupTime?: number;
1016
+ /**
1017
+ * 备份策略,备份时间间隔,单位小时计,默认24小时
1018
+ */
1019
+ BackupDuration?: number;
1020
+ /**
1021
+ * 备份id,如果指定,则表明从备份恢复实例
1022
+ */
1023
+ BackupId?: number;
1024
+ /**
1025
+ * UDB实例模式类型, 可选值如下: "Normal": 普通版UDB实例 "HA": 高可用版UDB实例 默认是"Normal"
1026
+ */
1027
+ InstanceMode?: string;
1028
+ /**
1029
+ * 跨可用区高可用备库所在可用区,参见 [可用区列表](https://docs.ucloud.cn/api/summary/regionlist)
1030
+ */
1031
+ BackupZone?: string;
1032
+ /**
1033
+ * 子网ID
1034
+ */
1035
+ SubnetId?: string;
1036
+ /**
1037
+ * VPC的ID
1038
+ */
1039
+ VPCId?: string;
1040
+ /**
1041
+ * 是否开启异步高可用,默认不填,可置为true
1042
+ */
1043
+ DisableSemisync?: boolean;
1044
+ /**
1045
+ * 实例所在的业务组名称
1046
+ */
1047
+ Tag?: string;
1048
+ /**
1049
+ * MySQL 小版本号,支持指定小版本进行创建,请通过 DescribeUDBType 接口获取可用版本。
1050
+ */
1051
+ DBSubVersion?: string;
1052
+ /**
1053
+ * mysql大小写参数, 0 为大小写敏感, 1 为大小写不敏感, 目前只针对mysql8.0有效
1054
+ */
1055
+ CaseSensitivityParam?: number;
1056
+ /**
1057
+ * 告警模版id
1058
+ */
1059
+ AlarmTemplateId?: string;
1060
+ /**
1061
+ * 备份文件的US3内网下载地址
1062
+ */
1063
+ BackupURL?: string;
1064
+ /**
1065
+ * 半同步开启开关 1:表示开启半同步,2:表示关闭半同步,0:表示默认值,默认也是开启半同步
1066
+ */
1067
+ SemisyncFlag?: number;
1068
+ /**
1069
+ *
1070
+ */
1071
+ Labels?: {
1072
+ /**
1073
+ * 用户资源标签的键值
1074
+ */
1075
+ Key?: string;
1076
+ /**
1077
+ * 用户资源标签值
1078
+ */
1079
+ Value?: string;
1080
+ }[];
1081
+ /**
1082
+ * 使用的代金券id
1083
+ */
1084
+ CouponId?: string;
1085
+ }
1086
+ /**
1087
+ * CreateUDBMySQLInstance - 创建UDB实例(包括创建mysql NVMe、共享型和O2实例以及从备份恢复实例)
1088
+ */
1089
+ export interface CreateUDBMySQLInstanceResponse {
1090
+ /**
1091
+ * BD实例id
1092
+ */
1093
+ DBId?: string;
1094
+ }
855
1095
  /**
856
1096
  * CreateUDBParamGroup - 从已有配置文件创建新配置文件
857
1097
  */
@@ -895,7 +1135,7 @@ export interface CreateUDBParamGroupResponse {
895
1135
  */
896
1136
  export interface CreateUDBReplicationInstanceRequest {
897
1137
  /**
898
- * 可用区。参见 [可用区列表](../summary/regionlist.html)
1138
+ * 可用区。参见 [可用区列表](https://docs.ucloud.cn/api/summary/regionlist)
899
1139
  */
900
1140
  Zone?: string;
901
1141
  /**
@@ -915,9 +1155,21 @@ export interface CreateUDBReplicationInstanceRequest {
915
1155
  */
916
1156
  IsArbiter?: boolean;
917
1157
  /**
918
- * 是否使用SSD,默认 为 true
1158
+ * 是否使用SSD,默认为true。目前主要可用区、海外机房、新机房只提供SSD资源,非SSD资源不再提供。
919
1159
  */
920
1160
  UseSSD?: boolean;
1161
+ /**
1162
+ * UDB数据库机型: "Normal": "标准机型" , "SATA_SSD": "SSD机型" , "PCIE_SSD": "SSD高性能机型" , "Normal_Volume": "标准大容量机型", "SATA_SSD_Volume": "SSD大容量机型" , "PCIE_SSD_Volume": "SSD高性能大容量机型", "NVMe_SSD": "快杰机型"
1163
+ */
1164
+ InstanceType?: string;
1165
+ /**
1166
+ * Year, Month, Dynamic,Trial,默认和主库保持一致
1167
+ */
1168
+ ChargeType?: string;
1169
+ /**
1170
+ * 购买时长,默认默认和主库保持一致
1171
+ */
1172
+ Quantity?: string;
921
1173
  /**
922
1174
  * 使用的代金券id
923
1175
  */
@@ -994,12 +1246,135 @@ export interface CreateUDBRouteInstanceResponse {
994
1246
  */
995
1247
  DBId?: string;
996
1248
  }
1249
+ /**
1250
+ * CreateUDBSQLServerInstance - 创建UDB实例(包括创建SQLServer实例以及从备份恢复实例)
1251
+ */
1252
+ export interface CreateUDBSQLServerInstanceRequest {
1253
+ /**
1254
+ * 可用区。参见 [可用区列表](https://docs.ucloud.cn/api/summary/regionlist)
1255
+ */
1256
+ Zone: string;
1257
+ /**
1258
+ * 实例名称,至少6位
1259
+ */
1260
+ Name: string;
1261
+ /**
1262
+ * 管理员密码
1263
+ */
1264
+ AdminPassword: string;
1265
+ /**
1266
+ * DB类型,SQL Server按版本细分 sqlserver-2017、sqlserver-2019、sqlserver-2022
1267
+ */
1268
+ DBTypeId: string;
1269
+ /**
1270
+ * 端口号,sqlserver默认1433
1271
+ */
1272
+ Port: number;
1273
+ /**
1274
+ * 磁盘空间(GB), 暂时支持20G - 32T
1275
+ */
1276
+ DiskSpace: number;
1277
+ /**
1278
+ * 存储类型 CLOUD_RSSD: RSSD 云盘,该字段和SpecificationClass组合使用,CLOUD_RSSD对应O型
1279
+ */
1280
+ StorageClass: string;
1281
+ /**
1282
+ * 规格类型 O: NVMe型
1283
+ */
1284
+ SpecificationClass: string;
1285
+ /**
1286
+ * UDB实例模式类型, 可选值如下: "Normal": SQL Server普通版实例 "HA": SQL Server集群版实例 默认是"Normal"
1287
+ */
1288
+ InstanceMode?: string;
1289
+ /**
1290
+ * 规格类型 ID,如果创建的是SQL Server集群版,该参数必填,请通过 ListUDBMachineType 接口获取,返回体中的ID字段为MachineType的值。
1291
+ */
1292
+ MachineType?: string;
1293
+ /**
1294
+ * CPU核,如果是创建的SQL Server普通版,该参数必传,目前支持2/4/8/16/32/64
1295
+ */
1296
+ CPU?: number;
1297
+ /**
1298
+ * 内存限制(MB),如果是创建的SQL Server普通版,该参数必传,目前支持以下几档 2000M/4000M/ 6000M/8000M/12000M/16000M/ 24000M/32000M/48000M/ 64000M/96000M/128000M/192000M/256000M/320000M
1299
+ */
1300
+ MemoryLimit?: number;
1301
+ /**
1302
+ * Year, Month, Dynamic,Trial,默认: Month
1303
+ */
1304
+ ChargeType?: string;
1305
+ /**
1306
+ * 购买时长,默认值1
1307
+ */
1308
+ Quantity?: number;
1309
+ /**
1310
+ * 备份策略,每周备份数量,默认7次
1311
+ */
1312
+ BackupCount?: number;
1313
+ /**
1314
+ * 备份策略,备份开始时间,单位小时计,默认1点
1315
+ */
1316
+ BackupTime?: number;
1317
+ /**
1318
+ * 备份策略,备份时间间隔,单位小时计,默认24小时
1319
+ */
1320
+ BackupDuration?: number;
1321
+ /**
1322
+ * 备份id,如果指定,则表明从备份恢复实例
1323
+ */
1324
+ BackupId?: number;
1325
+ /**
1326
+ * 子网ID,如果创建的是SQL Server集群版,该参数必填
1327
+ */
1328
+ SubnetId?: string;
1329
+ /**
1330
+ * VPC的ID,如果创建的是SQL Server集群版,该参数必填
1331
+ */
1332
+ VPCId?: string;
1333
+ /**
1334
+ * 实例所在的业务组名称
1335
+ */
1336
+ Tag?: string;
1337
+ /**
1338
+ * 告警模版id
1339
+ */
1340
+ AlarmTemplateId?: string;
1341
+ /**
1342
+ * 备份文件的US3内网下载地址
1343
+ */
1344
+ BackupURL?: string;
1345
+ /**
1346
+ *
1347
+ */
1348
+ Labels?: {
1349
+ /**
1350
+ * 用户资源标签的键值
1351
+ */
1352
+ Key?: string;
1353
+ /**
1354
+ * 用户资源标签值
1355
+ */
1356
+ Value?: string;
1357
+ }[];
1358
+ /**
1359
+ * 使用的代金券id
1360
+ */
1361
+ CouponId?: string;
1362
+ }
1363
+ /**
1364
+ * CreateUDBSQLServerInstance - 创建UDB实例(包括创建SQLServer实例以及从备份恢复实例)
1365
+ */
1366
+ export interface CreateUDBSQLServerInstanceResponse {
1367
+ /**
1368
+ * BD实例id
1369
+ */
1370
+ DBId?: string;
1371
+ }
997
1372
  /**
998
1373
  * CreateUDBSlave - 创建UDB实例的slave
999
1374
  */
1000
1375
  export interface CreateUDBSlaveRequest {
1001
1376
  /**
1002
- * 可用区。参见 [可用区列表](../summary/regionlist.html)
1377
+ * 可用区。参见 [可用区列表](https://docs.ucloud.cn/api/summary/regionlist)
1003
1378
  */
1004
1379
  Zone?: string;
1005
1380
  /**
@@ -1015,11 +1390,7 @@ export interface CreateUDBSlaveRequest {
1015
1390
  */
1016
1391
  Port?: number;
1017
1392
  /**
1018
- * 是否使用SSD,默认为true
1019
- */
1020
- UseSSD?: boolean;
1021
- /**
1022
- * SSD类型,可选值为"SATA"、"PCI-E"、“NVMe”,如果UseSSD为true ,则必选
1393
+ * 仅对主为SSD型实例有效。 可选值"SATA","NVMe"
1023
1394
  */
1024
1395
  SSDType?: string;
1025
1396
  /**
@@ -1027,21 +1398,13 @@ export interface CreateUDBSlaveRequest {
1027
1398
  */
1028
1399
  IsLock?: boolean;
1029
1400
  /**
1030
- * UDB实例部署模式,可选值如下:Normal: 普通单点实例HA: 高可用部署实例
1031
- */
1032
- InstanceMode?: string;
1033
- /**
1034
- * 内存限制(MB),目前支持以下几档 1000M/2000M/4000M/ 6000M/8000M/12000M/16000M/ 24000M/32000M/48000M/ 64000M/96000M/128000M/192000M/256000M/320000M
1401
+ * 内存限制(MB),目前支持以下几档 2000M/4000M/ 6000M/8000M/12000M/16000M/ 24000M/32000M/48000M/ 64000M/96000M/128000M/192000M/256000M/320000M
1035
1402
  */
1036
1403
  MemoryLimit?: number;
1037
1404
  /**
1038
1405
  * 磁盘空间(GB), 暂时支持20G - 3000G(API支持,前端暂时只开放内存定制)
1039
1406
  */
1040
1407
  DiskSpace?: number;
1041
- /**
1042
- * UDB实例类型:Normal、SATA_SSD、NVMe_SSD
1043
- */
1044
- InstanceType?: string;
1045
1408
  /**
1046
1409
  * 子网ID(如果不传用默认子网)
1047
1410
  */
@@ -1062,6 +1425,22 @@ export interface CreateUDBSlaveRequest {
1062
1425
  * DB实例使用的配置参数组id,默认和主库保持一致
1063
1426
  */
1064
1427
  ParamGroupId?: number;
1428
+ /**
1429
+ * 使用物理方式创建从库,目前仅限创建快杰从库,默认为false
1430
+ */
1431
+ IsCreatePhysically?: boolean;
1432
+ /**
1433
+ * 设置从库的延时复制时长(单位秒)
1434
+ */
1435
+ DelaySeconds?: number;
1436
+ /**
1437
+ * 实例计算规格类型,0或不传代表使用内存方式购买,1代表使用内存-cpu可选配比方式购买,需要填写MachineType
1438
+ */
1439
+ SpecificationType?: number;
1440
+ /**
1441
+ * 规格类型ID,当SpecificationType为1时有效
1442
+ */
1443
+ MachineType?: string;
1065
1444
  /**
1066
1445
  * 使用的代金券id
1067
1446
  */
@@ -1081,7 +1460,7 @@ export interface CreateUDBSlaveResponse {
1081
1460
  */
1082
1461
  export interface DeleteUDBInstanceRequest {
1083
1462
  /**
1084
- * 可用区。参见 [可用区列表](../summary/regionlist.html)
1463
+ * 可用区。参见 [可用区列表](https://docs.ucloud.cn/api/summary/regionlist)
1085
1464
  */
1086
1465
  Zone?: string;
1087
1466
  /**
@@ -1143,11 +1522,11 @@ export interface DeleteUDBParamGroupRequest {
1143
1522
  export interface DeleteUDBParamGroupResponse {
1144
1523
  }
1145
1524
  /**
1146
- * DescribeUDBBackup - 列表UDB实例备份信息
1525
+ * DescribeUDBBackup - 列表UDB实例备份信息.Zone不填表示多可用区,填代表单可用区
1147
1526
  */
1148
1527
  export interface DescribeUDBBackupRequest {
1149
1528
  /**
1150
- * 可用区。参见 [可用区列表](../summary/regionlist.html)
1529
+ * 可用区。参见 [可用区列表](https://docs.ucloud.cn/api/summary/regionlist)
1151
1530
  */
1152
1531
  Zone?: string;
1153
1532
  /**
@@ -1174,15 +1553,23 @@ export interface DescribeUDBBackupRequest {
1174
1553
  * 过滤条件:结束时间(Unix时间戳)
1175
1554
  */
1176
1555
  EndTime?: number;
1556
+ /**
1557
+ * 如果未指定GroupId,则可选是否选取特定DB类型的配置(sql, nosql, postgresql, sqlserver)
1558
+ */
1559
+ ClassType?: string;
1177
1560
  }
1178
1561
  /**
1179
- * DescribeUDBBackup - 列表UDB实例备份信息
1562
+ * DescribeUDBBackup - 列表UDB实例备份信息.Zone不填表示多可用区,填代表单可用区
1180
1563
  */
1181
1564
  export interface DescribeUDBBackupResponse {
1182
1565
  /**
1183
1566
  * 备份信息 参照UDBBackupSet
1184
1567
  */
1185
1568
  DataSet?: {
1569
+ /**
1570
+ * 备份所在可用区
1571
+ */
1572
+ Zone?: string;
1186
1573
  /**
1187
1574
  * 备份id
1188
1575
  */
@@ -1207,6 +1594,10 @@ export interface DescribeUDBBackupResponse {
1207
1594
  * 备份状态 Backuping // 备份中 Success // 备份成功 Failed // 备份失败 Expired // 备份过期
1208
1595
  */
1209
1596
  State?: string;
1597
+ /**
1598
+ * 备份错误信息
1599
+ */
1600
+ ErrorInfo?: string;
1210
1601
  /**
1211
1602
  * dbid
1212
1603
  */
@@ -1215,10 +1606,6 @@ export interface DescribeUDBBackupResponse {
1215
1606
  * 对应的db名称
1216
1607
  */
1217
1608
  DBName?: string;
1218
- /**
1219
- * 备份所在可用区
1220
- */
1221
- Zone?: string;
1222
1609
  /**
1223
1610
  * 跨机房高可用备库所在可用区
1224
1611
  */
@@ -1227,6 +1614,10 @@ export interface DescribeUDBBackupResponse {
1227
1614
  * 备份完成时间(Unix时间戳)
1228
1615
  */
1229
1616
  BackupEndTime?: number;
1617
+ /**
1618
+ * 备份文件的MD5值,备份完成后显示,备份中或备份失败时为空,目前只支持Mysql NVMe机型与Mongo
1619
+ */
1620
+ MD5?: string;
1230
1621
  }[];
1231
1622
  /**
1232
1623
  * 满足条件备份总数,如果指定dbid,则是该db备份总数
@@ -1256,11 +1647,94 @@ export interface DescribeUDBBackupBlacklistResponse {
1256
1647
  Blacklist?: string;
1257
1648
  }
1258
1649
  /**
1259
- * DescribeUDBBinlogBackupURL - 获取UDBBinlog备份地址
1650
+ * DescribeUDBBinlogBackup - 列表UDB实例Binlog自动备份信息
1651
+ */
1652
+ export interface DescribeUDBBinlogBackupRequest {
1653
+ /**
1654
+ * 可用区。参见 [可用区列表](https://docs.ucloud.cn/api/summary/regionlist)
1655
+ */
1656
+ Zone?: string;
1657
+ /**
1658
+ * 分页显示的起始偏移,列表操作则指定
1659
+ */
1660
+ Offset: number;
1661
+ /**
1662
+ * 分页显示的条目数,列表操作则指定
1663
+ */
1664
+ Limit: number;
1665
+ /**
1666
+ * DB实例Id,如果指定,则只获取该db的备份信息; 当Type为2时必填
1667
+ */
1668
+ DBId?: string;
1669
+ /**
1670
+ * 过滤条件:起始时间(时间戳)
1671
+ */
1672
+ BeginTime?: number;
1673
+ /**
1674
+ * 过滤条件:结束时间(时间戳)
1675
+ */
1676
+ EndTime?: number;
1677
+ }
1678
+ /**
1679
+ * DescribeUDBBinlogBackup - 列表UDB实例Binlog自动备份信息
1680
+ */
1681
+ export interface DescribeUDBBinlogBackupResponse {
1682
+ /**
1683
+ * Binlog备份信息 参见BinlogBackupSet
1684
+ */
1685
+ DataSet?: {
1686
+ /**
1687
+ * 备份id
1688
+ */
1689
+ BackupId?: number;
1690
+ /**
1691
+ * 备份名称
1692
+ */
1693
+ BackupName?: string;
1694
+ /**
1695
+ * 备份时间
1696
+ */
1697
+ BackupTime?: number;
1698
+ /**
1699
+ * 备份文件大小
1700
+ */
1701
+ BackupSize?: number;
1702
+ /**
1703
+ * 备份状态 Backuping // 备份中 Success // 备份成功 Failed // 备份失败 Expired // 备份过期
1704
+ */
1705
+ State?: string;
1706
+ /**
1707
+ * binlog备份类型 Manual:手动备份 ,Auto:自动备份
1708
+ */
1709
+ BinlogType?: string;
1710
+ /**
1711
+ * dbid
1712
+ */
1713
+ DBId?: string;
1714
+ /**
1715
+ * 节点标识ID
1716
+ */
1717
+ ServerId?: string;
1718
+ /**
1719
+ * 日志开始时间
1720
+ */
1721
+ LogStartTime?: number;
1722
+ /**
1723
+ * 日志结束时间
1724
+ */
1725
+ LogEndTime?: number;
1726
+ }[];
1727
+ /**
1728
+ * 备份总数,如果指定dbid,则是该db备份总数
1729
+ */
1730
+ TotalCount?: number;
1731
+ }
1732
+ /**
1733
+ * DescribeUDBBinlogBackupURL - 获取UDB的Binlog或者错误日志或者慢查询日志的备份地址
1260
1734
  */
1261
1735
  export interface DescribeUDBBinlogBackupURLRequest {
1262
1736
  /**
1263
- * 可用区。参见 [可用区列表](../summary/regionlist.html)
1737
+ * 可用区。参见 [可用区列表](https://docs.ucloud.cn/api/summary/regionlist)
1264
1738
  */
1265
1739
  Zone?: string;
1266
1740
  /**
@@ -1268,12 +1742,16 @@ export interface DescribeUDBBinlogBackupURLRequest {
1268
1742
  */
1269
1743
  DBId: string;
1270
1744
  /**
1271
- * DB实例binlog备份ID,可以从DescribeUDBLogPackage结果当中获得
1745
+ * DB实例日志备份ID,可以从DescribeUDBLogPackage结果当中获得
1272
1746
  */
1273
1747
  BackupId: number;
1748
+ /**
1749
+ * binlog备份类型 Manual:手动备份 ,Auto:自动备份
1750
+ */
1751
+ BinlogType: string;
1274
1752
  }
1275
1753
  /**
1276
- * DescribeUDBBinlogBackupURL - 获取UDB的Binlog备份地址
1754
+ * DescribeUDBBinlogBackupURL - 获取UDB的Binlog或者错误日志或者慢查询日志的备份地址
1277
1755
  */
1278
1756
  export interface DescribeUDBBinlogBackupURLResponse {
1279
1757
  /**
@@ -1290,7 +1768,7 @@ export interface DescribeUDBBinlogBackupURLResponse {
1290
1768
  */
1291
1769
  export interface DescribeUDBInstanceRequest {
1292
1770
  /**
1293
- * 可用区,不填时默认全部可用区。参见 [可用区列表](../summary/regionlist.html)
1771
+ * 可用区,不填时默认全部可用区。参见 [可用区列表](https://docs.ucloud.cn/api/summary/regionlist)
1294
1772
  */
1295
1773
  Zone?: string;
1296
1774
  /**
@@ -1321,6 +1799,14 @@ export interface DescribeUDBInstanceRequest {
1321
1799
  * 当只获取这个特定DBId的信息时,如果有该选项,那么把这个DBId实例的所有从库信息一起拉取并返回
1322
1800
  */
1323
1801
  IncludeSlaves?: boolean;
1802
+ /**
1803
+ * 根据VPCId筛选DB
1804
+ */
1805
+ VPCId?: string;
1806
+ /**
1807
+ * 根据 业务组 筛选DB
1808
+ */
1809
+ Tag?: string;
1324
1810
  }
1325
1811
  /**
1326
1812
  * DescribeUDBInstance - 获取UDB实例信息,支持两类操作:(1)指定DBId用于获取该db的信息;(2)指定ClassType、Offset、Limit用于列表操作,查询某一个类型db。
@@ -1334,6 +1820,10 @@ export interface DescribeUDBInstanceResponse {
1334
1820
  * DB实例所在可用区
1335
1821
  */
1336
1822
  Zone?: string;
1823
+ /**
1824
+ * 0区分大小写, 1不分区
1825
+ */
1826
+ CaseSensitivityParam?: number;
1337
1827
  /**
1338
1828
  * 当DB类型为mongodb时,返回该实例所在集群中的角色,包括:mongos、configsrv_sccc、configsrv_csrs、shardsrv_datanode、shardsrv_arbiter,其中congfigsrv分为sccc和csrs两种模式,shardsrv分为datanode和arbiter两种模式
1339
1829
  */
@@ -1379,7 +1869,7 @@ export interface DescribeUDBInstanceResponse {
1379
1869
  */
1380
1870
  InstanceType?: string;
1381
1871
  /**
1382
- * UDB数据库机型ID
1872
+ * UDB数据库机型ID (已弃用)
1383
1873
  */
1384
1874
  InstanceTypeId?: number;
1385
1875
  /**
@@ -1411,7 +1901,7 @@ export interface DescribeUDBInstanceResponse {
1411
1901
  */
1412
1902
  BackupBlacklist?: string;
1413
1903
  /**
1414
- * DB状态标记 Init:初始化中,Fail:安装失败,Starting:启动中,Running:运行,Shutdown:关闭中,Shutoff:已关闭,Delete:已删除,Upgrading:升级中,Promoting:提升为独库进行中,Recovering:恢复中,Recover fail:恢复失败
1904
+ * DB状态标记 Init:初始化中,Fail:安装失败,Starting:启动中,Running:运行,Shutdown:关闭中,Shutoff:已关闭,Delete:已删除,Upgrading:升级中,Promoting:提升为独库进行中,Recovering:恢复中,Recover fail:恢复失败, Remakeing:重做中,RemakeFail:重做失败,VersionUpgrading:小版本升级中,VersionUpgradeWaitForSwitch:高可用等待切换,VersionUpgradeFail:小版本升级失败,UpdatingSSL:修改SSL中,UpdateSSLFail:修改SSL失败,MajorVersionUpgrading:小版本升级中,MajorVersionUpgradeWaitForSwitch:高可用等待切换,MajorVersionUpgradeFail
1415
1905
  */
1416
1906
  State?: string;
1417
1907
  /**
@@ -1482,6 +1972,10 @@ export interface DescribeUDBInstanceResponse {
1482
1972
  * 可用区
1483
1973
  */
1484
1974
  Zone?: string;
1975
+ /**
1976
+ * 延时从库时长
1977
+ */
1978
+ ReplicationDelaySeconds?: number;
1485
1979
  /**
1486
1980
  * DB实例id
1487
1981
  */
@@ -1535,7 +2029,7 @@ export interface DescribeUDBInstanceResponse {
1535
2029
  */
1536
2030
  BackupBlacklist?: string;
1537
2031
  /**
1538
- * DB状态标记 Init:初始化中,Fail:安装失败,Starting:启动中,Running:运行,Shutdown:关闭中,Shutoff:已关闭,Delete:已删除,Upgrading:升级中,Promoting:提升为独库进行中,Recovering:恢复中,Recover fail:恢复失败
2032
+ * DB状态标记 Init:初始化中,Fail:安装失败,Starting:启动中,Running:运行,Shutdown:关闭中,Shutoff:已关闭,Delete:已删除,Upgrading:升级中,Promoting:提升为独库进行中,Recovering:恢复中,Recover fail:恢复失败,Remakeing:重做中,RemakeFail:重做失败, MajorVersionUpgrading:小版本升级中,MajorVersionUpgradeWaitForSwitch:高可用等待切换,MajorVersionUpgradeFail
1539
2033
  */
1540
2034
  State?: string;
1541
2035
  /**
@@ -1623,9 +2117,17 @@ export interface DescribeUDBInstanceResponse {
1623
2117
  */
1624
2118
  Tag?: string;
1625
2119
  /**
1626
- * 获取该实例的IPv6地址
2120
+ * 0 区分大小写, 1不区分, 只针对mysql8.0
2121
+ */
2122
+ CaseSensitivityParam?: number;
2123
+ /**
2124
+ * 实例计算规格类型,0或不传代表使用内存方式购买,1代表使用内存-cpu可选配比方式购买,需要填写MachineType
2125
+ */
2126
+ SpecificationType?: number;
2127
+ /**
2128
+ * 规格类型ID,当SpecificationType为1时有效
1627
2129
  */
1628
- IPv6Address?: string;
2130
+ MachineType?: string;
1629
2131
  }[];
1630
2132
  /**
1631
2133
  * 跨可用区高可用备库所在可用区
@@ -1648,6 +2150,34 @@ export interface DescribeUDBInstanceResponse {
1648
2150
  */
1649
2151
  Bucket?: string;
1650
2152
  };
2153
+ /**
2154
+ * mysql实例提供具体小版本信息
2155
+ */
2156
+ DBSubVersion?: string;
2157
+ /**
2158
+ * mysql是否开启了SSL;1->未开启 2->开启
2159
+ */
2160
+ EnableSSL?: number;
2161
+ /**
2162
+ * SSL到期时间
2163
+ */
2164
+ SSLExpirationTime?: number;
2165
+ /**
2166
+ * 默认的备份方式,nobackup表示不备份, snapshot 表示使用快照备份,logic 表示使用逻辑备份,xtrabackup表示使用物理备份。
2167
+ */
2168
+ BackupMethod?: string;
2169
+ /**
2170
+ * 数据库机型规格
2171
+ */
2172
+ MachineType?: string;
2173
+ /**
2174
+ * 是否使用可选cpu类型规格
2175
+ */
2176
+ SpecificationType?: number;
2177
+ /**
2178
+ * CPU核数
2179
+ */
2180
+ CPU?: number;
1651
2181
  }[];
1652
2182
  /**
1653
2183
  * 用户db组的数量,对于 mysql: 主从结对数量,没有slave,则只有master mongodb: 副本集数量
@@ -1685,7 +2215,7 @@ export interface DescribeUDBInstanceBackupStateResponse {
1685
2215
  */
1686
2216
  export interface DescribeUDBInstanceBackupURLRequest {
1687
2217
  /**
1688
- * 可用区。参见 [可用区列表](../summary/regionlist.html)
2218
+ * 可用区。参见 [可用区列表](https://docs.ucloud.cn/api/summary/regionlist)
1689
2219
  */
1690
2220
  Zone?: string;
1691
2221
  /**
@@ -1696,6 +2226,10 @@ export interface DescribeUDBInstanceBackupURLRequest {
1696
2226
  * DB实例备份ID,该值可以通过DescribeUDBBackup获取
1697
2227
  */
1698
2228
  BackupId: number;
2229
+ /**
2230
+ * DB响应中URL的过期时间,该值最小默认4小时,最大7天。不填默认为四小时。(单位/秒)
2231
+ */
2232
+ ValidTime?: number;
1699
2233
  }
1700
2234
  /**
1701
2235
  * DescribeUDBInstanceBackupURL - 获取UDB备份下载地址
@@ -1709,6 +2243,10 @@ export interface DescribeUDBInstanceBackupURLResponse {
1709
2243
  * DB实例备份文件内网的地址
1710
2244
  */
1711
2245
  InnerBackupPath?: string;
2246
+ /**
2247
+ * 备份文件的md5值
2248
+ */
2249
+ MD5?: string;
1712
2250
  }
1713
2251
  /**
1714
2252
  * DescribeUDBInstanceBinlog - 获取UDB指定时间段的binlog列表
@@ -1826,11 +2364,11 @@ export interface DescribeUDBInstanceLogResponse {
1826
2364
  */
1827
2365
  export interface DescribeUDBInstancePriceRequest {
1828
2366
  /**
1829
- * 可用区。参见 [可用区列表](../summary/regionlist.html)
2367
+ * 可用区。参见 [可用区列表](https://docs.ucloud.cn/api/summary/regionlist)
1830
2368
  */
1831
2369
  Zone: string;
1832
2370
  /**
1833
- * 内存限制(MB),单位为MB.目前支持:1000-96000
2371
+ * 内存限制(MB),单位为MB.目前支持:2000-96000
1834
2372
  */
1835
2373
  MemoryLimit: number;
1836
2374
  /**
@@ -1846,25 +2384,45 @@ export interface DescribeUDBInstancePriceRequest {
1846
2384
  */
1847
2385
  Count?: number;
1848
2386
  /**
1849
- * Year,按年付费; Month,按月付费 Dynamic,按需付费(需开启权限) Trial,试用(需开启权限)默认为月付
2387
+ * Year,按年付费; Month,按月付费 Dynamic,按需付费(需开启权限) Trial,试用(需开启权限)默认为月付
2388
+ */
2389
+ ChargeType?: string;
2390
+ /**
2391
+ * DB购买多少个"计费时间单位",默认值为1。比如:买2个月,Quantity就是2。如果计费单位是“按月”,并且Quantity为0,表示“购买到月底”
2392
+ */
2393
+ Quantity?: number;
2394
+ /**
2395
+ * 该字段已废弃。
2396
+ */
2397
+ SSDType?: string;
2398
+ /**
2399
+ * 实例的部署类型。可选值为:Normal: 普通单点实例,Slave: 从库实例,HA: 高可用部署实例,默认是Normal
2400
+ */
2401
+ InstanceMode?: string;
2402
+ /**
2403
+ * CPU个数,如果db类型为sqlserver,则为必填参数
2404
+ */
2405
+ CPU?: number;
2406
+ /**
2407
+ * 对于快杰机型,请使用最新的 SpecificationClass 和 StorageClass 字段进行创建。目前仅有少量地域支持 SATA_SSD 存储类型;若创建的是 SATA_SSD 机型,可通过该字段指定。字段说明:SATA_SSD:SATA SSD 机型(仅部分地域支持)NVMe_SSD:快杰机型
1850
2408
  */
1851
- ChargeType?: string;
2409
+ InstanceType?: string;
1852
2410
  /**
1853
- * DB购买多少个"计费时间单位",默认值为1。比如:买2个月,Quantity就是2。如果计费单位是“按月”,并且Quantity为0,表示“购买到月底”
2411
+ * 实例计算规格类型,0或不传代表使用内存方式购买,1代表使用内存-cpu可选配比方式购买,需要填写MachineType
1854
2412
  */
1855
- Quantity?: number;
2413
+ SpecificationType?: number;
1856
2414
  /**
1857
- * 是否使用SSD,只能填true或false,默认为false
2415
+ * 规格类型ID,当SpecificationType为1时有效
1858
2416
  */
1859
- UseSSD?: string;
2417
+ MachineType?: string;
1860
2418
  /**
1861
- * SSD类型,可选值为"SATA"、"PCI-E",如果UseSSD为true ,则必填
2419
+ * 存储类型 CLOUD_SSD: SSD云盘, CLOUD_RSSD: RSSD 云盘, CLOUD_SSD_ESSENTIAL: SSD Essential云盘 ,该字段和SpecificationClass组合优先级比InstanceType字段高
1862
2420
  */
1863
- SSDType?: string;
2421
+ StorageClass?: string;
1864
2422
  /**
1865
- * 实例的部署类型。可选值为:Normal: 普通单点实例,Slave: 从库实例,HA: 高可用部署实例,默认是Normal
2423
+ * 规格类型 O: NVME, OM: 共享型,N: 通用型
1866
2424
  */
1867
- InstanceMode?: string;
2425
+ SpecificationClass?: string;
1868
2426
  }
1869
2427
  /**
1870
2428
  * DescribeUDBInstancePrice - 获取UDB实例价格信息
@@ -1889,7 +2447,7 @@ export interface DescribeUDBInstancePriceResponse {
1889
2447
  */
1890
2448
  export interface DescribeUDBInstanceStateRequest {
1891
2449
  /**
1892
- * 可用区。参见 [可用区列表](../summary/regionlist.html)
2450
+ * 可用区。参见 [可用区列表](https://docs.ucloud.cn/api/summary/regionlist)
1893
2451
  */
1894
2452
  Zone?: string;
1895
2453
  /**
@@ -1911,7 +2469,7 @@ export interface DescribeUDBInstanceStateResponse {
1911
2469
  */
1912
2470
  export interface DescribeUDBInstanceUpgradePriceRequest {
1913
2471
  /**
1914
- * 可用区。参见 [可用区列表](../summary/regionlist.html)
2472
+ * 可用区。参见 [可用区列表](https://docs.ucloud.cn/api/summary/regionlist)
1915
2473
  */
1916
2474
  Zone?: string;
1917
2475
  /**
@@ -1927,13 +2485,29 @@ export interface DescribeUDBInstanceUpgradePriceRequest {
1927
2485
  */
1928
2486
  DiskSpace: number;
1929
2487
  /**
1930
- * 是否使用SSD,默认为false
2488
+ * "SATA", "NVMe"
1931
2489
  */
1932
- UseSSD?: boolean;
2490
+ SSDType?: string;
1933
2491
  /**
1934
- * SSD类型,可选值为"SATA""PCI-E",如果UseSSD为true ,则必选
2492
+ * "SATA_SSD", "NVMe_SSD"
1935
2493
  */
1936
- SSDType?: string;
2494
+ InstanceType?: string;
2495
+ /**
2496
+ * 获取指定时间开始后面的升级价格, 不填的话 是默认当前时间
2497
+ */
2498
+ OrderStartTime?: number;
2499
+ /**
2500
+ * CPU核数 快杰SQLServer升降级必传
2501
+ */
2502
+ CPU?: number;
2503
+ /**
2504
+ * 规格类型ID,当SpecificationType为1时有效
2505
+ */
2506
+ MachineType?: string;
2507
+ /**
2508
+ * 实例计算规格类型,0或不传代表使用内存方式购买,1代表使用内存-cpu可选配比方式购买,需要填写MachineType
2509
+ */
2510
+ SpecificationType?: number;
1937
2511
  }
1938
2512
  /**
1939
2513
  * DescribeUDBInstanceUpgradePrice - 获取UDB实例升降级价格信息
@@ -1945,7 +2519,7 @@ export interface DescribeUDBInstanceUpgradePriceResponse {
1945
2519
  Price?: number;
1946
2520
  }
1947
2521
  /**
1948
- * DescribeUDBLogBackupURL - 获取UDB的slowlog备份地址
2522
+ * DescribeUDBLogBackupURL - 获取UDB的错误日志或者慢查询日志备份地址
1949
2523
  */
1950
2524
  export interface DescribeUDBLogBackupURLRequest {
1951
2525
  /**
@@ -1957,12 +2531,12 @@ export interface DescribeUDBLogBackupURLRequest {
1957
2531
  */
1958
2532
  DBId: string;
1959
2533
  /**
1960
- * DB实例备份ID
2534
+ * DB实例日志备份ID, 可以从DescribeUDBLogPackage结果当中获得。
1961
2535
  */
1962
2536
  BackupId: number;
1963
2537
  }
1964
2538
  /**
1965
- * DescribeUDBLogBackupURL - 获取UDB的slowlog备份地址
2539
+ * DescribeUDBLogBackupURL - 获取UDB的错误日志或者慢查询日志备份地址
1966
2540
  */
1967
2541
  export interface DescribeUDBLogBackupURLResponse {
1968
2542
  /**
@@ -1979,7 +2553,7 @@ export interface DescribeUDBLogBackupURLResponse {
1979
2553
  */
1980
2554
  export interface DescribeUDBLogPackageRequest {
1981
2555
  /**
1982
- * 可用区。参见 [可用区列表](../summary/regionlist.html)
2556
+ * 可用区。参见 [可用区列表](https://docs.ucloud.cn/api/summary/regionlist)
1983
2557
  */
1984
2558
  Zone?: string;
1985
2559
  /**
@@ -1991,7 +2565,7 @@ export interface DescribeUDBLogPackageRequest {
1991
2565
  */
1992
2566
  Limit: number;
1993
2567
  /**
1994
- * 需要列出的备份文件类型,每种文件的值如下 2 : BINLOG\_BACKUP 3 : SLOW\_QUERY\_BACKUP 4 : ERRORLOG\_BACKUP
2568
+ * 需要列出的备份文件类型,每种类型的值如下: 2 代表 BINLOG_BACKUP; 3 代表 SLOW_QUERY_BACKUP; 4 代表 ERRORLOG_BACKUP;
1995
2569
  */
1996
2570
  Type?: number;
1997
2571
  /**
@@ -1999,7 +2573,7 @@ export interface DescribeUDBLogPackageRequest {
1999
2573
  */
2000
2574
  Types?: number[];
2001
2575
  /**
2002
- * DB实例Id,如果指定,则只获取该db的备份信息
2576
+ * DB实例Id,如果指定,则只获取该db的备份信息; 当Type为2时必填
2003
2577
  */
2004
2578
  DBId?: string;
2005
2579
  /**
@@ -2019,6 +2593,10 @@ export interface DescribeUDBLogPackageResponse {
2019
2593
  * 备份信息 参见LogPackageDataSet
2020
2594
  */
2021
2595
  DataSet?: {
2596
+ /**
2597
+ * 所在可用区
2598
+ */
2599
+ Zone?: string;
2022
2600
  /**
2023
2601
  * 备份id
2024
2602
  */
@@ -2039,6 +2617,10 @@ export interface DescribeUDBLogPackageResponse {
2039
2617
  * 备份类型,包括2-binlog备份,3-slowlog备份
2040
2618
  */
2041
2619
  BackupType?: number;
2620
+ /**
2621
+ * binlog备份类型 Manual //手动备份 Auto //自动备份
2622
+ */
2623
+ BinlogType?: string;
2042
2624
  /**
2043
2625
  * 备份状态 Backuping // 备份中 Success // 备份成功 Failed // 备份失败 Expired // 备份过期
2044
2626
  */
@@ -2051,10 +2633,6 @@ export interface DescribeUDBLogPackageResponse {
2051
2633
  * 对应的db名称
2052
2634
  */
2053
2635
  DBName?: string;
2054
- /**
2055
- * 所在可用区
2056
- */
2057
- Zone?: string;
2058
2636
  /**
2059
2637
  * 跨可用区高可用备库所在可用区
2060
2638
  */
@@ -2076,11 +2654,11 @@ export interface DescribeUDBParamGroupRequest {
2076
2654
  /**
2077
2655
  * 分页显示的起始偏移,列表操作则指定
2078
2656
  */
2079
- Offset?: number;
2657
+ Offset: number;
2080
2658
  /**
2081
2659
  * 分页显示的条目数,列表操作则指定
2082
2660
  */
2083
- Limit?: number;
2661
+ Limit: number;
2084
2662
  /**
2085
2663
  * 参数组id,如果指定则获取描述,否则是列表操作,需要 指定Offset/Limit
2086
2664
  */
@@ -2106,6 +2684,10 @@ export interface DescribeUDBParamGroupResponse {
2106
2684
  * 参数组列表 参照UDBParamGroupSet
2107
2685
  */
2108
2686
  DataSet?: {
2687
+ /**
2688
+ * 参数组类型:1:稳定版参数组,2:高性能版参数组。默认是稳定版参数组
2689
+ */
2690
+ GroupType?: number;
2109
2691
  /**
2110
2692
  * 参数组id
2111
2693
  */
@@ -2245,11 +2827,11 @@ export interface DescribeUDBSplittingInfoResponse {
2245
2827
  */
2246
2828
  export interface DescribeUDBTypeRequest {
2247
2829
  /**
2248
- * 可用区。参见 [可用区列表](../summary/regionlist.html)
2830
+ * 可用区。参见 [可用区列表](https://docs.ucloud.cn/api/summary/regionlist)
2249
2831
  */
2250
2832
  Zone: string;
2251
2833
  /**
2252
- * 跨可用区高可用DB的备库所在区域,仅当该可用区支持跨可用区高可用时填入。参见 [可用区列表](../summary/regionlist.html)
2834
+ * 跨可用区高可用DB的备库所在区域,仅当该可用区支持跨可用区高可用时填入。参见 [可用区列表](https://docs.ucloud.cn/api/summary/regionlist)
2253
2835
  */
2254
2836
  BackupZone?: string;
2255
2837
  /**
@@ -2268,6 +2850,10 @@ export interface DescribeUDBTypeRequest {
2268
2850
  * 返回从备份创建实例时,该版本号所支持的备份创建版本。如果没传,则表示不是从备份创建。
2269
2851
  */
2270
2852
  CompatibleWithDBType?: string;
2853
+ /**
2854
+ * 返回从备份创建实例时,该小版本号所支持的备份创建小版本。如果没传,则表示不是从备份创建。
2855
+ */
2856
+ DBSubVersion?: string;
2271
2857
  }
2272
2858
  /**
2273
2859
  * DescribeUDBType - 获取UDB支持的类型信息
@@ -2281,6 +2867,10 @@ export interface DescribeUDBTypeResponse {
2281
2867
  * DB类型id,mysql/mongodb按版本细分各有一个id, 目前id的取值范围为[1,7],数值对应的版本如下: 1:mysql-5.5,2:mysql-5.1,3:percona-5.5 4:mongodb-2.4,5:mongodb-2.6,6:mysql-5.6, 7:percona-5.6
2282
2868
  */
2283
2869
  DBTypeId?: string;
2870
+ /**
2871
+ * mysql子版本,如mysql-8.0.25,mysql-8.0.16
2872
+ */
2873
+ DBSubVersion?: string;
2284
2874
  }[];
2285
2875
  }
2286
2876
  /**
@@ -2288,7 +2878,7 @@ export interface DescribeUDBTypeResponse {
2288
2878
  */
2289
2879
  export interface DisableUDBRWSplittingRequest {
2290
2880
  /**
2291
- * 可用区。参见 [可用区列表](../summary/regionlist.html)
2881
+ * 可用区。参见 [可用区列表](https://docs.ucloud.cn/api/summary/regionlist)
2292
2882
  */
2293
2883
  Zone: string;
2294
2884
  /**
@@ -2384,7 +2974,7 @@ export interface ExtractUDBParamGroupResponse {
2384
2974
  */
2385
2975
  export interface FetchUDBInstanceEarliestRecoverTimeRequest {
2386
2976
  /**
2387
- * 可用区。参见 [可用区列表](../summary/regionlist.html)
2977
+ * 可用区。参见 [可用区列表](https://docs.ucloud.cn/api/summary/regionlist)
2388
2978
  */
2389
2979
  Zone?: string;
2390
2980
  /**
@@ -2432,12 +3022,158 @@ export interface GetUDBClientConnNumResponse {
2432
3022
  Num?: number;
2433
3023
  }[];
2434
3024
  }
3025
+ /**
3026
+ * GetUDBInstanceSSLCertURL - 获取SSL证书下载地址
3027
+ */
3028
+ export interface GetUDBInstanceSSLCertURLRequest {
3029
+ /**
3030
+ * 可用区。参见 [可用区列表](https://docs.ucloud.cn/api/summary/regionlist)
3031
+ */
3032
+ Zone: string;
3033
+ /**
3034
+ * 实例ID
3035
+ */
3036
+ DBId: string;
3037
+ /**
3038
+ * URL的过期时间,该值最小默认1小时,最大7天。(单位/秒)
3039
+ */
3040
+ ExpireTime?: number;
3041
+ }
3042
+ /**
3043
+ * GetUDBInstanceSSLCertURL - 获取SSL证书下载地址
3044
+ */
3045
+ export interface GetUDBInstanceSSLCertURLResponse {
3046
+ /**
3047
+ * 外网链接
3048
+ */
3049
+ InternetUrl: string;
3050
+ /**
3051
+ * 内网链接
3052
+ */
3053
+ InnerUrl: string;
3054
+ }
3055
+ /**
3056
+ * ListUDBMachineType - 获取UDB云数据库支持的计算规格列表,暂不支持获取跨可用区实例的计算规格,目前支持的数据库品类包括:NVMe版和SSD云盘版MySQL
3057
+ */
3058
+ export interface ListUDBMachineTypeRequest {
3059
+ /**
3060
+ * 可用区。参见 [可用区列表](https://docs.ucloud.cn/api/summary/regionlist)
3061
+ */
3062
+ Zone: string;
3063
+ /**
3064
+ * UDB实例模式类型, 可选值如下: "Normal": 普通版UDB实例 "HA": 高可用版UDB实例 默认是"Normal"
3065
+ */
3066
+ InstanceMode?: string;
3067
+ }
3068
+ /**
3069
+ * ListUDBMachineType - 获取UDB云数据库支持的计算规格列表,暂不支持获取跨可用区实例的计算规格,目前支持的数据库品类包括:NVMe版和SSD云盘版MySQL
3070
+ */
3071
+ export interface ListUDBMachineTypeResponse {
3072
+ /**
3073
+ * 计算规格列表
3074
+ */
3075
+ DataSet: {
3076
+ /**
3077
+ * 计算规格id, 目前支持CPU和内存比1:2、1:4、1:8三类配比规格;规格的格式为:"机型.配比.CPU核数规格";机型支持o和n两种机型,分别代表快杰NVMe和SSD云盘机型;配比映射关系如下:2m代表CPU内存配比1比2,4m代表CPU内存配比1比4,8m代表CPU内存配比1比8,CPU核数规格射关系如下:small代表1C,medium代表2C,xlarge代表4C,2xlarge代表8C,4xlarge代表16C,8xlarge代表32C,16xlarge代表64C,例如 "o.mysql4m.medium"表示创建快杰NVMe机型2C8G的实例,"o.mysql8m.4xlarge"表示创建快杰NVMe机型16C128G的实例
3078
+ */
3079
+ ID?: string;
3080
+ /**
3081
+ * 计算规格描述,格式为"nCmG",表示n核mG内存实例
3082
+ */
3083
+ Description?: string;
3084
+ /**
3085
+ * 规格cpu核数
3086
+ */
3087
+ Cpu?: number;
3088
+ /**
3089
+ * 规格内存大小,单位(GB)
3090
+ */
3091
+ Memory?: number;
3092
+ /**
3093
+ * 内部云主机机型,可选"o/n"
3094
+ */
3095
+ Os?: string;
3096
+ /**
3097
+ * 内存/cpu配比
3098
+ */
3099
+ Group?: string;
3100
+ }[];
3101
+ /**
3102
+ * 默认计算规格
3103
+ */
3104
+ DefaultMachineType: {
3105
+ /**
3106
+ * 计算规格id, 目前支持CPU和内存比1:2、1:4、1:8三类配比规格;规格的格式为:"机型.配比.CPU核数规格";机型支持o和n两种机型,分别代表快杰NVMe和SSD云盘机型;配比映射关系如下:2m代表CPU内存配比1比2,4m代表CPU内存配比1比4,8m代表CPU内存配比1比8,CPU核数规格射关系如下:small代表1C,medium代表2C,xlarge代表4C,2xlarge代表8C,4xlarge代表16C,8xlarge代表32C,16xlarge代表64C,例如 "o.mysql4m.medium"表示创建快杰NVMe机型2C8G的实例,"o.mysql8m.4xlarge"表示创建快杰NVMe机型16C128G的实例
3107
+ */
3108
+ ID?: string;
3109
+ /**
3110
+ * 计算规格描述,格式为"nCmG",表示n核mG内存实例
3111
+ */
3112
+ Description?: string;
3113
+ /**
3114
+ * 规格cpu核数
3115
+ */
3116
+ Cpu?: number;
3117
+ /**
3118
+ * 规格内存大小,单位(GB)
3119
+ */
3120
+ Memory?: number;
3121
+ /**
3122
+ * 内部云主机机型,可选"o/n"
3123
+ */
3124
+ Os?: string;
3125
+ /**
3126
+ * 内存/cpu配比
3127
+ */
3128
+ Group?: string;
3129
+ };
3130
+ }
3131
+ /**
3132
+ * ListUDBUserTables - 查看udb实例所有的用户表集合 (只包括引擎为innodb和myisam的表)
3133
+ */
3134
+ export interface ListUDBUserTablesRequest {
3135
+ /**
3136
+ * udb实例的ID
3137
+ */
3138
+ DBId: string;
3139
+ }
3140
+ /**
3141
+ * ListUDBUserTables - 查看udb实例所有的用户表集合 (只包括引擎为innodb和myisam的表)
3142
+ */
3143
+ export interface ListUDBUserTablesResponse {
3144
+ /**
3145
+ * 用户库表的集合
3146
+ */
3147
+ Tables: {
3148
+ /**
3149
+ * 数据库名称
3150
+ */
3151
+ DBName: string;
3152
+ /**
3153
+ * 该库所有的表集合
3154
+ */
3155
+ TableDataSet: {
3156
+ /**
3157
+ * 表名称
3158
+ */
3159
+ TableName: string;
3160
+ /**
3161
+ * 表所属的库名称
3162
+ */
3163
+ DBName: string;
3164
+ /**
3165
+ * 表的引擎(innodb, myisam)
3166
+ */
3167
+ Engine: string;
3168
+ }[];
3169
+ }[];
3170
+ }
2435
3171
  /**
2436
3172
  * ModifyUDBInstanceName - 重命名UDB实例
2437
3173
  */
2438
3174
  export interface ModifyUDBInstanceNameRequest {
2439
3175
  /**
2440
- * 可用区。参见 [可用区列表](../summary/regionlist.html)
3176
+ * 可用区。参见 [可用区列表](https://docs.ucloud.cn/api/summary/regionlist)
2441
3177
  */
2442
3178
  Zone?: string;
2443
3179
  /**
@@ -2459,7 +3195,7 @@ export interface ModifyUDBInstanceNameResponse {
2459
3195
  */
2460
3196
  export interface ModifyUDBInstancePasswordRequest {
2461
3197
  /**
2462
- * 可用区。参见 [可用区列表](../summary/regionlist.html)
3198
+ * 可用区。参见 [可用区列表](https://docs.ucloud.cn/api/summary/regionlist)
2463
3199
  */
2464
3200
  Zone?: string;
2465
3201
  /**
@@ -2480,6 +3216,54 @@ export interface ModifyUDBInstancePasswordRequest {
2480
3216
  */
2481
3217
  export interface ModifyUDBInstancePasswordResponse {
2482
3218
  }
3219
+ /**
3220
+ * ModifyUDBInstanceRemarkName - 修改UDB实例备注信息
3221
+ */
3222
+ export interface ModifyUDBInstanceRemarkNameRequest {
3223
+ /**
3224
+ * 可用区。参见 [可用区列表](https://docs.ucloud.cn/api/summary/regionlist)
3225
+ */
3226
+ Zone: string;
3227
+ /**
3228
+ * 实例的Id,该值可以通过DescribeUDBInstance获取
3229
+ */
3230
+ DBId: string;
3231
+ /**
3232
+ * 实例的新备注
3233
+ */
3234
+ Name: string;
3235
+ }
3236
+ /**
3237
+ * ModifyUDBInstanceRemarkName - 修改UDB实例备注信息
3238
+ */
3239
+ export interface ModifyUDBInstanceRemarkNameResponse {
3240
+ }
3241
+ /**
3242
+ * ModifyUDBInstanceSSL - 调整SSL的信息
3243
+ */
3244
+ export interface ModifyUDBInstanceSSLRequest {
3245
+ /**
3246
+ * 可用区。参见 [可用区列表](https://docs.ucloud.cn/api/summary/regionlist)
3247
+ */
3248
+ Zone: string;
3249
+ /**
3250
+ * 实例ID
3251
+ */
3252
+ DBId: string;
3253
+ /**
3254
+ * 是否开启SSL 1->关闭 2->开启
3255
+ */
3256
+ EnableSSL: number;
3257
+ /**
3258
+ * SSL证书有效时间,1-5年,默认为1年
3259
+ */
3260
+ ValidTime?: number;
3261
+ }
3262
+ /**
3263
+ * ModifyUDBInstanceSSL - 调整SSL的信息
3264
+ */
3265
+ export interface ModifyUDBInstanceSSLResponse {
3266
+ }
2483
3267
  /**
2484
3268
  * PromoteUDBInstanceToHA - 普通db升级为高可用(只针对mysql5.5及以上版本SSD机型的实例) ,对于NVMe机型的单点升级高可用,虽然也能使用该操作再加上SwitchUDBInstanceToHA,但是更建议直接调用新的API接口(UpgradeUDBInstanceToHA)
2485
3269
  */
@@ -2499,7 +3283,7 @@ export interface PromoteUDBInstanceToHAResponse {
2499
3283
  */
2500
3284
  export interface PromoteUDBSlaveRequest {
2501
3285
  /**
2502
- * 可用区。参见 [可用区列表](../summary/regionlist.html)
3286
+ * 可用区。参见 [可用区列表](https://docs.ucloud.cn/api/summary/regionlist)
2503
3287
  */
2504
3288
  Zone?: string;
2505
3289
  /**
@@ -2521,7 +3305,7 @@ export interface PromoteUDBSlaveResponse {
2521
3305
  */
2522
3306
  export interface ResizeUDBInstanceRequest {
2523
3307
  /**
2524
- * 可用区。参见 [可用区列表](../summary/regionlist.html)
3308
+ * 可用区。参见 [可用区列表](https://docs.ucloud.cn/api/summary/regionlist)
2525
3309
  */
2526
3310
  Zone?: string;
2527
3311
  /**
@@ -2529,7 +3313,7 @@ export interface ResizeUDBInstanceRequest {
2529
3313
  */
2530
3314
  DBId: string;
2531
3315
  /**
2532
- * 内存限制(MB),目前支持以下几档 1000M/2000M/4000M/ 6000M/8000M/ 12000M/16000M/ 24000M/32000M/ 48000M/64000M/96000M/128000M/192000M/256000M/320000M。
3316
+ * 内存限制(MB),目前支持以下几档 2000M/4000M/ 6000M/8000M/ 12000M/16000M/ 24000M/32000M/ 48000M/64000M/96000M/128000M/192000M/256000M/320000M。
2533
3317
  */
2534
3318
  MemoryLimit: number;
2535
3319
  /**
@@ -2537,17 +3321,9 @@ export interface ResizeUDBInstanceRequest {
2537
3321
  */
2538
3322
  DiskSpace: number;
2539
3323
  /**
2540
- * 是否使用SSD,默认为true
2541
- */
2542
- UseSSD?: boolean;
2543
- /**
2544
- * SSD类型,可选值为"SATA"、"PCI-E"、“NVMe”,如果UseSSD为true ,则必选
3324
+ * SSD类型,可选值为"SATA"、“NVMe”
2545
3325
  */
2546
3326
  SSDType?: string;
2547
- /**
2548
- * 专区的ID,如果有值表示专区中的DB配置升降级
2549
- */
2550
- UDBCId?: string;
2551
3327
  /**
2552
3328
  * UDB数据库机型: "Normal": "标准机型" , "SATA_SSD": "SSD机型" , "PCIE_SSD": "SSD高性能机型" , "Normal_Volume": "标准大容量机型", "SATA_SSD_Volume": "SSD大容量机型" , "PCIE_SSD_Volume": "SSD高性能大容量机型",“NVMe_SSD”:“快杰机型”
2553
3329
  */
@@ -2560,6 +3336,18 @@ export interface ResizeUDBInstanceRequest {
2560
3336
  * DB关闭状态下升降级,升降级后是否启动DB,默认为false
2561
3337
  */
2562
3338
  StartAfterUpgrade?: boolean;
3339
+ /**
3340
+ * 规格类型ID,当SpecificationType为1时有效
3341
+ */
3342
+ MachineType?: string;
3343
+ /**
3344
+ * 实例计算规格类型,0或不传代表使用内存方式购买,1代表使用内存-cpu可选配比方式购买,需要填写MachineType
3345
+ */
3346
+ SpecificationType?: string;
3347
+ /**
3348
+ * 数据库的CPU核数(只对普通版的SQLServer有用)
3349
+ */
3350
+ CPU?: number;
2563
3351
  /**
2564
3352
  * 使用的代金券id
2565
3353
  */
@@ -2575,7 +3363,7 @@ export interface ResizeUDBInstanceResponse {
2575
3363
  */
2576
3364
  export interface RestartRWSplittingRequest {
2577
3365
  /**
2578
- * 可用区。参见 [可用区列表](../summary/regionlist.html)
3366
+ * 可用区。参见 [可用区列表](https://docs.ucloud.cn/api/summary/regionlist)
2579
3367
  */
2580
3368
  Zone: string;
2581
3369
  /**
@@ -2593,7 +3381,7 @@ export interface RestartRWSplittingResponse {
2593
3381
  */
2594
3382
  export interface RestartUDBInstanceRequest {
2595
3383
  /**
2596
- * 可用区。参见 [可用区列表](../summary/regionlist.html)
3384
+ * 可用区。参见 [可用区列表](https://docs.ucloud.cn/api/summary/regionlist)
2597
3385
  */
2598
3386
  Zone?: string;
2599
3387
  /**
@@ -2606,6 +3394,32 @@ export interface RestartUDBInstanceRequest {
2606
3394
  */
2607
3395
  export interface RestartUDBInstanceResponse {
2608
3396
  }
3397
+ /**
3398
+ * RollbackUDBInstance - 在原实例回档指定库表
3399
+ */
3400
+ export interface RollbackUDBInstanceRequest {
3401
+ /**
3402
+ * 源实例的Id
3403
+ */
3404
+ SrcDBId: string;
3405
+ /**
3406
+ * 恢复到某个时间点的时间戳(UTC时间格式,默认单位秒)
3407
+ */
3408
+ RecoveryTime: string;
3409
+ /**
3410
+ * 指定需要恢复的表,格式为(库名.表名), 指定多个用逗号隔开,eg: [ udb.test, mysql_school.my_student]
3411
+ */
3412
+ Tables: string;
3413
+ }
3414
+ /**
3415
+ * RollbackUDBInstance - 在原实例回档指定库表
3416
+ */
3417
+ export interface RollbackUDBInstanceResponse {
3418
+ /**
3419
+ * 源实例的Id
3420
+ */
3421
+ DBId: string;
3422
+ }
2609
3423
  /**
2610
3424
  * SetUDBRWSplitting - 设置读写分离的模式
2611
3425
  */
@@ -2645,7 +3459,7 @@ export interface SetUDBRWSplittingResponse {
2645
3459
  */
2646
3460
  export interface StartUDBInstanceRequest {
2647
3461
  /**
2648
- * 可用区。参见 [可用区列表](../summary/regionlist.html)
3462
+ * 可用区。参见 [可用区列表](https://docs.ucloud.cn/api/summary/regionlist)
2649
3463
  */
2650
3464
  Zone?: string;
2651
3465
  /**
@@ -2663,7 +3477,7 @@ export interface StartUDBInstanceResponse {
2663
3477
  */
2664
3478
  export interface StopUDBInstanceRequest {
2665
3479
  /**
2666
- * 可用区。参见 [可用区列表](../summary/regionlist.html)
3480
+ * 可用区。参见 [可用区列表](https://docs.ucloud.cn/api/summary/regionlist)
2667
3481
  */
2668
3482
  Zone?: string;
2669
3483
  /**
@@ -2737,7 +3551,7 @@ export interface SwitchUDBInstanceToHAResponse {
2737
3551
  */
2738
3552
  export interface UpdateUDBInstanceBackupStrategyRequest {
2739
3553
  /**
2740
- * 可用区。参见 [可用区列表](../summary/regionlist.html)
3554
+ * 可用区。参见 [可用区列表](https://docs.ucloud.cn/api/summary/regionlist)
2741
3555
  */
2742
3556
  Zone?: string;
2743
3557
  /**
@@ -2757,9 +3571,25 @@ export interface UpdateUDBInstanceBackupStrategyRequest {
2757
3571
  */
2758
3572
  ForceDump?: boolean;
2759
3573
  /**
2760
- * 选择默认的备份方式,可选 snapshot 表示使用快照/物理备份,不填或者其它任何值为默认的逻辑备份。需要同时设置BackupDate字段。(注意现在只有SSD 版本的 MySQL实例支持物理备份)
3574
+ * 选择默认的备份方式,可选nobackup表示不备份, snapshot 表示使用快照备份,logic 表示使用逻辑备份。需要同时设置BackupDate字段。(快照备份即物理备份。SSD版本的mysql实例支持设置为snapshot,NVMe版本的mysql实例支持设置为xtrabackup)
2761
3575
  */
2762
3576
  BackupMethod?: string;
3577
+ /**
3578
+ * 自动备份转存到用户自己的bucket 的tokenid, 需要用户自己自己设置权限
3579
+ */
3580
+ UserTokenID?: string;
3581
+ /**
3582
+ * 自动备份转存到用户自己的bucket名称,要包含到对应的token id里
3583
+ */
3584
+ UserBucket?: string;
3585
+ /**
3586
+ * 是否开启binlog备份, 默认为未开启
3587
+ */
3588
+ EnableBinlogBackup?: boolean;
3589
+ /**
3590
+ * 远端binlog保存时长(天)
3591
+ */
3592
+ BinlogRemoteSaveDays?: number;
2763
3593
  }
2764
3594
  /**
2765
3595
  * UpdateUDBInstanceBackupStrategy - 修改UDB自动备份策略
@@ -2848,6 +3678,40 @@ export interface UpgradeUDBInstanceToHARequest {
2848
3678
  */
2849
3679
  export interface UpgradeUDBInstanceToHAResponse {
2850
3680
  }
3681
+ /**
3682
+ * UpgradeUDBVersion - 升级db实例版本
3683
+ */
3684
+ export interface UpgradeUDBVersionRequest {
3685
+ /**
3686
+ * 可用区。参见 [可用区列表](https://docs.ucloud.cn/api/summary/regionlist)
3687
+ */
3688
+ Zone: string;
3689
+ /**
3690
+ * db实例资源id
3691
+ */
3692
+ DBId: string;
3693
+ /**
3694
+ * db需要升级的小版本
3695
+ */
3696
+ DBSubVersion: string;
3697
+ /**
3698
+ * 切换类型,可选值为"immediately"和"customize",分别代表立即切换和自定义切换时间,自定义切换时间需要填写SwitchStartTime和SwitchEndTime
3699
+ */
3700
+ SwitchType: string;
3701
+ /**
3702
+ * 该值为一个unix时间戳,代表开始切换实例的时间
3703
+ */
3704
+ SwitchStartTime?: number;
3705
+ /**
3706
+ * 该值为一个unix时间戳,代表开始预期切换实例结束的时间
3707
+ */
3708
+ SwitchEndTime?: number;
3709
+ }
3710
+ /**
3711
+ * UpgradeUDBVersion - 升级db实例版本
3712
+ */
3713
+ export interface UpgradeUDBVersionResponse {
3714
+ }
2851
3715
  /**
2852
3716
  * UploadUDBParamGroup - 导入UDB配置
2853
3717
  */