@ucloud-sdks/ucloud-sdk-js 0.2.17 → 0.2.19
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.
- package/lib/services/udb/index.d.ts +235 -36
- package/lib/services/udb/index.js +31 -4
- package/lib/services/uhost/index.d.ts +1074 -94
- package/lib/services/uhost/index.js +45 -9
- package/package.json +1 -1
|
@@ -10,7 +10,7 @@ export default class UDBClient extends Client {
|
|
|
10
10
|
credential: CredentialOptions;
|
|
11
11
|
});
|
|
12
12
|
/**
|
|
13
|
-
* BackupUDBInstance -
|
|
13
|
+
* BackupUDBInstance - 发起实例备份。
|
|
14
14
|
*
|
|
15
15
|
* See also: https://docs.ucloud.cn/api/udb-api/backup_udb_instance
|
|
16
16
|
*/
|
|
@@ -58,7 +58,7 @@ export default class UDBClient extends Client {
|
|
|
58
58
|
*/
|
|
59
59
|
clearUDBLog(request?: ClearUDBLogRequest): Promise<ClearUDBLogResponse>;
|
|
60
60
|
/**
|
|
61
|
-
* CreateMongoDBReplicaSet - 一键创建DB
|
|
61
|
+
* CreateMongoDBReplicaSet - 一键创建DB副本集,本接口适用于物理机MongoDB,该架构即将下线, 若要使用快杰MongoDB,请参考https://docs.ucloud.cn/api/umongodb-api/index
|
|
62
62
|
*
|
|
63
63
|
* See also: https://docs.ucloud.cn/api/udb-api/create_mongo_db_replica_set
|
|
64
64
|
*/
|
|
@@ -88,13 +88,13 @@ export default class UDBClient extends Client {
|
|
|
88
88
|
*/
|
|
89
89
|
createUDBParamGroup(request?: CreateUDBParamGroupRequest): Promise<CreateUDBParamGroupResponse>;
|
|
90
90
|
/**
|
|
91
|
-
* CreateUDBReplicationInstance - 创建MongoDB
|
|
91
|
+
* CreateUDBReplicationInstance - 创建MongoDB的副本节点(包括仲裁), 本接口适用于物理机MongoDB,该架构即将下线, 若要使用快杰MongoDB,请参考https://docs.ucloud.cn/api/umongodb-api/index
|
|
92
92
|
*
|
|
93
93
|
* See also: https://docs.ucloud.cn/api/udb-api/create_udb_replication_instance
|
|
94
94
|
*/
|
|
95
95
|
createUDBReplicationInstance(request?: CreateUDBReplicationInstanceRequest): Promise<CreateUDBReplicationInstanceResponse>;
|
|
96
96
|
/**
|
|
97
|
-
* CreateUDBRouteInstance -
|
|
97
|
+
* CreateUDBRouteInstance - 本接口适用于物理机MongoDB,该架构即将下线, 若要使用快杰MongoDB,请参考https://docs.ucloud.cn/api/umongodb-api/index
|
|
98
98
|
*
|
|
99
99
|
* See also: https://docs.ucloud.cn/api/udb-api/create_udb_route_instance
|
|
100
100
|
*/
|
|
@@ -141,12 +141,24 @@ export default class UDBClient extends Client {
|
|
|
141
141
|
* See also: https://docs.ucloud.cn/api/udb-api/describe_udb_backup_blacklist
|
|
142
142
|
*/
|
|
143
143
|
describeUDBBackupBlacklist(request?: DescribeUDBBackupBlacklistRequest): Promise<DescribeUDBBackupBlacklistResponse>;
|
|
144
|
+
/**
|
|
145
|
+
* DescribeUDBBackupStrategy - 获取实例备份策略
|
|
146
|
+
*
|
|
147
|
+
* See also: https://docs.ucloud.cn/api/udb-api/describe_udb_backup_strategy
|
|
148
|
+
*/
|
|
149
|
+
describeUDBBackupStrategy(request?: DescribeUDBBackupStrategyRequest): Promise<DescribeUDBBackupStrategyResponse>;
|
|
144
150
|
/**
|
|
145
151
|
* DescribeUDBBinlogBackup - 列表UDB实例Binlog自动备份信息
|
|
146
152
|
*
|
|
147
153
|
* See also: https://docs.ucloud.cn/api/udb-api/describe_udb_binlog_backup
|
|
148
154
|
*/
|
|
149
155
|
describeUDBBinlogBackup(request?: DescribeUDBBinlogBackupRequest): Promise<DescribeUDBBinlogBackupResponse>;
|
|
156
|
+
/**
|
|
157
|
+
* DescribeUDBBinlogBackupStrategy - 获取UDB实例binlog自动备份策略
|
|
158
|
+
*
|
|
159
|
+
* See also: https://docs.ucloud.cn/api/udb-api/describe_udb_binlog_backup_strategy
|
|
160
|
+
*/
|
|
161
|
+
describeUDBBinlogBackupStrategy(request?: DescribeUDBBinlogBackupStrategyRequest): Promise<DescribeUDBBinlogBackupStrategyResponse>;
|
|
150
162
|
/**
|
|
151
163
|
* DescribeUDBBinlogBackupURL - 获取UDB的Binlog或者错误日志或者慢查询日志的备份地址
|
|
152
164
|
*
|
|
@@ -279,6 +291,12 @@ export default class UDBClient extends Client {
|
|
|
279
291
|
* See also: https://docs.ucloud.cn/api/udb-api/get_udb_instance_ssl_cert_url
|
|
280
292
|
*/
|
|
281
293
|
getUDBInstanceSSLCertURL(request?: GetUDBInstanceSSLCertURLRequest): Promise<GetUDBInstanceSSLCertURLResponse>;
|
|
294
|
+
/**
|
|
295
|
+
* ListUDBInstanceFailoverRecord - 获取实例容灾记录列表
|
|
296
|
+
*
|
|
297
|
+
* See also: https://docs.ucloud.cn/api/udb-api/list_udb_instance_failover_record
|
|
298
|
+
*/
|
|
299
|
+
listUDBInstanceFailoverRecord(request?: ListUDBInstanceFailoverRecordRequest): Promise<ListUDBInstanceFailoverRecordResponse>;
|
|
282
300
|
/**
|
|
283
301
|
* ListUDBMachineType - 获取UDB云数据库支持的计算规格列表,暂不支持获取跨可用区实例的计算规格,目前支持的数据库品类包括:NVMe版和SSD云盘版MySQL
|
|
284
302
|
*
|
|
@@ -419,7 +437,7 @@ export default class UDBClient extends Client {
|
|
|
419
437
|
uploadUDBParamGroup(request?: UploadUDBParamGroupRequest): Promise<UploadUDBParamGroupResponse>;
|
|
420
438
|
}
|
|
421
439
|
/**
|
|
422
|
-
* BackupUDBInstance -
|
|
440
|
+
* BackupUDBInstance - 发起实例备份。
|
|
423
441
|
*/
|
|
424
442
|
export interface BackupUDBInstanceRequest {
|
|
425
443
|
/**
|
|
@@ -452,9 +470,13 @@ export interface BackupUDBInstanceRequest {
|
|
|
452
470
|
ForceBackup?: boolean;
|
|
453
471
|
}
|
|
454
472
|
/**
|
|
455
|
-
* BackupUDBInstance -
|
|
473
|
+
* BackupUDBInstance - 发起实例备份。
|
|
456
474
|
*/
|
|
457
475
|
export interface BackupUDBInstanceResponse {
|
|
476
|
+
/**
|
|
477
|
+
* 备份记录 ID
|
|
478
|
+
*/
|
|
479
|
+
BackupId?: number;
|
|
458
480
|
}
|
|
459
481
|
/**
|
|
460
482
|
* BackupUDBInstanceBinlog - 备份UDB指定时间段的binlog列表
|
|
@@ -619,7 +641,7 @@ export interface ClearUDBLogRequest {
|
|
|
619
641
|
export interface ClearUDBLogResponse {
|
|
620
642
|
}
|
|
621
643
|
/**
|
|
622
|
-
* CreateMongoDBReplicaSet - 一键创建DB
|
|
644
|
+
* CreateMongoDBReplicaSet - 一键创建DB副本集,本接口适用于物理机MongoDB,该架构即将下线, 若要使用快杰MongoDB,请参考https://docs.ucloud.cn/api/umongodb-api/index
|
|
623
645
|
*/
|
|
624
646
|
export interface CreateMongoDBReplicaSetRequest {
|
|
625
647
|
/**
|
|
@@ -700,7 +722,7 @@ export interface CreateMongoDBReplicaSetRequest {
|
|
|
700
722
|
CouponId?: string[];
|
|
701
723
|
}
|
|
702
724
|
/**
|
|
703
|
-
* CreateMongoDBReplicaSet - 一键创建DB
|
|
725
|
+
* CreateMongoDBReplicaSet - 一键创建DB副本集,本接口适用于物理机MongoDB,该架构即将下线, 若要使用快杰MongoDB,请参考https://docs.ucloud.cn/api/umongodb-api/index
|
|
704
726
|
*/
|
|
705
727
|
export interface CreateMongoDBReplicaSetResponse {
|
|
706
728
|
/**
|
|
@@ -962,15 +984,15 @@ export interface CreateUDBMySQLInstanceRequest {
|
|
|
962
984
|
*/
|
|
963
985
|
Zone: string;
|
|
964
986
|
/**
|
|
965
|
-
* 实例名称,至少6位
|
|
987
|
+
* 实例名称,至少6位,最大63位
|
|
966
988
|
*/
|
|
967
989
|
Name: string;
|
|
968
990
|
/**
|
|
969
|
-
*
|
|
991
|
+
* 管理员密码。 8-36 位,支持大小写字母、数字、@#$%^*-+=_,?!&()~.|,须包含两类及以上字符
|
|
970
992
|
*/
|
|
971
993
|
AdminPassword: string;
|
|
972
994
|
/**
|
|
973
|
-
* DB类型,mysql按版本细分 mysql-8.4, mysql-8.0, mysql-5.7, percona-5.7, mysql-5.6, percona-5.6、mysql-5.5
|
|
995
|
+
* DB类型,mysql按版本细分 mysql-8.4, mysql-8.0, mysql-5.7, percona-5.7, mysql-5.6, percona-5.6、mysql-5.5。 可以通过 DescribeUDBType 查询
|
|
974
996
|
*/
|
|
975
997
|
DBTypeId: string;
|
|
976
998
|
/**
|
|
@@ -978,11 +1000,11 @@ export interface CreateUDBMySQLInstanceRequest {
|
|
|
978
1000
|
*/
|
|
979
1001
|
Port: number;
|
|
980
1002
|
/**
|
|
981
|
-
* 磁盘空间(GB)
|
|
1003
|
+
* 磁盘空间(GB),支持约 20G–32T,步长通常为 10;
|
|
982
1004
|
*/
|
|
983
1005
|
DiskSpace: number;
|
|
984
1006
|
/**
|
|
985
|
-
* DB实例使用的配置参数组id
|
|
1007
|
+
* DB实例使用的配置参数组id,取值见 DescribeUDBParamGroup 返回的 `GroupId`,且须与 `DBTypeId` 匹配。
|
|
986
1008
|
*/
|
|
987
1009
|
ParamGroupId: number;
|
|
988
1010
|
/**
|
|
@@ -990,7 +1012,7 @@ export interface CreateUDBMySQLInstanceRequest {
|
|
|
990
1012
|
*/
|
|
991
1013
|
MachineType: string;
|
|
992
1014
|
/**
|
|
993
|
-
* 存储类型 CLOUD_RSSD: RSSD 云盘, CLOUD_SSD_ESSENTIAL: SSD Essential云盘 ,该字段和SpecificationClass组合使用,CLOUD_RSSD对应O型,CLOUD_SSD_ESSENTIAL对应OM型(北京2、乌兰察布支持),注:圣保罗、丹佛、哈萨克斯坦地域仅支持O2机型,CLOUD_RSSD对应O2
|
|
1015
|
+
* 存储类型 CLOUD_RSSD: RSSD 云盘, CLOUD_SSD_ESSENTIAL: SSD Essential云盘 ,该字段和SpecificationClass组合使用,CLOUD_RSSD对应O型,CLOUD_SSD_ESSENTIAL对应OM型(北京2、乌兰察布支持),注:圣保罗、丹佛、哈萨克斯坦地域仅支持O2机型,CLOUD_RSSD对应O2型。 可从 ListUDBMachineType 同条规格读取
|
|
994
1016
|
*/
|
|
995
1017
|
StorageClass: string;
|
|
996
1018
|
/**
|
|
@@ -1018,7 +1040,7 @@ export interface CreateUDBMySQLInstanceRequest {
|
|
|
1018
1040
|
*/
|
|
1019
1041
|
BackupDuration?: number;
|
|
1020
1042
|
/**
|
|
1021
|
-
* 备份
|
|
1043
|
+
* 备份 ID;指定则从备份恢复。取值见 DescribeUDBBackup。
|
|
1022
1044
|
*/
|
|
1023
1045
|
BackupId?: number;
|
|
1024
1046
|
/**
|
|
@@ -1030,11 +1052,11 @@ export interface CreateUDBMySQLInstanceRequest {
|
|
|
1030
1052
|
*/
|
|
1031
1053
|
BackupZone?: string;
|
|
1032
1054
|
/**
|
|
1033
|
-
* 子网ID
|
|
1055
|
+
* 子网 ID。与 `VPCId` 须同属一个 VPC
|
|
1034
1056
|
*/
|
|
1035
1057
|
SubnetId?: string;
|
|
1036
1058
|
/**
|
|
1037
|
-
* VPC
|
|
1059
|
+
* VPC ID。与 `SubnetId` 成对使用;取值见 UVPC 相关接口
|
|
1038
1060
|
*/
|
|
1039
1061
|
VPCId?: string;
|
|
1040
1062
|
/**
|
|
@@ -1131,7 +1153,7 @@ export interface CreateUDBParamGroupResponse {
|
|
|
1131
1153
|
GroupId?: number;
|
|
1132
1154
|
}
|
|
1133
1155
|
/**
|
|
1134
|
-
* CreateUDBReplicationInstance - 创建MongoDB
|
|
1156
|
+
* CreateUDBReplicationInstance - 创建MongoDB的副本节点(包括仲裁), 本接口适用于物理机MongoDB,该架构即将下线, 若要使用快杰MongoDB,请参考https://docs.ucloud.cn/api/umongodb-api/index
|
|
1135
1157
|
*/
|
|
1136
1158
|
export interface CreateUDBReplicationInstanceRequest {
|
|
1137
1159
|
/**
|
|
@@ -1176,7 +1198,7 @@ export interface CreateUDBReplicationInstanceRequest {
|
|
|
1176
1198
|
CouponId?: string;
|
|
1177
1199
|
}
|
|
1178
1200
|
/**
|
|
1179
|
-
* CreateUDBReplicationInstance - 创建MongoDB
|
|
1201
|
+
* CreateUDBReplicationInstance - 创建MongoDB的副本节点(包括仲裁), 本接口适用于物理机MongoDB,该架构即将下线, 若要使用快杰MongoDB,请参考https://docs.ucloud.cn/api/umongodb-api/index
|
|
1180
1202
|
*/
|
|
1181
1203
|
export interface CreateUDBReplicationInstanceResponse {
|
|
1182
1204
|
/**
|
|
@@ -1185,11 +1207,11 @@ export interface CreateUDBReplicationInstanceResponse {
|
|
|
1185
1207
|
DBId?: string;
|
|
1186
1208
|
}
|
|
1187
1209
|
/**
|
|
1188
|
-
* CreateUDBRouteInstance -
|
|
1210
|
+
* CreateUDBRouteInstance - 本接口适用于物理机MongoDB,该架构即将下线, 若要使用快杰MongoDB,请参考https://docs.ucloud.cn/api/umongodb-api/index
|
|
1189
1211
|
*/
|
|
1190
1212
|
export interface CreateUDBRouteInstanceRequest {
|
|
1191
1213
|
/**
|
|
1192
|
-
* 可用区。参见 [可用区列表](
|
|
1214
|
+
* 可用区。参见 [可用区列表](https://docs.ucloud.cn/api/summary/regionlist)
|
|
1193
1215
|
*/
|
|
1194
1216
|
Zone?: string;
|
|
1195
1217
|
/**
|
|
@@ -1238,7 +1260,7 @@ export interface CreateUDBRouteInstanceRequest {
|
|
|
1238
1260
|
CouponId?: string;
|
|
1239
1261
|
}
|
|
1240
1262
|
/**
|
|
1241
|
-
* CreateUDBRouteInstance -
|
|
1263
|
+
* CreateUDBRouteInstance - 本接口适用于物理机MongoDB,该架构即将下线, 若要使用快杰MongoDB,请参考https://docs.ucloud.cn/api/umongodb-api/index
|
|
1242
1264
|
*/
|
|
1243
1265
|
export interface CreateUDBRouteInstanceResponse {
|
|
1244
1266
|
/**
|
|
@@ -1646,6 +1668,53 @@ export interface DescribeUDBBackupBlacklistResponse {
|
|
|
1646
1668
|
*/
|
|
1647
1669
|
Blacklist?: string;
|
|
1648
1670
|
}
|
|
1671
|
+
/**
|
|
1672
|
+
* DescribeUDBBackupStrategy - 获取实例备份策略
|
|
1673
|
+
*/
|
|
1674
|
+
export interface DescribeUDBBackupStrategyRequest {
|
|
1675
|
+
/**
|
|
1676
|
+
* 可用区。参见 [可用区列表](https://docs.ucloud.cn/api/summary/regionlist)
|
|
1677
|
+
*/
|
|
1678
|
+
Zone: string;
|
|
1679
|
+
/**
|
|
1680
|
+
* 实例ID
|
|
1681
|
+
*/
|
|
1682
|
+
DBId: string;
|
|
1683
|
+
}
|
|
1684
|
+
/**
|
|
1685
|
+
* DescribeUDBBackupStrategy - 获取实例备份策略
|
|
1686
|
+
*/
|
|
1687
|
+
export interface DescribeUDBBackupStrategyResponse {
|
|
1688
|
+
/**
|
|
1689
|
+
* 备份策略,不可修改,开始时间,单位小时计,默认3点
|
|
1690
|
+
*/
|
|
1691
|
+
BackupBeginTime: number;
|
|
1692
|
+
/**
|
|
1693
|
+
* 备份日期标记位。共7位,每一位为一周中一天的备份情况 0表示关闭当天备份,1表示打开当天备份。最右边的一位 为星期天的备份开关,其余从右到左依次为星期一到星期 六的备份配置开关,每周必须至少设置两天备份。 例如:1100000 表示打开星期六和星期五的自动备份功能
|
|
1694
|
+
*/
|
|
1695
|
+
BackupDate: string;
|
|
1696
|
+
/**
|
|
1697
|
+
* 默认的备份方式,nobackup表示不备份, snapshot 表示使用快照备份,logic 表示使用逻辑备份,xtrabackup表示使用物理备份。ark_snapshot 方舟快照备份
|
|
1698
|
+
*/
|
|
1699
|
+
BackupMethod: string;
|
|
1700
|
+
/**
|
|
1701
|
+
* 用户转存备份到自己的UFILE配置, 结构参考UFileDataSet
|
|
1702
|
+
*/
|
|
1703
|
+
UserUFileData: {
|
|
1704
|
+
/**
|
|
1705
|
+
* Ufile的令牌tokenid
|
|
1706
|
+
*/
|
|
1707
|
+
TokenID?: string;
|
|
1708
|
+
/**
|
|
1709
|
+
* bucket名称
|
|
1710
|
+
*/
|
|
1711
|
+
Bucket?: string;
|
|
1712
|
+
};
|
|
1713
|
+
/**
|
|
1714
|
+
* 保留多少天
|
|
1715
|
+
*/
|
|
1716
|
+
SaveDays: number;
|
|
1717
|
+
}
|
|
1649
1718
|
/**
|
|
1650
1719
|
* DescribeUDBBinlogBackup - 列表UDB实例Binlog自动备份信息
|
|
1651
1720
|
*/
|
|
@@ -1729,6 +1798,32 @@ export interface DescribeUDBBinlogBackupResponse {
|
|
|
1729
1798
|
*/
|
|
1730
1799
|
TotalCount?: number;
|
|
1731
1800
|
}
|
|
1801
|
+
/**
|
|
1802
|
+
* DescribeUDBBinlogBackupStrategy - 获取UDB实例binlog自动备份策略
|
|
1803
|
+
*/
|
|
1804
|
+
export interface DescribeUDBBinlogBackupStrategyRequest {
|
|
1805
|
+
/**
|
|
1806
|
+
* 可用区。参见 [可用区列表](https://docs.ucloud.cn/api/summary/regionlist)
|
|
1807
|
+
*/
|
|
1808
|
+
Zone: string;
|
|
1809
|
+
/**
|
|
1810
|
+
* DB实例Id
|
|
1811
|
+
*/
|
|
1812
|
+
DBId: string;
|
|
1813
|
+
}
|
|
1814
|
+
/**
|
|
1815
|
+
* DescribeUDBBinlogBackupStrategy - 获取UDB实例binlog自动备份策略
|
|
1816
|
+
*/
|
|
1817
|
+
export interface DescribeUDBBinlogBackupStrategyResponse {
|
|
1818
|
+
/**
|
|
1819
|
+
* 是否开启binlog自动备份,false:关闭,true:开启
|
|
1820
|
+
*/
|
|
1821
|
+
EnableBinlogBackup: boolean;
|
|
1822
|
+
/**
|
|
1823
|
+
* 远端binlog保存时长(天)
|
|
1824
|
+
*/
|
|
1825
|
+
BinlogRemoteSaveDays: number;
|
|
1826
|
+
}
|
|
1732
1827
|
/**
|
|
1733
1828
|
* DescribeUDBBinlogBackupURL - 获取UDB的Binlog或者错误日志或者慢查询日志的备份地址
|
|
1734
1829
|
*/
|
|
@@ -1820,6 +1915,18 @@ export interface DescribeUDBInstanceResponse {
|
|
|
1820
1915
|
* DB实例所在可用区
|
|
1821
1916
|
*/
|
|
1822
1917
|
Zone?: string;
|
|
1918
|
+
/**
|
|
1919
|
+
* 0 不自动续费, 1 自动续费
|
|
1920
|
+
*/
|
|
1921
|
+
AutoRenew: number;
|
|
1922
|
+
/**
|
|
1923
|
+
* CLOUD_SSD: SSD云盘, CLOUD_RSSD: RSSD 云盘, CLOUD_SSD_ESSENTIAL: SSD Essential云盘,LOCAL_SSD: SSD本地盘
|
|
1924
|
+
*/
|
|
1925
|
+
StorageClass: string;
|
|
1926
|
+
/**
|
|
1927
|
+
* 规格类型 O: NVME, OM: 共享型,N: 通用型空的话,显示为-
|
|
1928
|
+
*/
|
|
1929
|
+
SpecificationClass: string;
|
|
1823
1930
|
/**
|
|
1824
1931
|
* 0区分大小写, 1不分区
|
|
1825
1932
|
*/
|
|
@@ -1837,7 +1944,7 @@ export interface DescribeUDBInstanceResponse {
|
|
|
1837
1944
|
*/
|
|
1838
1945
|
Name?: string;
|
|
1839
1946
|
/**
|
|
1840
|
-
* DB
|
|
1947
|
+
* DB类型,mysql/mongodb 按版本细分 mysql-8.4, mysql-8.0, mysql-5.7, percona-5.7, mysql-5.6, percona-5.6、mysql-5.5、mongodb-2.4 、mongodb-2.6 等。可以通过 DescribeUDBType 查询
|
|
1841
1948
|
*/
|
|
1842
1949
|
DBTypeId?: string;
|
|
1843
1950
|
/**
|
|
@@ -2128,6 +2235,14 @@ export interface DescribeUDBInstanceResponse {
|
|
|
2128
2235
|
* 规格类型ID,当SpecificationType为1时有效
|
|
2129
2236
|
*/
|
|
2130
2237
|
MachineType?: string;
|
|
2238
|
+
/**
|
|
2239
|
+
* CLOUD_SSD: SSD云盘, CLOUD_RSSD: RSSD 云盘, CLOUD_SSD_ESSENTIAL: SSD Essential云盘,LOCAL_SSD: SSD本地盘
|
|
2240
|
+
*/
|
|
2241
|
+
StorageClass?: string;
|
|
2242
|
+
/**
|
|
2243
|
+
* 规格类型 O: NVME, OM: 共享型,N: 通用型 空的话,显示为-
|
|
2244
|
+
*/
|
|
2245
|
+
SpecificationClass?: string;
|
|
2131
2246
|
}[];
|
|
2132
2247
|
/**
|
|
2133
2248
|
* 跨可用区高可用备库所在可用区
|
|
@@ -2151,7 +2266,7 @@ export interface DescribeUDBInstanceResponse {
|
|
|
2151
2266
|
Bucket?: string;
|
|
2152
2267
|
};
|
|
2153
2268
|
/**
|
|
2154
|
-
*
|
|
2269
|
+
* 实例提供具体内核版本信息
|
|
2155
2270
|
*/
|
|
2156
2271
|
DBSubVersion?: string;
|
|
2157
2272
|
/**
|
|
@@ -2178,6 +2293,10 @@ export interface DescribeUDBInstanceResponse {
|
|
|
2178
2293
|
* CPU核数
|
|
2179
2294
|
*/
|
|
2180
2295
|
CPU?: number;
|
|
2296
|
+
/**
|
|
2297
|
+
* 是否强制加密,1为强制加密,0是不强制加密
|
|
2298
|
+
*/
|
|
2299
|
+
ForceEncryption?: number;
|
|
2181
2300
|
}[];
|
|
2182
2301
|
/**
|
|
2183
2302
|
* 用户db组的数量,对于 mysql: 主从结对数量,没有slave,则只有master mongodb: 副本集数量
|
|
@@ -2189,15 +2308,15 @@ export interface DescribeUDBInstanceResponse {
|
|
|
2189
2308
|
*/
|
|
2190
2309
|
export interface DescribeUDBInstanceBackupStateRequest {
|
|
2191
2310
|
/**
|
|
2192
|
-
* 可用区。参见 [可用区列表](
|
|
2311
|
+
* 可用区。参见 [可用区列表](https://docs.ucloud.cn/api/summary/regionlist)
|
|
2193
2312
|
*/
|
|
2194
2313
|
Zone: string;
|
|
2195
2314
|
/**
|
|
2196
|
-
* 备份记录ID
|
|
2315
|
+
* 备份记录 ID,见 BackupUDBInstance 响应或 DescribeUDBBackup
|
|
2197
2316
|
*/
|
|
2198
2317
|
BackupId: number;
|
|
2199
2318
|
/**
|
|
2200
|
-
*
|
|
2319
|
+
* 跨可用区高可用备库所在可用区,参见 [可用区列表](https://docs.ucloud.cn/api/summary/regionlist)
|
|
2201
2320
|
*/
|
|
2202
2321
|
BackupZone?: string;
|
|
2203
2322
|
}
|
|
@@ -2408,11 +2527,11 @@ export interface DescribeUDBInstancePriceRequest {
|
|
|
2408
2527
|
*/
|
|
2409
2528
|
InstanceType?: string;
|
|
2410
2529
|
/**
|
|
2411
|
-
*
|
|
2530
|
+
* 实例计算规格类型,0或不传代表使用内存方式购买,1代表使用内存-cpu可选配比方式购买,需要填写MachineType
|
|
2412
2531
|
*/
|
|
2413
2532
|
SpecificationType?: number;
|
|
2414
2533
|
/**
|
|
2415
|
-
* 规格类型ID,当SpecificationType为1
|
|
2534
|
+
* 规格类型ID,当SpecificationType为1时有效。取值见 ListUDBMachineType
|
|
2416
2535
|
*/
|
|
2417
2536
|
MachineType?: string;
|
|
2418
2537
|
/**
|
|
@@ -2839,11 +2958,11 @@ export interface DescribeUDBTypeRequest {
|
|
|
2839
2958
|
*/
|
|
2840
2959
|
DBClusterType?: string;
|
|
2841
2960
|
/**
|
|
2842
|
-
* 返回支持某种实例类型的DB类型。如果没传,则表示任何实例类型均可。
|
|
2961
|
+
* 返回支持某种实例类型的DB类型。如果没传,则表示任何实例类型均可。Normal:单点,HA:高可用,sharded_cluster:分片集群。区分大小写
|
|
2843
2962
|
*/
|
|
2844
2963
|
InstanceMode?: string;
|
|
2845
2964
|
/**
|
|
2846
|
-
* 返回支持某种磁盘类型的DB类型,如Normal、SSD、NVMe_SSD。如果没传,则表示任何磁盘类型均可。
|
|
2965
|
+
* 返回支持某种磁盘类型的DB类型,如Normal、SSD、NVMe_SSD,CLOUD_SSD_ESSENTIAL。如果没传,则表示任何磁盘类型均可。
|
|
2847
2966
|
*/
|
|
2848
2967
|
DiskType?: string;
|
|
2849
2968
|
/**
|
|
@@ -2872,6 +2991,19 @@ export interface DescribeUDBTypeResponse {
|
|
|
2872
2991
|
*/
|
|
2873
2992
|
DBSubVersion?: string;
|
|
2874
2993
|
}[];
|
|
2994
|
+
/**
|
|
2995
|
+
* 推荐DB版本
|
|
2996
|
+
*/
|
|
2997
|
+
DedaultType?: {
|
|
2998
|
+
/**
|
|
2999
|
+
* 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
|
|
3000
|
+
*/
|
|
3001
|
+
DBTypeId?: string;
|
|
3002
|
+
/**
|
|
3003
|
+
* mysql子版本,如mysql-8.0.25,mysql-8.0.16
|
|
3004
|
+
*/
|
|
3005
|
+
DBSubVersion?: string;
|
|
3006
|
+
};
|
|
2875
3007
|
}
|
|
2876
3008
|
/**
|
|
2877
3009
|
* DisableUDBRWSplitting - 关闭DB的读写分离功能
|
|
@@ -3052,6 +3184,57 @@ export interface GetUDBInstanceSSLCertURLResponse {
|
|
|
3052
3184
|
*/
|
|
3053
3185
|
InnerUrl: string;
|
|
3054
3186
|
}
|
|
3187
|
+
/**
|
|
3188
|
+
* ListUDBInstanceFailoverRecord - 获取实例容灾记录列表
|
|
3189
|
+
*/
|
|
3190
|
+
export interface ListUDBInstanceFailoverRecordRequest {
|
|
3191
|
+
/**
|
|
3192
|
+
* 可用区。参见 [可用区列表](https://docs.ucloud.cn/api/summary/regionlist)
|
|
3193
|
+
*/
|
|
3194
|
+
Zone: string;
|
|
3195
|
+
/**
|
|
3196
|
+
* 实例id
|
|
3197
|
+
*/
|
|
3198
|
+
DBId: string;
|
|
3199
|
+
/**
|
|
3200
|
+
* 开始时间
|
|
3201
|
+
*/
|
|
3202
|
+
StartTime: number;
|
|
3203
|
+
/**
|
|
3204
|
+
* 结束时间
|
|
3205
|
+
*/
|
|
3206
|
+
EndTime: number;
|
|
3207
|
+
}
|
|
3208
|
+
/**
|
|
3209
|
+
* ListUDBInstanceFailoverRecord - 获取实例容灾记录列表
|
|
3210
|
+
*/
|
|
3211
|
+
export interface ListUDBInstanceFailoverRecordResponse {
|
|
3212
|
+
/**
|
|
3213
|
+
* 容灾记录列表
|
|
3214
|
+
*/
|
|
3215
|
+
Dataset: {
|
|
3216
|
+
/**
|
|
3217
|
+
* 时间ID
|
|
3218
|
+
*/
|
|
3219
|
+
SessionId?: string;
|
|
3220
|
+
/**
|
|
3221
|
+
* 容灾类型
|
|
3222
|
+
*/
|
|
3223
|
+
FailoverType?: number;
|
|
3224
|
+
/**
|
|
3225
|
+
* 开始时间
|
|
3226
|
+
*/
|
|
3227
|
+
StartTime?: number;
|
|
3228
|
+
/**
|
|
3229
|
+
* 结束时间
|
|
3230
|
+
*/
|
|
3231
|
+
EndTime?: number;
|
|
3232
|
+
/**
|
|
3233
|
+
* 容灾状态
|
|
3234
|
+
*/
|
|
3235
|
+
FailoverState?: string;
|
|
3236
|
+
}[];
|
|
3237
|
+
}
|
|
3055
3238
|
/**
|
|
3056
3239
|
* ListUDBMachineType - 获取UDB云数据库支持的计算规格列表,暂不支持获取跨可用区实例的计算规格,目前支持的数据库品类包括:NVMe版和SSD云盘版MySQL
|
|
3057
3240
|
*/
|
|
@@ -3073,6 +3256,14 @@ export interface ListUDBMachineTypeResponse {
|
|
|
3073
3256
|
* 计算规格列表
|
|
3074
3257
|
*/
|
|
3075
3258
|
DataSet: {
|
|
3259
|
+
/**
|
|
3260
|
+
* 存储类型 CLOUD_SSD: SSD云盘, CLOUD_RSSD: RSSD 云盘, CLOUD_SSD_ESSENTIAL: SSD Essential云盘
|
|
3261
|
+
*/
|
|
3262
|
+
StorageClass?: string;
|
|
3263
|
+
/**
|
|
3264
|
+
* 规格类型 O: NVMe型, OM: 共享型,N: 通用型
|
|
3265
|
+
*/
|
|
3266
|
+
SpecificationClass?: string;
|
|
3076
3267
|
/**
|
|
3077
3268
|
* 计算规格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
3269
|
*/
|
|
@@ -3090,7 +3281,7 @@ export interface ListUDBMachineTypeResponse {
|
|
|
3090
3281
|
*/
|
|
3091
3282
|
Memory?: number;
|
|
3092
3283
|
/**
|
|
3093
|
-
* 内部云主机机型,可选"
|
|
3284
|
+
* 内部云主机机型,可选"O/N/OM"
|
|
3094
3285
|
*/
|
|
3095
3286
|
Os?: string;
|
|
3096
3287
|
/**
|
|
@@ -3102,6 +3293,14 @@ export interface ListUDBMachineTypeResponse {
|
|
|
3102
3293
|
* 默认计算规格
|
|
3103
3294
|
*/
|
|
3104
3295
|
DefaultMachineType: {
|
|
3296
|
+
/**
|
|
3297
|
+
* 存储类型 CLOUD_SSD: SSD云盘, CLOUD_RSSD: RSSD 云盘, CLOUD_SSD_ESSENTIAL: SSD Essential云盘
|
|
3298
|
+
*/
|
|
3299
|
+
StorageClass?: string;
|
|
3300
|
+
/**
|
|
3301
|
+
* 规格类型 O: NVMe型, OM: 共享型,N: 通用型
|
|
3302
|
+
*/
|
|
3303
|
+
SpecificationClass?: string;
|
|
3105
3304
|
/**
|
|
3106
3305
|
* 计算规格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
3306
|
*/
|
|
@@ -3119,7 +3318,7 @@ export interface ListUDBMachineTypeResponse {
|
|
|
3119
3318
|
*/
|
|
3120
3319
|
Memory?: number;
|
|
3121
3320
|
/**
|
|
3122
|
-
* 内部云主机机型,可选"
|
|
3321
|
+
* 内部云主机机型,可选"O/N/OM"
|
|
3123
3322
|
*/
|
|
3124
3323
|
Os?: string;
|
|
3125
3324
|
/**
|
|
@@ -3203,7 +3402,7 @@ export interface ModifyUDBInstancePasswordRequest {
|
|
|
3203
3402
|
*/
|
|
3204
3403
|
DBId: string;
|
|
3205
3404
|
/**
|
|
3206
|
-
*
|
|
3405
|
+
* 实例的新密码。 8-36 位,支持大小写字母、数字、@#$%^*-+=_,?!&()~.|,须包含两类及以上字符
|
|
3207
3406
|
*/
|
|
3208
3407
|
Password: string;
|
|
3209
3408
|
/**
|
|
@@ -3309,7 +3508,7 @@ export interface ResizeUDBInstanceRequest {
|
|
|
3309
3508
|
*/
|
|
3310
3509
|
Zone?: string;
|
|
3311
3510
|
/**
|
|
3312
|
-
*
|
|
3511
|
+
* DB实例Id,该值可以通过DescribeUDBInstance获取
|
|
3313
3512
|
*/
|
|
3314
3513
|
DBId: string;
|
|
3315
3514
|
/**
|
|
@@ -3337,7 +3536,7 @@ export interface ResizeUDBInstanceRequest {
|
|
|
3337
3536
|
*/
|
|
3338
3537
|
StartAfterUpgrade?: boolean;
|
|
3339
3538
|
/**
|
|
3340
|
-
* 规格类型ID,当SpecificationType为1
|
|
3539
|
+
* 规格类型ID,当SpecificationType为1时有效, 可以通过 ListUDBMachineType 查询。
|
|
3341
3540
|
*/
|
|
3342
3541
|
MachineType?: string;
|
|
3343
3542
|
/**
|
|
@@ -13,7 +13,7 @@ class UDBClient extends client_1.default {
|
|
|
13
13
|
super({ config, credential });
|
|
14
14
|
}
|
|
15
15
|
/**
|
|
16
|
-
* BackupUDBInstance -
|
|
16
|
+
* BackupUDBInstance - 发起实例备份。
|
|
17
17
|
*
|
|
18
18
|
* See also: https://docs.ucloud.cn/api/udb-api/backup_udb_instance
|
|
19
19
|
*/
|
|
@@ -85,7 +85,7 @@ class UDBClient extends client_1.default {
|
|
|
85
85
|
return this.invoke(new request_1.default(args)).then((resp) => resp.toObject());
|
|
86
86
|
}
|
|
87
87
|
/**
|
|
88
|
-
* CreateMongoDBReplicaSet - 一键创建DB
|
|
88
|
+
* CreateMongoDBReplicaSet - 一键创建DB副本集,本接口适用于物理机MongoDB,该架构即将下线, 若要使用快杰MongoDB,请参考https://docs.ucloud.cn/api/umongodb-api/index
|
|
89
89
|
*
|
|
90
90
|
* See also: https://docs.ucloud.cn/api/udb-api/create_mongo_db_replica_set
|
|
91
91
|
*/
|
|
@@ -130,7 +130,7 @@ class UDBClient extends client_1.default {
|
|
|
130
130
|
return this.invoke(new request_1.default(args)).then((resp) => resp.toObject());
|
|
131
131
|
}
|
|
132
132
|
/**
|
|
133
|
-
* CreateUDBReplicationInstance - 创建MongoDB
|
|
133
|
+
* CreateUDBReplicationInstance - 创建MongoDB的副本节点(包括仲裁), 本接口适用于物理机MongoDB,该架构即将下线, 若要使用快杰MongoDB,请参考https://docs.ucloud.cn/api/umongodb-api/index
|
|
134
134
|
*
|
|
135
135
|
* See also: https://docs.ucloud.cn/api/udb-api/create_udb_replication_instance
|
|
136
136
|
*/
|
|
@@ -139,7 +139,7 @@ class UDBClient extends client_1.default {
|
|
|
139
139
|
return this.invoke(new request_1.default(args)).then((resp) => resp.toObject());
|
|
140
140
|
}
|
|
141
141
|
/**
|
|
142
|
-
* CreateUDBRouteInstance -
|
|
142
|
+
* CreateUDBRouteInstance - 本接口适用于物理机MongoDB,该架构即将下线, 若要使用快杰MongoDB,请参考https://docs.ucloud.cn/api/umongodb-api/index
|
|
143
143
|
*
|
|
144
144
|
* See also: https://docs.ucloud.cn/api/udb-api/create_udb_route_instance
|
|
145
145
|
*/
|
|
@@ -210,6 +210,15 @@ class UDBClient extends client_1.default {
|
|
|
210
210
|
const args = Object.assign({ Action: 'DescribeUDBBackupBlacklist' }, (request || {}));
|
|
211
211
|
return this.invoke(new request_1.default(args)).then((resp) => resp.toObject());
|
|
212
212
|
}
|
|
213
|
+
/**
|
|
214
|
+
* DescribeUDBBackupStrategy - 获取实例备份策略
|
|
215
|
+
*
|
|
216
|
+
* See also: https://docs.ucloud.cn/api/udb-api/describe_udb_backup_strategy
|
|
217
|
+
*/
|
|
218
|
+
describeUDBBackupStrategy(request) {
|
|
219
|
+
const args = Object.assign({ Action: 'DescribeUDBBackupStrategy' }, (request || {}));
|
|
220
|
+
return this.invoke(new request_1.default(args)).then((resp) => resp.toObject());
|
|
221
|
+
}
|
|
213
222
|
/**
|
|
214
223
|
* DescribeUDBBinlogBackup - 列表UDB实例Binlog自动备份信息
|
|
215
224
|
*
|
|
@@ -219,6 +228,15 @@ class UDBClient extends client_1.default {
|
|
|
219
228
|
const args = Object.assign({ Action: 'DescribeUDBBinlogBackup' }, (request || {}));
|
|
220
229
|
return this.invoke(new request_1.default(args)).then((resp) => resp.toObject());
|
|
221
230
|
}
|
|
231
|
+
/**
|
|
232
|
+
* DescribeUDBBinlogBackupStrategy - 获取UDB实例binlog自动备份策略
|
|
233
|
+
*
|
|
234
|
+
* See also: https://docs.ucloud.cn/api/udb-api/describe_udb_binlog_backup_strategy
|
|
235
|
+
*/
|
|
236
|
+
describeUDBBinlogBackupStrategy(request) {
|
|
237
|
+
const args = Object.assign({ Action: 'DescribeUDBBinlogBackupStrategy' }, (request || {}));
|
|
238
|
+
return this.invoke(new request_1.default(args)).then((resp) => resp.toObject());
|
|
239
|
+
}
|
|
222
240
|
/**
|
|
223
241
|
* DescribeUDBBinlogBackupURL - 获取UDB的Binlog或者错误日志或者慢查询日志的备份地址
|
|
224
242
|
*
|
|
@@ -417,6 +435,15 @@ class UDBClient extends client_1.default {
|
|
|
417
435
|
const args = Object.assign({ Action: 'GetUDBInstanceSSLCertURL' }, (request || {}));
|
|
418
436
|
return this.invoke(new request_1.default(args)).then((resp) => resp.toObject());
|
|
419
437
|
}
|
|
438
|
+
/**
|
|
439
|
+
* ListUDBInstanceFailoverRecord - 获取实例容灾记录列表
|
|
440
|
+
*
|
|
441
|
+
* See also: https://docs.ucloud.cn/api/udb-api/list_udb_instance_failover_record
|
|
442
|
+
*/
|
|
443
|
+
listUDBInstanceFailoverRecord(request) {
|
|
444
|
+
const args = Object.assign({ Action: 'ListUDBInstanceFailoverRecord' }, (request || {}));
|
|
445
|
+
return this.invoke(new request_1.default(args)).then((resp) => resp.toObject());
|
|
446
|
+
}
|
|
420
447
|
/**
|
|
421
448
|
* ListUDBMachineType - 获取UDB云数据库支持的计算规格列表,暂不支持获取跨可用区实例的计算规格,目前支持的数据库品类包括:NVMe版和SSD云盘版MySQL
|
|
422
449
|
*
|