-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathdcdb.d.ts
2660 lines (2455 loc) · 103 KB
/
dcdb.d.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/// <reference types="node" />
import { AxiosPromise, AxiosRequestConfig } from "axios";
/** 数据库账号信息 */
declare interface Account {
/** 账户的名称 */
User: string;
/** 账户的域名 */
Host: string;
}
/** 升级实例 -- 新增分片类型 */
declare interface AddShardConfig {
/** 新增分片的数量 */
ShardCount: number;
/** 分片内存大小,单位 GB */
ShardMemory: number;
/** 分片存储大小,单位 GB */
ShardStorage: number;
}
/** 数据库超期备份配置 */
declare interface BackupConfig {
/** 备份策略是否启用。 */
EnableBackupPolicy?: boolean;
/** 超期保留开始日期,早于开始日期的超期备份不保留,格式:yyyy-mm-dd。 */
BeginDate?: string;
/** 超期备份保留时长,超出保留时间的超期备份将被删除,可填写1-3650整数。 */
MaxRetentionDays?: number;
/** 备份模式,可选择按年月周模式保存* 按年:annually* 按月:monthly* 按周:weekly */
Frequency?: string;
/** Frequency等于weekly时生效。表示保留特定工作日备份。可选择周一到周日,支持多选,取星期英文:* 星期一 :Monday* 星期二 :Tuesday* 星期三:Wednesday* 星期四:Thursday* 星期五:Friday* 星期六:Saturday* 星期日:Sunday */
WeekDays?: string[];
/** 保留备份个数,Frequency等于monthly或weekly时生效。备份模式选择按月时,可填写1-28整数;备份模式选择年时,可填写1-336整数。 */
BackupCount?: number;
}
/** 描述分片DB节点信息 */
declare interface BriefNodeInfo {
/** DB节点ID */
NodeId?: string;
/** DB节点角色,取值为master或者slave */
Role?: string;
/** 节点所属分片的分片ID */
ShardId?: string;
}
/** 列权限信息 */
declare interface ColumnPrivilege {
/** 数据库名 */
Database: string;
/** 数据库表名 */
Table: string;
/** 数据库列名 */
Column: string;
/** 权限信息 */
Privileges: string[];
}
/** 配置信息。包含配置项Config,配置值Value */
declare interface ConfigValue {
/** 配置项的名称,支持填写max_user_connections */
Config: string | null;
/** 配置值 */
Value: string | null;
}
/** 约束类型值的范围 */
declare interface ConstraintRange {
/** 约束类型为section时的最小值 */
Min?: string;
/** 约束类型为section时的最大值 */
Max?: string;
}
/** 云数据库账号信息 */
declare interface DBAccount {
/** 用户名 */
UserName?: string;
/** 用户可以从哪台主机登录(对应 MySQL 用户的 host 字段,UserName + Host 唯一标识一个用户,IP形式,IP段以%结尾;支持填入%;为空默认等于%) */
Host?: string;
/** 用户备注信息 */
Description?: string;
/** 创建时间 */
CreateTime?: string;
/** 最后更新时间 */
UpdateTime?: string;
/** 只读标记,0:否, 1:该账号的sql请求优先选择备机执行,备机不可用时选择主机执行,2:优先选择备机执行,备机不可用时操作失败。 */
ReadOnly?: number;
/** 如果备机延迟超过本参数设置值,系统将认为备机发生故障建议该参数值大于10。当ReadOnly选择1、2时该参数生效。 */
DelayThresh?: number;
/** 针对只读账号,设置策略是否固定备机,0:不固定备机,即备机不满足条件与客户端不断开连接,Proxy选择其他可用备机,1:备机不满足条件断开连接,确保一个连接固定备机。 */
SlaveConst?: number;
/** 用户最大连接数,0代表无限制 */
MaxUserConnections?: number;
}
/** 云数据库参数信息。 */
declare interface DBParamValue {
/** 参数名称 */
Param: string;
/** 参数值 */
Value: string;
}
/** 分布式数据库实例信息 */
declare interface DCDBInstanceInfo {
/** 实例ID */
InstanceId?: string;
/** 实例名称 */
InstanceName?: string;
/** 应用ID */
AppId?: number;
/** 项目ID */
ProjectId?: number;
/** 地域 */
Region?: string;
/** 可用区 */
Zone?: string;
/** VPC数字ID */
VpcId?: number;
/** Subnet数字ID */
SubnetId?: number;
/** 状态中文描述 */
StatusDesc?: string;
/** 实例状态:0 创建中,1 流程处理中, 2 运行中,3 实例未初始化,-1 实例已隔离,4 实例初始化中,5 实例删除中,6 实例重启中,7 数据迁移中 */
Status?: number;
/** 内网IP */
Vip?: string;
/** 内网端口 */
Vport?: number;
/** 创建时间 */
CreateTime?: string;
/** 自动续费标志 */
AutoRenewFlag?: number;
/** 内存大小,单位 GB */
Memory?: number;
/** 存储大小,单位 GB */
Storage?: number;
/** 分片个数 */
ShardCount?: number;
/** 到期时间 */
PeriodEndTime?: string;
/** 隔离时间 */
IsolatedTimestamp?: string;
/** 账号ID */
Uin?: string;
/** 分片详情 */
ShardDetail?: ShardInfo[];
/** 节点数,2 为一主一从, 3 为一主二从 */
NodeCount?: number;
/** 临时实例标记,0 为非临时实例 */
IsTmp?: number;
/** 独享集群ID,为空表示非独享集群实例 */
ExclusterId?: string;
/** 字符串型的私有网络ID */
UniqueVpcId?: string;
/** 字符串型的私有网络子网ID */
UniqueSubnetId?: string;
/** 数字实例ID(过时字段,请勿依赖该值) */
Id?: number;
/** 外网访问的域名,公网可解析 */
WanDomain?: string;
/** 外网 IP 地址,公网可访问 */
WanVip?: string;
/** 外网端口 */
WanPort?: number;
/** 产品类型 ID(过时字段,请勿依赖该值) */
Pid?: number;
/** 实例最后更新时间,格式为 2006-01-02 15:04:05 */
UpdateTime?: string;
/** 数据库引擎 */
DbEngine?: string;
/** 数据库引擎版本 */
DbVersion?: string;
/** 付费模式 */
Paymode?: string;
/** 实例处于异步任务状态时,表示异步任务流程ID */
Locker?: number | null;
/** 外网状态,0-未开通;1-已开通;2-关闭;3-开通中 */
WanStatus?: number;
/** 该实例是否支持审计。1-支持;0-不支持 */
IsAuditSupported?: number;
/** Cpu核数 */
Cpu?: number;
/** 实例IPv6标志 */
Ipv6Flag?: number | null;
/** 内网IPv6 */
Vipv6?: string | null;
/** 外网IPv6 */
WanVipv6?: string | null;
/** 外网IPv6端口 */
WanPortIpv6?: number | null;
/** 外网IPv6状态 */
WanStatusIpv6?: number | null;
/** DCN标志,0-无,1-主实例,2-灾备实例 */
DcnFlag?: number | null;
/** DCN状态,0-无,1-创建中,2-同步中,3-已断开 */
DcnStatus?: number | null;
/** DCN灾备实例数 */
DcnDstNum?: number | null;
/** 1: 主实例(独享型), 2: 主实例, 3: 灾备实例, 4: 灾备实例(独享型) */
InstanceType?: number | null;
/** 实例标签信息 */
ResourceTags?: ResourceTag[] | null;
/** 数据库引擎版本 */
DbVersionId?: string | null;
}
/** 描述分布式数据库分片信息。 */
declare interface DCDBShardInfo {
/** 所属实例Id */
InstanceId?: string;
/** 分片SQL透传Id,用于将sql透传到指定分片执行 */
ShardSerialId?: string;
/** 全局唯一的分片Id */
ShardInstanceId?: string;
/** 状态:0 创建中,1 流程处理中, 2 运行中,3 分片未初始化 */
Status?: number;
/** 状态中文描述 */
StatusDesc?: string;
/** 创建时间 */
CreateTime?: string;
/** 字符串格式的私有网络Id */
VpcId?: string;
/** 字符串格式的私有网络子网Id */
SubnetId?: string;
/** 项目ID */
ProjectId?: number;
/** 地域 */
Region?: string;
/** 可用区 */
Zone?: string;
/** 内存大小,单位 GB */
Memory?: number;
/** 存储大小,单位 GB */
Storage?: number;
/** 到期时间 */
PeriodEndTime?: string;
/** 节点数,2 为一主一从, 3 为一主二从 */
NodeCount?: number;
/** 存储使用率,单位为 % */
StorageUsage?: number;
/** 内存使用率,单位为 % */
MemoryUsage?: number;
/** 数字分片Id(过时字段,请勿依赖该值) */
ShardId?: number;
/** 产品ProductID */
Pid?: number;
/** Proxy版本 */
ProxyVersion?: string;
/** 付费模型 */
Paymode?: string | null;
/** 分片的主可用区 */
ShardMasterZone?: string | null;
/** 分片的从可用区列表 */
ShardSlaveZones?: string[] | null;
/** CPU核数 */
Cpu?: number;
/** 分片ShardKey的范围(总共64个哈希值),例如: 0-31,32-63 */
Range?: string;
}
/** 数据库信息 */
declare interface Database {
/** 数据库名称 */
DbName?: string;
}
/** 数据库函数信息 */
declare interface DatabaseFunction {
/** 函数名称 */
Func?: string;
}
/** 数据库权限 */
declare interface DatabasePrivilege {
/** 权限信息 */
Privileges: string[];
/** 数据库名 */
Database: string;
}
/** 数据库存储过程信息 */
declare interface DatabaseProcedure {
/** 存储过程名称 */
Proc?: string;
}
/** 数据库表信息 */
declare interface DatabaseTable {
/** 表名 */
Table?: string;
}
/** 数据库视图信息 */
declare interface DatabaseView {
/** 视图名称 */
View?: string;
}
/** DCN详情条目 */
declare interface DcnDetailItem {
/** 实例ID */
InstanceId?: string;
/** 实例名称 */
InstanceName?: string;
/** 实例地域 */
Region?: string;
/** 实例可用区 */
Zone?: string;
/** 实例IP地址 */
Vip?: string;
/** 实例IPv6地址 */
Vipv6?: string;
/** 实例端口 */
Vport?: number;
/** 实例状态 */
Status?: number;
/** 实例状态描述 */
StatusDesc?: string;
/** 实例DCN标志,1-主,2-备 */
DcnFlag?: number;
/** 实例DCN状态,0-无,1-创建中,2-同步中,3-已断开 */
DcnStatus?: number;
/** 实例CPU核数 */
Cpu?: number;
/** 实例内存大小,单位 GB */
Memory?: number;
/** 实例存储大小,单位 GB */
Storage?: number;
/** 付费模式 */
PayMode?: number;
/** 实例创建时间,格式为 2006-01-02 15:04:05 */
CreateTime?: string;
/** 实例到期时间,格式为 2006-01-02 15:04:05 */
PeriodEndTime?: string;
/** 1: 主实例(独享型), 2: 主实例, 3: 灾备实例, 4: 灾备实例(独享型) */
InstanceType?: number;
/** 是否开启了 kms */
EncryptStatus?: number;
/** 实例DCN状态描述信息 */
DcnStatusDesc?: string;
/** DCN实例绑定的北极星服务所属的北极星实例Id,若未绑定则为空 */
PolarisInstanceId?: string;
/** DCN实例绑定的北极星服务所属的北极星实例名,若未绑定则为空 */
PolarisInstanceName?: string;
/** DCN实例绑定的北极星服务所属的北极星命名空间,若未绑定则为空 */
PolarisNamespace?: string;
/** DCN实例绑定的北极星服务,若未绑定则为空 */
PolarisService?: string;
/** DCN实例在北极星服务中的状态 0:未开启; 1:已开启; 2:已隔离; 3:切换中 */
PolarisServiceStatus?: number;
/** DCN实例在北极星服务中的状态的描述信息 */
PolarisServiceStatusDesc?: string;
/** 北极星管控地域 */
PolarisRegion?: string;
/** 是否支持DCN切换 */
IsDcnSwitchSupported?: number;
}
/** 订单信息 */
declare interface Deal {
/** 订单号 */
DealName: string;
/** 所属账号 */
OwnerUin: string;
/** 商品数量 */
Count: number;
/** 关联的流程 Id,可用于查询流程执行状态 */
FlowId: number;
/** 只有创建实例且已完成发货的订单会填充该字段,表示该订单创建的实例的 ID */
InstanceIds: string[] | null;
/** 付费模式,0后付费/1预付费 */
PayMode: number;
}
/** 升级实例 -- 扩容分片类型 */
declare interface ExpandShardConfig {
/** 分片ID数组 */
ShardInstanceIds: string[];
/** 分片内存大小,单位 GB */
ShardMemory: number;
/** 分片存储大小,单位 GB */
ShardStorage: number;
/** 分片节点数 */
ShardNodeCount?: number;
}
/** 实例备份文件信息 */
declare interface InstanceBackupFileItem {
/** 实例ID */
InstanceId?: string;
/** 实例名称 */
InstanceName?: string;
/** 实例状态 */
InstanceStatus?: number;
/** 分片ID */
ShardId?: string;
/** 文件路径 */
FilePath?: string;
/** 文件名 */
FileName?: string;
/** 文件大小 */
FileSize?: number;
/** 备份类型,Data:数据备份,Binlog:Binlog备份,Errlog:错误日志,Slowlog:慢日志 */
BackupType?: string;
/** 手动备份,0:否,1:是 */
ManualBackup?: number;
/** 备份开始时间 */
StartTime?: string;
/** 备份结束时间 */
EndTime?: string;
/** 对象的存储类型,枚举值:STANDARD(标准存储)、ARCHIVE(归档存储)。 */
StorageClass?: string;
}
/** 拉取的日志信息 */
declare interface LogFileInfo {
/** Log最后修改时间 */
Mtime?: number;
/** 文件长度 */
Length?: number;
/** 下载Log时用到的统一资源标识符 */
Uri?: string;
/** 文件名 */
FileName?: string;
}
/** 数据库超期备份配置 */
declare interface NewBackupConfig {
/** 备份策略是否启用。 */
EnableBackupPolicy: boolean;
/** 超期保留开始日期,早于开始日期的超期备份不保留,格式:yyyy-mm-dd。 */
BeginDate: string;
/** 超期备份保留时长,超出保留时间的超期备份将被删除,可填写1-3650整数。 */
MaxRetentionDays: number;
/** 备份模式,可选择按年月周模式保存* 按年:annually* 按月:monthly* 按周:weekly */
Frequency: string;
/** Frequency等于weekly时生效。表示保留特定工作日备份。可选择周一到周日,支持多选,取星期英文:* 星期一 :Monday* 星期二 :Tuesday* 星期三:Wednesday* 星期四:Thursday* 星期五:Friday* 星期六:Saturday* 星期日:Sunday */
WeekDays?: string[];
/** 保留备份个数,Frequency等于monthly或weekly时生效。备份模式选择按月时,可填写1-28整数;备份模式选择年时,可填写1-336整数。 */
BackupCount?: number;
}
/** 描述DB节点信息 */
declare interface NodeInfo {
/** DB节点ID */
NodeId?: string;
/** DB节点角色,取值为master或者slave */
Role?: string;
}
/** 参数约束 */
declare interface ParamConstraint {
/** 约束类型,如枚举enum,区间section */
Type?: string;
/** 约束类型为enum时的可选值列表 */
Enum?: string;
/** 约束类型为section时的范围 */
Range?: ConstraintRange | null;
/** 约束类型为string时的可选值列表 */
String?: string;
}
/** DB参数描述 */
declare interface ParamDesc {
/** 参数名字 */
Param?: string;
/** 当前参数值 */
Value?: string;
/** 设置过的值,参数生效后,该值和value一样。未设置过就不返回该字段。 */
SetValue?: string | null;
/** 系统默认值 */
Default?: string;
/** 参数限制 */
Constraint?: ParamConstraint;
/** 是否有设置过值,false:没有设置过值,true:有设置过值。 */
HaveSetValue?: boolean;
/** 是否需要重启生效,false:不需要重启,true:需要重启 */
NeedRestart?: boolean;
}
/** 修改参数结果 */
declare interface ParamModifyResult {
/** 修改参数名字 */
Param?: string;
/** 参数修改结果。0表示修改成功;-1表示修改失败;-2表示该参数值非法 */
Code?: number;
}
/** 项目信息描述 */
declare interface Project {
/** 项目ID */
ProjectId?: number;
/** 资源拥有者(主账号)uin */
OwnerUin?: number;
/** 应用Id */
AppId?: number;
/** 项目名称 */
Name?: string;
/** 创建者uin */
CreatorUin?: number;
/** 来源平台 */
SrcPlat?: string;
/** 来源AppId */
SrcAppId?: number;
/** 项目状态,0正常,-1关闭。默认项目为3 */
Status?: number;
/** 创建时间 */
CreateTime?: string;
/** 是否默认项目,1 是,0 不是 */
IsDefault?: number;
/** 描述信息 */
Info?: string;
}
/** 售卖可用区信息 */
declare interface RegionInfo {
/** 地域英文ID */
Region?: string;
/** 地域数字ID */
RegionId?: number;
/** 地域中文名 */
RegionName?: string;
/** 可用区列表 */
ZoneList?: ZonesInfo[];
/** 可选择的主可用区和从可用区 */
AvailableChoice?: ShardZoneChooseInfo[];
}
/** 保留的网络资源信息 */
declare interface ReservedNetResource {
/** 私有网络 */
VpcId?: string;
/** 子网 */
SubnetId?: string;
/** VpcId,SubnetId下保留的内网ip */
Vip?: string;
/** Vip下的端口 */
Vports?: number[];
/** Vip的回收时间 */
RecycleTime?: string;
}
/** 标签对象,包含tagKey & tagValue */
declare interface ResourceTag {
/** 标签键key */
TagKey: string;
/** 标签值value */
TagValue: string;
}
/** 安全组详情 */
declare interface SecurityGroup {
/** 项目ID */
ProjectId?: number;
/** 创建时间,时间格式:yyyy-mm-dd hh:mm:ss */
CreateTime?: string;
/** 安全组ID */
SecurityGroupId?: string;
/** 安全组名称 */
SecurityGroupName?: string;
/** 安全组备注 */
SecurityGroupRemark?: string;
/** 入站规则 */
Inbound?: SecurityGroupBound[];
/** 出站规则 */
Outbound?: SecurityGroupBound[];
}
/** 安全出入口规则 */
declare interface SecurityGroupBound {
/** 来源 IP 或 IP 段,例如192.168.0.0/16 */
CidrIp?: string;
/** 策略,ACCEPT 或者 DROP */
Action?: string;
/** 端口 */
PortRange?: string;
/** 网络协议,支持 UDP、TCP 等 */
IpProtocol?: string;
}
/** DCDB分片信息 */
declare interface ShardBriefInfo {
/** 分片SerialId */
ShardSerialId?: string;
/** 分片ID,形如shard-7vg1o339 */
ShardInstanceId?: string;
/** 分片运行状态 */
Status?: number;
/** 分片运行状态描述 */
StatusDesc?: string;
/** 分片创建时间 */
CreateTime?: string;
/** 分片内存大小,单位GB */
Memory?: number;
/** 分片磁盘大小,单位GB */
Storage?: number;
/** 分片日志磁盘空间大小,单位GB */
LogDisk?: number;
/** 分片节点个数 */
NodeCount?: number;
/** 分片磁盘空间使用率 */
StorageUsage?: number;
/** 分片Proxy版本信息 */
ProxyVersion?: string;
/** 分片主DB可用区 */
ShardMasterZone?: string;
/** 分片从DB可用区 */
ShardSlaveZones?: string[];
/** 分片Cpu核数 */
Cpu?: number;
/** DB节点信息 */
NodesInfo?: NodeInfo[] | null;
}
/** 分片信息 */
declare interface ShardInfo {
/** 分片ID */
ShardInstanceId?: string;
/** 分片Set ID */
ShardSerialId?: string;
/** 状态:0 创建中,1 流程处理中, 2 运行中,3 分片未初始化,-2 分片已删除 */
Status?: number;
/** 创建时间 */
Createtime?: string;
/** 内存大小,单位 GB */
Memory?: number;
/** 存储大小,单位 GB */
Storage?: number;
/** 分片数字ID */
ShardId?: number;
/** 节点数,2 为一主一从, 3 为一主二从 */
NodeCount?: number;
/** 产品类型 Id(过时字段,请勿依赖该值) */
Pid?: number;
/** Cpu核数 */
Cpu?: number;
}
/** 分片节点可用区选择 */
declare interface ShardZoneChooseInfo {
/** 主可用区 */
MasterZone?: ZonesInfo;
/** 可选的从可用区 */
SlaveZones?: ZonesInfo[];
}
/** 慢查询条目信息 */
declare interface SlowLogData {
/** 语句校验和,用于查询详情 */
CheckSum?: string;
/** 数据库名称 */
Db?: string;
/** 抽象的SQL语句 */
FingerPrint?: string;
/** 平均的锁时间 */
LockTimeAvg?: string;
/** 最大锁时间 */
LockTimeMax?: string;
/** 最小锁时间 */
LockTimeMin?: string;
/** 锁时间总和 */
LockTimeSum?: string;
/** 查询次数 */
QueryCount?: string;
/** 平均查询时间 */
QueryTimeAvg?: string;
/** 最大查询时间 */
QueryTimeMax?: string;
/** 最小查询时间 */
QueryTimeMin?: string;
/** 查询时间总和 */
QueryTimeSum?: string;
/** 扫描行数 */
RowsExaminedSum?: string;
/** 发送行数 */
RowsSentSum?: string;
/** 最后执行时间 */
TsMax?: string;
/** 首次执行时间 */
TsMin?: string;
/** 账号 */
User?: string;
/** 样例Sql */
ExampleSql?: string | null;
/** 账户的域名 */
Host?: string | null;
}
/** 按机型分类的规格配置 */
declare interface SpecConfig {
/** 规格机型 */
Machine?: string;
/** 规格列表 */
SpecConfigInfos?: SpecConfigInfo[];
}
/** 实例可售卖规格详细信息,创建实例和扩容实例时 NodeCount、Memory 确定售卖规格,硬盘大小可用区间为[MinStorage,MaxStorage] */
declare interface SpecConfigInfo {
/** 节点个数,2 表示一主一从,3 表示一主二从 */
NodeCount?: number;
/** 内存大小,单位 GB */
Memory?: number;
/** 数据盘规格最小值,单位 GB */
MinStorage?: number;
/** 数据盘规格最大值,单位 GB */
MaxStorage?: number;
/** 推荐的使用场景 */
SuitInfo?: string;
/** 产品类型 Id */
Pid?: number;
/** 最大 Qps 值 */
Qps?: number;
/** CPU核数 */
Cpu?: number;
}
/** 升级实例 -- 切分分片类型 */
declare interface SplitShardConfig {
/** 分片ID数组 */
ShardInstanceIds: string[];
/** 数据切分比例,固定50% */
SplitRate: number;
/** 分片内存大小,单位 GB */
ShardMemory: number;
/** 分片存储大小,单位 GB */
ShardStorage: number;
}
/** 数据库列信息 */
declare interface TableColumn {
/** 列名称 */
Col?: string;
/** 列类型 */
Type?: string;
}
/** 数据库表权限 */
declare interface TablePrivilege {
/** 数据库名 */
Database: string;
/** 数据库表名 */
Table: string;
/** 权限信息 */
Privileges: string[];
}
/** 标签 */
declare interface Tag {
/** 标签键 */
TagKey?: string;
/** 标签值 */
TagValue?: string;
}
/** 临时实例 */
declare interface TmpInstance {
/** 应用ID */
AppId?: number | null;
/** 创建时间 */
CreateTime?: string | null;
/** 实例备注 */
InstanceRemark?: string | null;
/** 0:非临时实例 ,1:无效临时实例, 2:回档成功的有效临时实例 */
TempType?: number | null;
/** 实例状态,0:待初始化,1:流程处理中,2:有效状态,-1:已隔离,-2:已下线 */
Status?: number | null;
/** 实例 ID,形如:tdsql-ow728lmc。 */
InstanceId?: string | null;
/** 实例虚IP */
Vip?: string | null;
/** 实例虚端口 */
Vport?: number | null;
/** 有效期结束时间 */
PeriodEndTime?: string | null;
/** 源实例 ID,形如:tdsql-ow728lmc。 */
SrcInstanceId?: string | null;
/** 实例状态描述 */
StatusDesc?: string | null;
/** 实例所在地域 */
Region?: string | null;
/** 实例所在可用区 */
Zone?: string | null;
/** 实例虚IPv6 */
Vipv6?: string | null;
/** 实例IPv6标志 */
Ipv6Flag?: number | null;
}
/** 用户任务信息 */
declare interface UserTaskInfo {
/** 任务ID */
Id?: number;
/** 用户账户ID */
AppId?: number;
/** 任务状态,0-任务初始化中;1-任务运行中;2-任务成功;3-任务失败 */
Status?: number;
/** 任务类型,0-实例回档;1-实例创建;2-实例扩容;3-实例迁移;4-实例删除;5-实例重启 */
UserTaskType?: number;
/** 任务创建时间 */
CreateTime?: string;
/** 任务结束时间 */
EndTime?: string;
/** 任务错误信息 */
ErrMsg?: string;
/** 客户端参数 */
InputData?: string;
/** 实例ID */
InstanceId?: string;
/** 实例名称 */
InstanceName?: string;
/** 地域ID */
RegionId?: number;
}
/** 视图权限信息 */
declare interface ViewPrivileges {
/** 数据库名 */
Database: string;
/** 数据库视图名 */
View: string;
/** 权限信息 */
Privileges: string[];
}
/** 可用区信息 */
declare interface ZonesInfo {
/** 可用区英文ID */
Zone: string;
/** 可用区数字ID */
ZoneId: number;
/** 可用区中文名 */
ZoneName: string;
/** 是否在售 */
OnSale: boolean;
}
declare interface ActiveHourDCDBInstanceRequest {
/** 待升级的实例ID列表。形如:["dcdbt-ow728lmc"],可以通过 DescribeDCDBInstances 查询实例详情获得。 */
InstanceIds: string[];
}
declare interface ActiveHourDCDBInstanceResponse {
/** 解隔离成功的实例id列表 */
SuccessInstanceIds?: string[];
/** 解隔离失败的实例id列表 */
FailedInstanceIds?: string[];
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface AssociateSecurityGroupsRequest {
/** 数据库引擎名称,本接口取值:dcdb。 */
Product: string;
/** 要绑定的安全组ID,类似sg-efil73jd。 */
SecurityGroupId: string;
/** 被绑定的实例ID,类似tdsqlshard-lesecurk,支持指定多个实例。 */
InstanceIds: string[];
}
declare interface AssociateSecurityGroupsResponse {
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface CancelDcnJobRequest {
/** 灾备实例ID */
InstanceId: string;
}
declare interface CancelDcnJobResponse {
/** 流程ID */
FlowId?: number;
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface CloneAccountRequest {
/** 实例ID */
InstanceId: string;
/** 源用户账户名 */
SrcUser: string;
/** 源用户HOST */
SrcHost: string;
/** 目的用户账户名 */
DstUser: string;
/** 目的用户HOST */
DstHost: string;
/** 目的用户账户描述 */
DstDesc?: string;
}
declare interface CloneAccountResponse {
/** 异步任务流程ID */
FlowId: number;
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface CloseDBExtranetAccessRequest {
/** 待关闭外网访问的实例ID。形如:dcdbt-ow728lmc,可以通过 DescribeDCDBInstances 查询实例详情获得。 */
InstanceId: string;
/** 是否IPv6,默认0 */
Ipv6Flag?: number;
}
declare interface CloseDBExtranetAccessResponse {
/** 异步任务ID,可通过 DescribeFlow 查询任务状态。 */
FlowId?: number;
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface CopyAccountPrivilegesRequest {
/** 实例 ID,形如:dcdbt-ow728lmc。 */
InstanceId: string;
/** 源用户名 */
SrcUserName: string;
/** 源用户允许的访问 host */
SrcHost: string;
/** 目的用户名 */
DstUserName: string;
/** 目的用户允许的访问 host */
DstHost: string;
/** 源账号的 ReadOnly 属性 */
SrcReadOnly?: string;
/** 目的账号的 ReadOnly 属性 */
DstReadOnly?: string;
}
declare interface CopyAccountPrivilegesResponse {
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface CreateAccountRequest {
/** 实例 ID,形如:dcdbt-ow728lmc,可以通过 DescribeDCDBInstances 查询实例详情获得。 */
InstanceId: string;
/** AccountName */
UserName: string;
/** 可以登录的主机,与mysql 账号的 host 格式一致,可以支持通配符,例如 %,10.%,10.20.%。 */
Host: string;
/** 账号密码,密码需要 8-32 个字符,不能以 '/' 开头,并且必须包含小写字母、大写字母、数字和符号()~!@#$%^&*-+=_|{}[]:<>,.?/。 */
Password?: string;
/** 是否创建为只读账号,0:否, 1:该账号的sql请求优先选择备机执行,备机不可用时选择主机执行,2:优先选择备机执行,备机不可用时操作失败,3:只从备机读取。 */
ReadOnly?: number;
/** 账号备注,可以包含中文、英文字符、常见符号和数字,长度为0~256字符 */
Description?: string;
/** 如果备机延迟超过本参数设置值,系统将认为备机发生故障建议该参数值大于10。当ReadOnly选择1、2时该参数生效。 */
DelayThresh?: number;
/** 针对只读账号,设置策略是否固定备机,0:不固定备机,即备机不满足条件与客户端不断开连接,Proxy选择其他可用备机,1:备机不满足条件断开连接,确保一个连接固定备机。 */
SlaveConst?: number;
/** 用户最大连接数限制参数。不传或者传0表示为不限制,对应max_user_connections参数,目前10.1内核版本不支持设置。 */
MaxUserConnections?: number;
/** 使用GetPublicKey返回的RSA2048公钥加密后的密码 */
EncryptedPassword?: string;
}
declare interface CreateAccountResponse {
/** 实例ID,透传入参。 */
InstanceId?: string;
/** 用户名,透传入参。 */
UserName?: string;
/** 允许访问的 host,透传入参。 */
Host?: string;
/** 透传入参。 */
ReadOnly?: number;
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface CreateDCDBInstanceRequest {
/** 分片节点可用区分布,可填写多个可用区。注意当前可售卖的可用区需要通过DescribeDCDBSaleInfo接口拉取。 */
Zones: string[];
/** 欲购买的时长,单位:月。 */
Period: number;
/** 分片内存大小,单位:GB,可以通过 DescribeShardSpec 查询实例规格获得。 */
ShardMemory: number;
/** 分片存储空间大小,单位:GB,可以通过 DescribeShardSpec 查询实例规格获得。 */
ShardStorage: number;
/** 单个分片节点个数,可以通过 DescribeShardSpec 查询实例规格获得。 */
ShardNodeCount: number;
/** 实例分片个数,可选范围2-8,可以通过升级实例进行新增分片到最多64个分片。 */
ShardCount: number;
/** 欲购买实例的数量 */
Count?: number;
/** 项目 ID,可以通过查看项目列表获取,不传则关联到默认项目 */
ProjectId?: number;
/** 虚拟私有网络 ID,不传或传空表示创建为基础网络 */
VpcId?: string;
/** 虚拟私有网络子网 ID,VpcId不为空时必填 */
SubnetId?: string;
/** 数据库引擎版本,当前可选:8.0,5.7,10.1,10.0。 */
DbVersionId?: string;
/** 是否自动使用代金券进行支付,默认不使用。 */
AutoVoucher?: boolean;
/** 代金券ID列表,目前仅支持指定一张代金券。 */