-
Notifications
You must be signed in to change notification settings - Fork 4
Expand file tree
/
Copy pathclient.py
More file actions
2467 lines (1854 loc) · 107 KB
/
client.py
File metadata and controls
2467 lines (1854 loc) · 107 KB
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
# -*- coding: utf-8 -*-
""" Code is generated by ucloud-model, DO NOT EDIT IT. """
from ucloud.core.client import Client
from ucloud.services.ucloudstack.schemas import apis
class UCloudStackClient(Client):
def __init__(self, config, transport=None, middleware=None, logger=None):
super(UCloudStackClient, self).__init__(
config, transport, middleware, logger
)
def allocate_eip(self, req=None, **kwargs):
""" AllocateEIP - 申请外网IP
**Request**
- **Region** (str) - (Config) 地域。枚举值:cn,表示中国;
- **Bandwidth** (int) - (Required) 带宽,默认值1,默认范围1~100
- **ChargeType** (str) - (Required) 计费模式。枚举值:Dynamic,表示小时;Month,表示月;Year,表示年;
- **Name** (str) - (Required) 名称
- **OperatorName** (str) - (Required) 线路。目前支持Bgp
- **Zone** (str) - (Required) 可用区。枚举值:zone-01,表示中国;
- **Quantity** (int) - 购买时长。默认值1。小时不生效,月范围【1,11】,年范围【1,5】。
**Response**
- **EIPID** (str) - 申请的EIP的ID
- **Message** (str) - 返回信息描述。
"""
d = {"Region": self.config.region}
req and d.update(req)
d = apis.AllocateEIPRequestSchema().dumps(d)
resp = self.invoke("AllocateEIP", d, **kwargs)
return apis.AllocateEIPResponseSchema().loads(resp)
def attach_disk(self, req=None, **kwargs):
""" AttachDisk - 绑定硬盘
**Request**
- **Region** (str) - (Config) 地域。枚举值:cn,表示中国;
- **DiskID** (str) - (Required) 硬盘ID
- **ResourceID** (str) - (Required) 绑定的资源ID
- **ResourceType** (str) - (Required) 绑定的资源类型,枚举值:VM,标识虚拟机
- **Zone** (str) - (Required) 可用区。枚举值:zone-01,表示中国;
**Response**
- **Message** (str) - 返回信息描述。
"""
d = {"Region": self.config.region}
req and d.update(req)
d = apis.AttachDiskRequestSchema().dumps(d)
resp = self.invoke("AttachDisk", d, **kwargs)
return apis.AttachDiskResponseSchema().loads(resp)
def bind_alarm_template(self, req=None, **kwargs):
""" BindAlarmTemplate - 绑定告警模板
**Request**
- **Region** (str) - (Config) 地域。枚举值: cn,表示中国;
- **AlarmTemplateID** (str) - (Required) 告警模板ID
- **ResourceIDs** (list) - (Required) 【数组】告警模板ID。调用方式举例:ResourceIDs.0=“one-id”、ResourceIDs.1=“two-id”。
- **ResourceType** (str) - (Required) 资源类型。VM:虚拟机, LB:负载均衡, NATGW:nat网关;EIP:弹性IP
- **Zone** (str) - (Required) 可用区。枚举值:zone-01,表示中国;
**Response**
- **Message** (str) - 返回信息描述
"""
d = {"Region": self.config.region}
req and d.update(req)
d = apis.BindAlarmTemplateRequestSchema().dumps(d)
resp = self.invoke("BindAlarmTemplate", d, **kwargs)
return apis.BindAlarmTemplateResponseSchema().loads(resp)
def bind_eip(self, req=None, **kwargs):
""" BindEIP - 绑定UCoudStack外网IP
**Request**
- **Region** (str) - (Config) 地域。枚举值:cn,表示中国;中国
- **EIPID** (str) - (Required) 外网IP的ID
- **ResourceID** (str) - (Required) 资源ID
- **ResourceType** (str) - (Required) 资源类型。VM:虚拟机, LB:负载均衡, NATGW:nat网关
- **Zone** (str) - (Required) 可用区。枚举值:zone-01,表示中国;
**Response**
- **Message** (str) - 返回描述
"""
d = {"Region": self.config.region}
req and d.update(req)
d = apis.BindEIPRequestSchema().dumps(d)
resp = self.invoke("BindEIP", d, **kwargs)
return apis.BindEIPResponseSchema().loads(resp)
def bind_physical_ip(self, req=None, **kwargs):
""" BindPhysicalIP - 绑定物理 IP ,被绑定的资源必须处于运行中或有效状态。
**Request**
- **Region** (str) - (Config) 地域。
- **PhysicalIPID** (str) - (Required) 物理IP的ID
- **ResourceID** (str) - (Required) 资源ID
- **ResourceType** (str) - (Required) 资源类型。VM:虚拟机
- **Zone** (str) - (Required) 可用区。
**Response**
- **Message** (str) - 返回描述
"""
d = {"Region": self.config.region}
req and d.update(req)
d = apis.BindPhysicalIPRequestSchema().dumps(d)
resp = self.invoke("BindPhysicalIP", d, **kwargs)
return apis.BindPhysicalIPResponseSchema().loads(resp)
def bind_security_group(self, req=None, **kwargs):
""" BindSecurityGroup - 绑定安全组
**Request**
- **Region** (str) - (Config) 地域。枚举值: cn,表示中国;
- **ResourceID** (str) - (Required) 绑定的资源ID。调用方式举例:ResourceID=“one-id”。
- **SGID** (str) - (Required) 安全组ID
- **Zone** (str) - (Required) 可用区。枚举值:zone-01,表示中国;
- **NICID** (str) - 网卡ID
**Response**
- **Message** (str) - 返回信息描述
"""
d = {"Region": self.config.region}
req and d.update(req)
d = apis.BindSecurityGroupRequestSchema().dumps(d)
resp = self.invoke("BindSecurityGroup", d, **kwargs)
return apis.BindSecurityGroupResponseSchema().loads(resp)
def clone_disk(self, req=None, **kwargs):
""" CloneDisk - 克隆硬盘
**Request**
- **Region** (str) - (Config) 地域。枚举值:cn,表示中国;
- **ChargeType** (str) - (Required) 计费模式。枚举值:Dynamic,表示小时;Month,表示月;Year,表示年;
- **Name** (str) - (Required) 名称
- **SrcID** (str) - (Required) 源硬盘ID
- **Zone** (str) - (Required) 可用区。枚举值:zone-01,表示中国;
- **Quantity** (int) - 购买时长。默认值1。小时不生效,月范围【1,11】,年范围【1,5】。
**Response**
- **DiskID** (str) - 克隆出的硬盘ID
- **Message** (str) - 返回信息描述。
"""
d = {"Region": self.config.region}
req and d.update(req)
d = apis.CloneDiskRequestSchema().dumps(d)
resp = self.invoke("CloneDisk", d, **kwargs)
return apis.CloneDiskResponseSchema().loads(resp)
def create_custom_image(self, req=None, **kwargs):
""" CreateCustomImage - 创建自制镜像
**Request**
- **Region** (str) - (Config) 地域。枚举值:cn,表示中国;
- **ImageName** (str) - (Required) 镜像名称
- **VMID** (str) - (Required) 虚拟机ID
- **Zone** (str) - (Required) 可用区。枚举值:zone-01,表示中国;
- **ImageDescription** (str) - 镜像描述。
**Response**
- **ImageID** (str) - 创建的自制镜像ID
- **Message** (str) - 返回信息描述。
"""
d = {"Region": self.config.region}
req and d.update(req)
d = apis.CreateCustomImageRequestSchema().dumps(d)
resp = self.invoke("CreateCustomImage", d, **kwargs)
return apis.CreateCustomImageResponseSchema().loads(resp)
def create_disk(self, req=None, **kwargs):
""" CreateDisk - 创建硬盘
**Request**
- **Region** (str) - (Config) 地域。枚举值:cn,表示中国;
- **ChargeType** (str) - (Required) 计费模式。枚举值:Dynamic,表示小时;Month,表示月;Year,表示年;
- **DiskSpace** (int) - (Required) 磁盘大小
- **Name** (str) - (Required) 磁盘名称
- **SetType** (str) - (Required) 磁盘类型。例如:Normal,SSD
- **Zone** (str) - (Required) 可用区。枚举值:zone-01,表示中国;
- **Quantity** (int) - 购买时长。默认值1。小时不生效,月范围【1,11】,年范围【1,5】。
**Response**
- **DiskID** (str) - 创建的磁盘ID
- **Message** (str) - 返回信息描述。
"""
d = {"Region": self.config.region}
req and d.update(req)
d = apis.CreateDiskRequestSchema().dumps(d)
resp = self.invoke("CreateDisk", d, **kwargs)
return apis.CreateDiskResponseSchema().loads(resp)
def create_lb(self, req=None, **kwargs):
""" CreateLB - 创建负载均衡
**Request**
- **Region** (str) - (Config) 地域。枚举值:cn,表示中国;
- **ChargeType** (str) - (Required) 计费模式。枚举值:Dynamic,表示小时;Month,表示月;Year,表示年;
- **LBType** (str) - (Required) 枚举值。LAN:内网,WAN:外网
- **Name** (str) - (Required) 名称。
- **SubnetID** (str) - (Required) LB 实例所在的子网 ID 。
- **VMType** (str) - (Required) 运行负载均衡实例的主机机型。枚举值:如 Normal ,表示普通机型; SSD,表示 SSD 机型。(机型由平台管理员修改和指定,可参考获取主机机型接口)
- **VPCID** (str) - (Required) LB实例所在的 VPC ID 。
- **Zone** (str) - (Required) 可用区。枚举值:zone-01,表示中国;
- **EIPID** (str) - 外网IP的ID,创建外网LB时为必需
- **Quantity** (int) - 购买时长。默认值1。小时不生效,月范围【1,11】,年范围【1,5】。
- **Remark** (str) - 描述。
- **SGID** (str) - 安全组ID,创建外网LB时为必需
**Response**
- **LBID** (str) - 返回创建的负载均衡ID
- **Message** (str) - 返回信息描述。
"""
d = {"Region": self.config.region}
req and d.update(req)
d = apis.CreateLBRequestSchema().dumps(d)
resp = self.invoke("CreateLB", d, **kwargs)
return apis.CreateLBResponseSchema().loads(resp)
def create_natgw(self, req=None, **kwargs):
""" CreateNATGW - 创建NAT网关
**Request**
- **Region** (str) - (Config) 地域。枚举值:cn,表示中国;
- **ChargeType** (str) - (Required) 计费模式。枚举值:Dynamic,表示小时;Month,表示月;Year,表示年;
- **EIPID** (str) - (Required) 外网IP的ID
- **Name** (str) - (Required) 名称。
- **SGID** (str) - (Required) 安全组ID
- **SubnetID** (str) - (Required) NAT网关实例所在的子网 ID
- **VMType** (str) - (Required) 运行NAT网关实例的主机机型。枚举值:如 Normal ,表示普通机型; SSD,表示 SSD 机型。(机型由平台管理员修改和指定,可参考获取主机机型接口)
- **VPCID** (str) - (Required) NAT网关实例所在的 VPC ID
- **Zone** (str) - (Required) 可用区。枚举值:zone-01,表示中国;
- **Quantity** (int) - 购买时长。默认值1。小时不生效,月范围【1,11】,年范围【1,5】。
- **Remark** (str) - 描述
**Response**
- **Message** (str) - 返回信息描述。
- **NATGWID** (str) - 返回创建的NAT网关ID
"""
d = {"Region": self.config.region}
req and d.update(req)
d = apis.CreateNATGWRequestSchema().dumps(d)
resp = self.invoke("CreateNATGW", d, **kwargs)
return apis.CreateNATGWResponseSchema().loads(resp)
def create_natgw_rule(self, req=None, **kwargs):
""" CreateNATGWRule - 添加NAT网关白名单
**Request**
- **Region** (str) - (Config) 地域。枚举值:cn,表示中国;
- **BindResourceID** (str) - (Required) 绑定的虚拟机资源ID
- **NATGWID** (str) - (Required) NAT网关ID
- **NATGWType** (str) - (Required) NAT的类型。枚举值:SNAT,DNAT
- **Zone** (str) - (Required) 可用区。枚举值:zone-01,表示中国;
**Response**
- **Message** (str) - 返回信息描述。
- **RuleID** (str) - 白名单ID
"""
d = {"Region": self.config.region}
req and d.update(req)
d = apis.CreateNATGWRuleRequestSchema().dumps(d)
resp = self.invoke("CreateNATGWRule", d, **kwargs)
return apis.CreateNATGWRuleResponseSchema().loads(resp)
def create_physical_ip(self, req=None, **kwargs):
""" CreatePhysicalIP - 创建物理 IP ,需确保平台已配置物理 IP 线路相关信息及物理网络联通性。
**Request**
- **Region** (str) - (Config) 地域。枚举值:cn,表示中国;
- **Name** (str) - (Required) 物理IP名称,限制字符长度30
- **OperatorName** (str) - (Required) 物理IP线路
- **Zone** (str) - (Required) 可用区。枚举值:zone-01,表示中国;
- **Remark** (str) - 描述
**Response**
- **Message** (str) - 返回信息描述
- **PhysicalIPID** (str) - 返回创建的物理IP的ID
"""
d = {"Region": self.config.region}
req and d.update(req)
d = apis.CreatePhysicalIPRequestSchema().dumps(d)
resp = self.invoke("CreatePhysicalIP", d, **kwargs)
return apis.CreatePhysicalIPResponseSchema().loads(resp)
def create_rs(self, req=None, **kwargs):
""" CreateRS - 为负载均衡的 VServer 添加后端服务节点。
**Request**
- **Region** (str) - (Config) 地域。枚举值:cn,表示中国;
- **BindResourceID** (str) - (Required) 服务节点的资源 ID ,仅支持添加与 LB 相同 VPC 的虚拟机资源
- **LBID** (str) - (Required) 负载均衡ID
- **Port** (int) - (Required) 服务节点暴露的服务端口号
- **VSID** (str) - (Required) VServer的ID
- **Weight** (int) - (Required) 服务节点的权重
- **Zone** (str) - (Required) 可用区。枚举值:zone-01,表示中国;
**Response**
- **Message** (str) - 返回信息描述。
- **RSID** (str) - 返回创建的RSID
"""
d = {"Region": self.config.region}
req and d.update(req)
d = apis.CreateRSRequestSchema().dumps(d)
resp = self.invoke("CreateRS", d, **kwargs)
return apis.CreateRSResponseSchema().loads(resp)
def create_security_group(self, req=None, **kwargs):
""" CreateSecurityGroup - 创建安全组
**Request**
- **Region** (str) - (Config) 地域。枚举值: cn,表示中国;
- **Name** (str) - (Required) 名称;
- **Rule** (list) - (Required) 【数组】安全组规则。输入有效的规则,调用方式举例:Rule.0=“TCP|23|0.0.0.0/0|ACCEPT|HIGH|1”、Rule.1=“TCP|55|0.0.0.0/0|ACCEPT|HIGH|1”
- **Zone** (str) - (Required) 可用区。枚举值:zone-01,表示中国;
- **Remark** (str) - 描述;
**Response**
- **Message** (str) - 返回信息描述;
- **SGID** (str) - 创建的安全组ID
"""
d = {"Region": self.config.region}
req and d.update(req)
d = apis.CreateSecurityGroupRequestSchema().dumps(d)
resp = self.invoke("CreateSecurityGroup", d, **kwargs)
return apis.CreateSecurityGroupResponseSchema().loads(resp)
def create_security_group_rule(self, req=None, **kwargs):
""" CreateSecurityGroupRule - 创建安全组规则
**Request**
- **Region** (str) - (Config) 地域。枚举值: cn,表示中国;
- **Rules** (list) - (Required) 【数组】安全组规则。输入有效的规则,调用方式举例:Rule.0=“TCP|23|0.0.0.0/0|ACCEPT|HIGH|1”、Rule.1=“TCP|55|0.0.0.0/0|ACCEPT|HIGH|1”
- **SGID** (str) - (Required) 安全组ID
- **Zone** (str) - (Required) 可用区。枚举值:zone-01,表示中国;
**Response**
- **Message** (str) - 返回信息描述;
- **SGRuleID** (str) - 创建的安全组规则ID
"""
d = {"Region": self.config.region}
req and d.update(req)
d = apis.CreateSecurityGroupRuleRequestSchema().dumps(d)
resp = self.invoke("CreateSecurityGroupRule", d, **kwargs)
return apis.CreateSecurityGroupRuleResponseSchema().loads(resp)
def create_snapshot(self, req=None, **kwargs):
""" CreateSnapshot - 创建硬盘快照
**Request**
- **Region** (str) - (Config) 地域。枚举值:如 cn,表示中国。
- **DiskID** (str) - (Required) 硬盘ID,输入“有效”状态的ID
- **Name** (str) - (Required) 快照名称,限制字符长度30
- **Zone** (str) - (Required) 可用区。枚举值:如 zone-01,表示可用区1。
- **Remark** (str) - 描述,限制字符长度100
**Response**
- **Message** (str) - 返回信息描述
- **SnapshotID** (str) - 创建的快照ID
"""
d = {"Region": self.config.region}
req and d.update(req)
d = apis.CreateSnapshotRequestSchema().dumps(d)
resp = self.invoke("CreateSnapshot", d, **kwargs)
return apis.CreateSnapshotResponseSchema().loads(resp)
def create_subnet(self, req=None, **kwargs):
""" CreateSubnet - 创建子网
**Request**
- **Region** (str) - (Config) 地域。枚举值: cn,表示中国;
- **Name** (str) - (Required) 名称;
- **Network** (str) - (Required) 网段。列如:10.0.0.0/16;
- **VPCID** (str) - (Required) 所属VPCID
- **Zone** (str) - (Required) 可用区。枚举值:zone-01,表示中国;
- **Remark** (str) - 描述;
**Response**
- **Message** (str) - 返回信息描述;
- **SubnetID** (str) - 创建Subnet的ID;
"""
d = {"Region": self.config.region}
req and d.update(req)
d = apis.CreateSubnetRequestSchema().dumps(d)
resp = self.invoke("CreateSubnet", d, **kwargs)
return apis.CreateSubnetResponseSchema().loads(resp)
def create_user(self, req=None, **kwargs):
""" CreateUser - 管理员添加账号
**Request**
- **PassWord** (str) - (Required) 账号密码。
- **UserEmail** (str) - (Required) 账号邮箱。
**Response**
- **Message** (str) - 返回信息描述。
- **UserID** (int) - 账户ID
"""
d = {}
req and d.update(req)
d = apis.CreateUserRequestSchema().dumps(d)
resp = self.invoke("CreateUser", d, **kwargs)
return apis.CreateUserResponseSchema().loads(resp)
def create_vm_instance(self, req=None, **kwargs):
""" CreateVMInstance - 创建虚拟机
**Request**
- **Region** (str) - (Config) 地域。枚举值:cn,表示中国;
- **BootDiskSetType** (str) - (Required) 系统盘类型。枚举值:Normal,表示普通;SSD,表示SSD;
- **CPU** (int) - (Required) CPU个数,如1,2,4,8,16,32,64等。
- **ChargeType** (str) - (Required) 计费模式。枚举值:Dynamic,表示小时;Month,表示月;Year,表示年;
- **DataDiskSetType** (str) - (Required) 数据盘类型。枚举值:Normal,表示普通;SSD,表示SSD;
- **ImageID** (str) - (Required) 镜像 ID。基础镜像 ID 或者自制镜像 ID。如:cn-image-centos-74。
- **Memory** (int) - (Required) 内存容量,如1024,2048,4096,8192,16384,32768,65535等。
- **Name** (str) - (Required) 虚拟机名称。可输入如:myVM。名称只能包含中英文、数字以及- _ .且1-30个字符。
- **Password** (str) - (Required) 密码。可输入如:ucloud.cn。密码长度限6-30个字符;需要同时包含两项或以上(大写字母/小写字母/数字/特殊符号);windows不能包含用户名(administrator)中超过2个连续字符的部分。
- **SubnetID** (str) - (Required) 子网 ID。
- **VMType** (str) - (Required) 机型。枚举值:Normal,表示普通;SSD,表示SSD;
- **VPCID** (str) - (Required) VPC ID。
- **WANSGID** (str) - (Required) 外网安全组 ID。输入“有效”状态的安全组的ID。
- **Zone** (str) - (Required) 可用区。枚举值:zone-01,表示中国;
- **DataDiskSpace** (int) - 数据盘大小,单位 GB。默认值为0。范围:【0,8000】,步长10。
- **GPU** (int) - GPU 卡核心的占用个数。枚举值:【1,2,4】。GPU与CPU、内存大小关系:CPU个数>=4*GPU个数,同时内存与CPU规格匹配.
- **InternalIP** (str) - 指定内网IP。输入有效的指定内网 IP。默认为系统自动分配内网 IP。
- **LANSGID** (str) - 内网安全组 ID。输入“有效”状态的安全组的ID。
- **Quantity** (int) - 购买时长。默认值1。小时不生效,月范围【1,11】,年范围【1,5】。
**Response**
- **Message** (str) - 返回信息描述。
- **VMID** (str) - 返回创建虚拟机的 ID 数组。
"""
d = {"Region": self.config.region}
req and d.update(req)
d = apis.CreateVMInstanceRequestSchema().dumps(d)
resp = self.invoke("CreateVMInstance", d, **kwargs)
return apis.CreateVMInstanceResponseSchema().loads(resp)
def create_vpc(self, req=None, **kwargs):
""" CreateVPC - 创建VPC
**Request**
- **Region** (str) - (Config) 地域。枚举值: cn,表示中国;
- **Name** (str) - (Required) 名称;
- **Network** (str) - (Required) 网段。例如:10.0.0.0/16;
- **Zone** (str) - (Required) 可用区。枚举值:zone-01,表示中国;
- **Remark** (str) - 描述;
**Response**
- **Message** (str) - 返回信息描述;
- **VPCID** (str) - 创建的VPCID;
"""
d = {"Region": self.config.region}
req and d.update(req)
d = apis.CreateVPCRequestSchema().dumps(d)
resp = self.invoke("CreateVPC", d, **kwargs)
return apis.CreateVPCResponseSchema().loads(resp)
def create_vs(self, req=None, **kwargs):
""" CreateVS - 创建负载均衡VServer
**Request**
- **Region** (str) - (Config) 地域。枚举值:cn,表示中国;
- **HealthcheckType** (str) - (Required) 健康检查类型,枚举值,Port:端口,Path:域名。TCP和UDP协议只支持Port类型。
- **LBID** (str) - (Required) 负载均衡ID
- **Port** (int) - (Required) VServer 的监听端口。端口范围为 1~65535 ,其中 323、9102、9103、9104、9105、60909、60910 被系统占用。
- **Protocol** (str) - (Required) VServer 的监听协议。枚举值:支持 TCP、UDP、HTTP 三种协议转发。
- **Scheduler** (str) - (Required) 负载均衡的调度算法。枚举值:wrr:加权轮训;lc:最小连接数;hash:原地址。
- **Zone** (str) - (Required) 可用区。枚举值:zone-01,表示中国;
- **Domain** (str) - HTTP 健康检查时校验请求的 HOST 字段中的域名。当健康检查类型为端口检查时,该值为空。
- **KeepaliveTimeout** (int) - 负载均衡的连接空闲超时时间,单位为秒,默认值为 60s 。
- **Path** (str) - HTTP 健康检查的路径,健康检查类型为 HTTP 检查时为必填项。当健康检查类型为端口检查时,该值为空。
- **PersistenceKey** (str) - 会话保持KEY,会话保持类型为Manual时为必填项,仅当 VServer 协议为 HTTP 时有效。
- **PersistenceType** (str) - 会话保持类型。枚举值:None:关闭;Auto:自动生成;Manual:手动生成 。当协议为 TCP 时,该值不生效,会话保持和选择的调度算法相关;当协议为 UDP 时 Auto 表示开启会话保持 。
**Response**
- **Message** (str) - 返回信息描述。
- **VSID** (str) - 返回创建的VSID
"""
d = {"Region": self.config.region}
req and d.update(req)
d = apis.CreateVSRequestSchema().dumps(d)
resp = self.invoke("CreateVS", d, **kwargs)
return apis.CreateVSResponseSchema().loads(resp)
def create_vs_policy(self, req=None, **kwargs):
""" CreateVSPolicy - 创建七层负载均衡内容转发规则,仅当 VServer 的监听协议为 HTTP 时有效。
**Request**
- **Region** (str) - (Config) 地域。枚举值:cn,表示中国;
- **LBID** (str) - (Required) 负载均衡ID
- **RSIDs** (list) - (Required) 【数组】内容转发规则应用的服务节点的 ID,来源于 VServer 中添加的服务节点。调用方式举例:RSIDs.0=“one-id”、RSIDs.1=“two-id”。
- **VSID** (str) - (Required) VServer的ID
- **Zone** (str) - (Required) 可用区。枚举值:zone-01,表示中国;
- **Domain** (str) - 内容转发规则关联的请求域名,值可为空,即代表仅匹配路径。域名和路径至少需要指定一项,且域名和路径的组合在一个 VServer 中必须唯一。
- **Path** (str) - 内容转发规则关联的请求访问路径,如 "/" 。域名和路径至少需要指定一项,且域名和路径的组合在一个 VServer 中必须唯一。
**Response**
- **Message** (str) - 返回信息描述。
- **PolicyID** (str) - 返回创建的内容转发规则ID
"""
d = {"Region": self.config.region}
req and d.update(req)
d = apis.CreateVSPolicyRequestSchema().dumps(d)
resp = self.invoke("CreateVSPolicy", d, **kwargs)
return apis.CreateVSPolicyResponseSchema().loads(resp)
def delete_custom_image(self, req=None, **kwargs):
""" DeleteCustomImage - 删除自制镜像
**Request**
- **Region** (str) - (Config) 地域。枚举值:cn,表示中国;
- **ImageID** (str) - (Required) 自制镜像ID
- **Zone** (str) - (Required) 可用区。枚举值:zone-01,表示中国;
**Response**
- **Message** (str) - 返回信息描述。
"""
d = {"Region": self.config.region}
req and d.update(req)
d = apis.DeleteCustomImageRequestSchema().dumps(d)
resp = self.invoke("DeleteCustomImage", d, **kwargs)
return apis.DeleteCustomImageResponseSchema().loads(resp)
def delete_disk(self, req=None, **kwargs):
""" DeleteDisk - 删除硬盘
**Request**
- **Region** (str) - (Config) 地域。枚举值:cn,表示中国;
- **DiskID** (str) - (Required) 被删除的硬盘ID
- **Zone** (str) - (Required) 可用区。枚举值:zone-01,表示中国;
**Response**
- **Message** (str) - 返回信息描述。
"""
d = {"Region": self.config.region}
req and d.update(req)
d = apis.DeleteDiskRequestSchema().dumps(d)
resp = self.invoke("DeleteDisk", d, **kwargs)
return apis.DeleteDiskResponseSchema().loads(resp)
def delete_lb(self, req=None, **kwargs):
""" DeleteLB - 删除负载均衡
**Request**
- **Region** (str) - (Config) 地域。枚举值:cn,表示中国;
- **LBID** (str) - (Required) 负载均衡ID
- **Zone** (str) - (Required) 可用区。枚举值:zone-01,表示中国;
**Response**
- **Message** (str) - 返回信息描述。
"""
d = {"Region": self.config.region}
req and d.update(req)
d = apis.DeleteLBRequestSchema().dumps(d)
resp = self.invoke("DeleteLB", d, **kwargs)
return apis.DeleteLBResponseSchema().loads(resp)
def delete_natgw(self, req=None, **kwargs):
""" DeleteNATGW - 删除NAT网关
**Request**
- **Region** (str) - (Config) 地域。枚举值:cn,表示中国;
- **NATGWID** (str) - (Required) NAT网关ID
- **Zone** (str) - (Required) 可用区。枚举值:zone-01,表示中国;
**Response**
- **Message** (str) - 返回信息描述。
"""
d = {"Region": self.config.region}
req and d.update(req)
d = apis.DeleteNATGWRequestSchema().dumps(d)
resp = self.invoke("DeleteNATGW", d, **kwargs)
return apis.DeleteNATGWResponseSchema().loads(resp)
def delete_natgw_rule(self, req=None, **kwargs):
""" DeleteNATGWRule - 删除NAT网关白名单
**Request**
- **Region** (str) - (Config) 地域。枚举值:cn,表示中国;
- **NATGWID** (str) - (Required) nat网关ID
- **RuleID** (str) - (Required) 白名单ID
- **Zone** (str) - (Required) 可用区。枚举值:zone-01,表示中国;
**Response**
- **Message** (str) - 返回信息描述。
"""
d = {"Region": self.config.region}
req and d.update(req)
d = apis.DeleteNATGWRuleRequestSchema().dumps(d)
resp = self.invoke("DeleteNATGWRule", d, **kwargs)
return apis.DeleteNATGWRuleResponseSchema().loads(resp)
def delete_physical_ip(self, req=None, **kwargs):
""" DeletePhysicalIP - 删除物理IP
**Request**
- **Region** (str) - (Config) 地域。
- **PhysicalIPID** (str) - (Required) 物理IP的ID
- **Zone** (str) - (Required) 可用区。
**Response**
- **Message** (str) - 返回状态描述
"""
d = {"Region": self.config.region}
req and d.update(req)
d = apis.DeletePhysicalIPRequestSchema().dumps(d)
resp = self.invoke("DeletePhysicalIP", d, **kwargs)
return apis.DeletePhysicalIPResponseSchema().loads(resp)
def delete_rs(self, req=None, **kwargs):
""" DeleteRS - 移除负载均衡的单个服务节点
**Request**
- **Region** (str) - (Config) 地域。枚举值:cn,表示中国;
- **LBID** (str) - (Required) 负载均衡ID
- **RSID** (str) - (Required) RServer的ID
- **VSID** (str) - (Required) VServer的ID
- **Zone** (str) - (Required) 可用区。枚举值:zone-01,表示中国;
**Response**
- **Message** (str) - 返回信息描述。
"""
d = {"Region": self.config.region}
req and d.update(req)
d = apis.DeleteRSRequestSchema().dumps(d)
resp = self.invoke("DeleteRS", d, **kwargs)
return apis.DeleteRSResponseSchema().loads(resp)
def delete_security_group(self, req=None, **kwargs):
""" DeleteSecurityGroup - 删除安全组
**Request**
- **Region** (str) - (Config) 地域。枚举值: cn,表示中国;
- **SGID** (str) - (Required) 安全组ID
- **Zone** (str) - (Required) 可用区。枚举值:zone-01,表示中国;
**Response**
- **Message** (str) - 返回信息描述;
"""
d = {"Region": self.config.region}
req and d.update(req)
d = apis.DeleteSecurityGroupRequestSchema().dumps(d)
resp = self.invoke("DeleteSecurityGroup", d, **kwargs)
return apis.DeleteSecurityGroupResponseSchema().loads(resp)
def delete_security_group_rule(self, req=None, **kwargs):
""" DeleteSecurityGroupRule - 删除安全组规则
**Request**
- **Region** (str) - (Config) 地域。
- **SGID** (str) - (Required) 安全组ID
- **SGRuleID** (str) - (Required) 安全组规则ID
- **Zone** (str) - (Required) 可用区。
**Response**
- **Message** (str) - 返回信息描述;
"""
d = {"Region": self.config.region}
req and d.update(req)
d = apis.DeleteSecurityGroupRuleRequestSchema().dumps(d)
resp = self.invoke("DeleteSecurityGroupRule", d, **kwargs)
return apis.DeleteSecurityGroupRuleResponseSchema().loads(resp)
def delete_snapshot(self, req=None, **kwargs):
""" DeleteSnapshot - 删除快照,仅支持状态为正常的快照进行删除操作。
**Request**
- **Region** (str) - (Config) 地域。枚举值:如 cn,表示中国。
- **SnapshotID** (str) - (Required) 快照ID
- **Zone** (str) - (Required) 可用区。枚举值:如 zone-01,表示可用区1。
**Response**
- **Message** (str) - 返回信息描述
"""
d = {"Region": self.config.region}
req and d.update(req)
d = apis.DeleteSnapshotRequestSchema().dumps(d)
resp = self.invoke("DeleteSnapshot", d, **kwargs)
return apis.DeleteSnapshotResponseSchema().loads(resp)
def delete_subnet(self, req=None, **kwargs):
""" DeleteSubnet - 删除子网
**Request**
- **Region** (str) - (Config) 地域。
- **SubnetID** (str) - (Required) SubnetID
- **Zone** (str) - (Required) 可用区。
**Response**
- **Message** (str) - 返回信息描述;
"""
d = {"Region": self.config.region}
req and d.update(req)
d = apis.DeleteSubnetRequestSchema().dumps(d)
resp = self.invoke("DeleteSubnet", d, **kwargs)
return apis.DeleteSubnetResponseSchema().loads(resp)
def delete_vm_instance(self, req=None, **kwargs):
""" DeleteVMInstance - 删除虚拟机
**Request**
- **Region** (str) - (Config) 地域。 枚举值:cn,表示中国;
- **VMID** (str) - (Required) 虚拟机 ID。输入有效的虚拟机 ID。
- **Zone** (str) - (Required) 可用区。枚举值:zone-01,表示中国;
**Response**
- **Message** (str) - 返回信息描述。
"""
d = {"Region": self.config.region}
req and d.update(req)
d = apis.DeleteVMInstanceRequestSchema().dumps(d)
resp = self.invoke("DeleteVMInstance", d, **kwargs)
return apis.DeleteVMInstanceResponseSchema().loads(resp)
def delete_vpc(self, req=None, **kwargs):
""" DeleteVPC - 删除VPC
**Request**
- **Region** (str) - (Config) 地域。
- **VPCID** (str) - (Required) ID
- **Zone** (str) - (Required) 可用区。
**Response**
- **Message** (str) - 返回信息描述;
"""
d = {"Region": self.config.region}
req and d.update(req)
d = apis.DeleteVPCRequestSchema().dumps(d)
resp = self.invoke("DeleteVPC", d, **kwargs)
return apis.DeleteVPCResponseSchema().loads(resp)
def delete_vs(self, req=None, **kwargs):
""" DeleteVS - 删除VServer
**Request**
- **Region** (str) - (Config) 地域。枚举值:cn,表示中国;
- **LBID** (str) - (Required) VServer 监听器所属的负载均衡 ID
- **VSID** (str) - (Required) 负载均衡VServer监听器ID
- **Zone** (str) - (Required) 可用区。枚举值:zone-01,表示中国;
**Response**
- **Message** (str) - 返回信息描述。
"""
d = {"Region": self.config.region}
req and d.update(req)
d = apis.DeleteVSRequestSchema().dumps(d)
resp = self.invoke("DeleteVS", d, **kwargs)
return apis.DeleteVSResponseSchema().loads(resp)
def delete_vs_policy(self, req=None, **kwargs):
""" DeleteVSPolicy - 删除七层负载均衡内容转发规则,仅当 VServer 的监听协议为 HTTP 时有效。
**Request**
- **Region** (str) - (Config) 地域。枚举值:cn,表示中国;
- **LBID** (str) - (Required) 负载均衡ID
- **PolicyID** (str) - (Required) 内容转发规则ID
- **VSID** (str) - (Required) VServer的ID
- **Zone** (str) - (Required) 可用区。枚举值:zone-01,表示中国;
**Response**
- **Action** (str) - 操作名称
- **Message** (str) - 返回信息描述。
- **RetCode** (int) - 返回码
"""
d = {"Region": self.config.region}
req and d.update(req)
d = apis.DeleteVSPolicyRequestSchema().dumps(d)
resp = self.invoke("DeleteVSPolicy", d, **kwargs)
return apis.DeleteVSPolicyResponseSchema().loads(resp)
def describe_disk(self, req=None, **kwargs):
""" DescribeDisk - 获取硬盘信息
**Request**
- **Region** (str) - (Config) 地域。枚举值: cn,表示中国;
- **Zone** (str) - (Required) 可用区。枚举值:zone-01,表示中国;
- **DiskIDs** (list) - 【数组】磁盘的 ID。输入有效的 ID。调用方式举例:DiskIDs.0=“one-id”、DiskIDs.1=“two-id”。
- **Limit** (int) - 返回数据长度,默认为20,最大100。
- **Offset** (int) - 列表起始位置偏移量,默认为0。
**Response**
- **Infos** (list) - 见 **DiskInfo** 模型定义
- **Message** (str) - 返回信息描述。
- **TotalCount** (int) - 返回磁盘总个数。
**Response Model**
**DiskInfo**
- **AttachResourceID** (str) - 绑定资源ID
- **ChargeType** (str) - 硬盘计费模式。枚举值:Dynamic,表示小时;Month,表示月;Year,表示年;
- **CreateTime** (int) - 创建时间。时间戳
- **DiskID** (str) - 硬盘ID
- **DiskStatus** (str) - 硬盘状态。Creating:创建中,BeingCloned:正在被克隆中,Unbound:已解绑,Unbounding:解绑中,Bounding:绑定中,Bound:已绑定,Upgrading:升级中,Deleting:删除中,Deleted:已删除,Releasing:销毁中,Released:已销毁
- **ExpireTime** (int) - 过期时间。时间戳
- **Name** (str) - 名称
- **Region** (str) - 地域
- **Remark** (str) - 备注
- **SetType** (str) - 磁盘类型。例如:Normal,SSD
- **Size** (int) - 大小。单位GB
- **Zone** (str) - 可用区
"""
d = {"Region": self.config.region}
req and d.update(req)
d = apis.DescribeDiskRequestSchema().dumps(d)
resp = self.invoke("DescribeDisk", d, **kwargs)
return apis.DescribeDiskResponseSchema().loads(resp)
def describe_eip(self, req=None, **kwargs):
""" DescribeEIP - 获取外网IP的信息
**Request**
- **Region** (str) - (Config) 地域。枚举值:cn,表示中国;
- **Zone** (str) - (Required) 可用区。枚举值:zone-01,表示中国;
- **EIPIDs** (list) - 【数组】外网的 ID。输入有效的 ID。调用方式举例:EIPIDs.0=“one-id”、EIPIDs.1=“two-id”
- **Limit** (str) - 返回数据长度,默认为20,最大100。
- **Offset** (str) - 列表起始位置偏移量,默认为0。
**Response**
- **Infos** (list) - 见 **EIPInfo** 模型定义
- **Message** (str) - 返回信息描述
- **Totalcount** (int) - 返回现有外网IP总数
**Response Model**
**EIPInfo**
- **Bandwidth** (int) - 带宽大小
- **BindResourceID** (str) - 绑定资源ID
- **BindResourceType** (str) - 绑定资源类型
- **ChargeType** (str) - 计费模式。枚举值:Dynamic,表示小时;Month,表示月;Year,表示年;
- **CreateTime** (int) - 创建时间。时间戳
- **EIPID** (str) - ID
- **ExpireTime** (int) - 过期时间。时间戳
- **IP** (str) - 外网IP
- **Name** (str) - 名称
- **OperatorName** (str) - 线路
- **Region** (str) - 地域
- **Remark** (str) - 备注
- **Status** (str) - 状态。Allocating:申请中,Free:未绑定,Bounding:绑定中,Bound:已绑定,Unbounding:解绑中,Deleted:已删除,Releasing:销毁中,Released:已销毁,BandwidthChanging:带宽修改中
- **Zone** (str) - 可用区
"""
d = {"Region": self.config.region}
req and d.update(req)
d = apis.DescribeEIPRequestSchema().dumps(d)
resp = self.invoke("DescribeEIP", d, **kwargs)
return apis.DescribeEIPResponseSchema().loads(resp)
def describe_image(self, req=None, **kwargs):
""" DescribeImage - 获取镜像信息,包括默认镜像和自制镜像。
**Request**
- **Region** (str) - (Config) 地域。枚举值: cn,表示中国;
- **Zone** (str) - (Required) 可用区。枚举值:zone-01,表示中国;
- **ImageIDs** (list) - 【数组】镜像的 ID。输入有效的 ID。调用方式举例:ImageIDs.0=“one-id”、ImageIDs.1=“two-id”。
- **ImageType** (str) - 镜像类型。枚举值:Base(基础镜像,平台默认提供的镜像),Custom(自制镜像,通过虚拟机导出的镜像) 。若该值为空,默认查询所有镜像。
- **Limit** (int) - 返回数据长度,默认为20,最大100。
- **Offset** (int) - 列表起始位置偏移量,默认为0。
**Response**
- **Infos** (list) - 见 **ImageInfo** 模型定义
- **Message** (str) - 返回信息描述。
- **TotalCount** (int) - 返回镜像的总个数。
**Response Model**
**ImageInfo**
- **CreateTime** (int) - 创建时间。时间戳。
- **ImageID** (str) - 镜像ID
- **ImageStatus** (str) - 镜像状态。枚举类型:Making(创建中),Available(可用),Unavailable(不可用),Terminating(销毁中),Used(被使用中),Deleting(删除中),Deleted(已删除)
- **ImageType** (str) - 镜像类型。枚举类型:Base(基础镜像),Custom(自制镜像)。
- **Name** (str) - 镜像名称
- **OSDistribution** (str) - 镜像系统发行版本。例如:Centos, Ubuntu, Windows等
- **OSName** (str) - 系统名称。例如:CentOS 7.4 x86_64
- **OSType** (str) - 系统类型。例如:Linux, Windows,Kylin