@ucloud-sdks/ucloud-sdk-js 0.2.15 → 0.2.16

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.
@@ -0,0 +1,1521 @@
1
+ import Client from '../../core/client';
2
+ import { ConfigOptions } from '../../core/config';
3
+ import { CredentialOptions } from '../../core/credential';
4
+ /**
5
+ * This client is used to call actions of **ugn** service
6
+ */
7
+ export default class UGNClient extends Client {
8
+ constructor({ config, credential, }: {
9
+ config: ConfigOptions;
10
+ credential: CredentialOptions;
11
+ });
12
+ /**
13
+ * AddRoutePolicy - 新增路由策略
14
+ *
15
+ * See also: https://docs.ucloud.cn/api/ugn-api/add_route_policy
16
+ */
17
+ addRoutePolicy(request?: AddRoutePolicyRequest): Promise<AddRoutePolicyResponse>;
18
+ /**
19
+ * AttachUGNNetworks - 批量关联网络实例
20
+ *
21
+ * See also: https://docs.ucloud.cn/api/ugn-api/attach_ugn_networks
22
+ */
23
+ attachUGNNetworks(request?: AttachUGNNetworksRequest): Promise<AttachUGNNetworksResponse>;
24
+ /**
25
+ * CreateSimpleUGNBwPackage - 云联网简洁版创建带宽包
26
+ *
27
+ * See also: https://docs.ucloud.cn/api/ugn-api/create_simple_ugn_bw_package
28
+ */
29
+ createSimpleUGNBwPackage(request?: CreateSimpleUGNBwPackageRequest): Promise<CreateSimpleUGNBwPackageResponse>;
30
+ /**
31
+ * CreateUGN - 创建云联网
32
+ *
33
+ * See also: https://docs.ucloud.cn/api/ugn-api/create_ugn
34
+ */
35
+ createUGN(request?: CreateUGNRequest): Promise<CreateUGNResponse>;
36
+ /**
37
+ * DelUGN - 删除云联网,仅云联网内无带宽包或网络实例时才可以被删除
38
+ *
39
+ * See also: https://docs.ucloud.cn/api/ugn-api/del_ugn
40
+ */
41
+ delUGN(request?: DelUGNRequest): Promise<DelUGNResponse>;
42
+ /**
43
+ * DeleteRoutePolicy - 删除路由策略
44
+ *
45
+ * See also: https://docs.ucloud.cn/api/ugn-api/delete_route_policy
46
+ */
47
+ deleteRoutePolicy(request?: DeleteRoutePolicyRequest): Promise<DeleteRoutePolicyResponse>;
48
+ /**
49
+ * DeleteUGNBwPackage - 删除带宽包,互通地域仅保留默认带宽包
50
+ *
51
+ * See also: https://docs.ucloud.cn/api/ugn-api/delete_ugn_bw_package
52
+ */
53
+ deleteUGNBwPackage(request?: DeleteUGNBwPackageRequest): Promise<DeleteUGNBwPackageResponse>;
54
+ /**
55
+ * DescribeSimpleUGN - 获取简洁版UGN详情
56
+ *
57
+ * See also: https://docs.ucloud.cn/api/ugn-api/describe_simple_ugn
58
+ */
59
+ describeSimpleUGN(request?: DescribeSimpleUGNRequest): Promise<DescribeSimpleUGNResponse>;
60
+ /**
61
+ * DetachUGNNetworks - 批量解除关联网络实例
62
+ *
63
+ * See also: https://docs.ucloud.cn/api/ugn-api/detach_ugn_networks
64
+ */
65
+ detachUGNNetworks(request?: DetachUGNNetworksRequest): Promise<DetachUGNNetworksResponse>;
66
+ /**
67
+ * EnableRoutePolicy - 启用\停用路由策略
68
+ *
69
+ * See also: https://docs.ucloud.cn/api/ugn-api/enable_route_policy
70
+ */
71
+ enableRoutePolicy(request?: EnableRoutePolicyRequest): Promise<EnableRoutePolicyResponse>;
72
+ /**
73
+ * GetSimpleBuyBwPrice - 获取简洁版带宽包价格
74
+ *
75
+ * See also: https://docs.ucloud.cn/api/ugn-api/get_simple_buy_bw_price
76
+ */
77
+ getSimpleBuyBwPrice(request?: GetSimpleBuyBwPriceRequest): Promise<GetSimpleBuyBwPriceResponse>;
78
+ /**
79
+ * GetSimpleUGNBwPackages - 获取指定云联网内的带宽包
80
+ *
81
+ * See also: https://docs.ucloud.cn/api/ugn-api/get_simple_ugn_bw_packages
82
+ */
83
+ getSimpleUGNBwPackages(request?: GetSimpleUGNBwPackagesRequest): Promise<GetSimpleUGNBwPackagesResponse>;
84
+ /**
85
+ * GetSwitchableBillingModes - 获取带宽包可以切换的计费类型
86
+ *
87
+ * See also: https://docs.ucloud.cn/api/ugn-api/get_switchable_billing_modes
88
+ */
89
+ getSwitchableBillingModes(request?: GetSwitchableBillingModesRequest): Promise<GetSwitchableBillingModesResponse>;
90
+ /**
91
+ * GetUGNRouteTable - 获取云联网路由表
92
+ *
93
+ * See also: https://docs.ucloud.cn/api/ugn-api/get_ugn_route_table
94
+ */
95
+ getUGNRouteTable(request?: GetUGNRouteTableRequest): Promise<GetUGNRouteTableResponse>;
96
+ /**
97
+ * ListSimpleBwPackage - 获取当前项目下的带宽包列表
98
+ *
99
+ * See also: https://docs.ucloud.cn/api/ugn-api/list_simple_bw_package
100
+ */
101
+ listSimpleBwPackage(request?: ListSimpleBwPackageRequest): Promise<ListSimpleBwPackageResponse>;
102
+ /**
103
+ * ListUGN - 获取当前项目下所有云联网资源
104
+ *
105
+ * See also: https://docs.ucloud.cn/api/ugn-api/list_ugn
106
+ */
107
+ listUGN(request?: ListUGNRequest): Promise<ListUGNResponse>;
108
+ /**
109
+ * ListUGNRegions - 获取UGN的可加入地域列表
110
+ *
111
+ * See also: https://docs.ucloud.cn/api/ugn-api/list_ugn_regions
112
+ */
113
+ listUGNRegions(request?: ListUGNRegionsRequest): Promise<ListUGNRegionsResponse>;
114
+ /**
115
+ * ModifyUGNBandwidth - 修改云联网带宽大小
116
+ *
117
+ * See also: https://docs.ucloud.cn/api/ugn-api/modify_ugn_bandwidth
118
+ */
119
+ modifyUGNBandwidth(request?: ModifyUGNBandwidthRequest): Promise<ModifyUGNBandwidthResponse>;
120
+ /**
121
+ * SendUGNApplyNetwork - 跨账号网络实例申请加入 UGN
122
+ *
123
+ * See also: https://docs.ucloud.cn/api/ugn-api/send_ugn_apply_network
124
+ */
125
+ sendUGNApplyNetwork(request?: SendUGNApplyNetworkRequest): Promise<SendUGNApplyNetworkResponse>;
126
+ /**
127
+ * UpdateRoutePolicy - 修改路由策略
128
+ *
129
+ * See also: https://docs.ucloud.cn/api/ugn-api/update_route_policy
130
+ */
131
+ updateRoutePolicy(request?: UpdateRoutePolicyRequest): Promise<UpdateRoutePolicyResponse>;
132
+ }
133
+ /**
134
+ * AddRoutePolicy - 新增路由策略
135
+ */
136
+ export interface AddRoutePolicyRequest {
137
+ /**
138
+ * 云联网实例ID
139
+ */
140
+ UGNID: string;
141
+ /**
142
+ *
143
+ */
144
+ Policy?: {
145
+ /**
146
+ * 策略方向,限定取值:"In"/"Out"
147
+ */
148
+ Direction: string;
149
+ /**
150
+ * 策略优先级,范围:[1,255],数值越小优先级越大,同一方向,策略优先级不可重复
151
+ */
152
+ Priority: number;
153
+ /**
154
+ * 策略执行动作,限定取值:"Permit"/"Deny"
155
+ */
156
+ RouteAction: string;
157
+ /**
158
+ *
159
+ */
160
+ SrcNetworks?: {
161
+ /**
162
+ * 路由策略需要匹配的路由的网络实例ID数组
163
+ */
164
+ NetworkId: string;
165
+ /**
166
+ * 路由策略需要匹配的路由的网络实例下的网段数组
167
+ */
168
+ Prefixes?: string[];
169
+ }[];
170
+ /**
171
+ * 策略名称,限定长度255
172
+ */
173
+ Name?: string;
174
+ /**
175
+ * 当执行动作为 "Permit" 时,给匹配中的路由设置路由优先级,范围:[1,255],数值越小优先级越大
176
+ */
177
+ RoutePriority?: number;
178
+ /**
179
+ * 路由策略需要匹配的路由的所在地域数组
180
+ */
181
+ SrcRegions?: string[];
182
+ /**
183
+ * 路由策略需要匹配的路由的网络实例类型数组,限定取值:"VPC" / "UWAN-VRouter"
184
+ */
185
+ SrcNetworkTypes?: string[];
186
+ /**
187
+ * 路由策略需要作用的网络实例类型数组,限定取值:"VPC" / "UWAN-VRouter","Direction" 为 "In" 时,该值无效
188
+ */
189
+ DstNetworkTypes?: string[];
190
+ /**
191
+ *
192
+ */
193
+ DstNetworks?: {
194
+ /**
195
+ * 路由策略需要作用的网络实例ID数组,"Direction" 为 "In" 时,该值无效
196
+ */
197
+ NetworkId?: string;
198
+ }[];
199
+ };
200
+ }
201
+ /**
202
+ * AddRoutePolicy - 新增路由策略
203
+ */
204
+ export interface AddRoutePolicyResponse {
205
+ }
206
+ /**
207
+ * AttachUGNNetworks - 批量关联网络实例
208
+ */
209
+ export interface AttachUGNNetworksRequest {
210
+ /**
211
+ * UGN ID
212
+ */
213
+ UGNID: string;
214
+ /**
215
+ *
216
+ */
217
+ Networks?: {
218
+ /**
219
+ * 网络实例 ID,如 uvnet-xxxx
220
+ */
221
+ NetworkID: string;
222
+ /**
223
+ * 网络实例类型,枚举值:VPC/UCVR/...
224
+ */
225
+ Type: string;
226
+ /**
227
+ * 网络实例所属地域,如 cn-sh2
228
+ */
229
+ Region: string;
230
+ /**
231
+ * 网络实例所属项目名,如 org-xxx
232
+ */
233
+ OrgName: string;
234
+ }[];
235
+ }
236
+ /**
237
+ * AttachUGNNetworks - 批量关联网络实例
238
+ */
239
+ export interface AttachUGNNetworksResponse {
240
+ /**
241
+ * 数组,数组内每个元素的字段如下: NetworkID:string,网络实例 ID,如 uvnet-xxxx; Type:string,网络实例类型,枚举值:VPC/UCVR/...; Region:string,网络实例所属地域,如 cn-sh2; OrgName:string,网络实例所属项目名,如 org-xxx
242
+ */
243
+ Networks: {
244
+ /**
245
+ * 网络实例所在地域
246
+ */
247
+ Region: string;
248
+ /**
249
+ * 网络实例的ID,如 vnet-xxxxx
250
+ */
251
+ NetworkID: string;
252
+ /**
253
+ * 网络实例名称
254
+ */
255
+ Name: string;
256
+ /**
257
+ * 网络实例类型:VPC/UCVR/...
258
+ */
259
+ Type: string;
260
+ /**
261
+ * 网络实例所在项目名
262
+ */
263
+ OrgName: string;
264
+ /**
265
+ * 网络实例所属公司ID
266
+ */
267
+ CompanyID: number;
268
+ /**
269
+ * 网络实例所在地域ID
270
+ */
271
+ RegionID?: number;
272
+ /**
273
+ * 网络实例所在项目的ID
274
+ */
275
+ OrgID?: number;
276
+ /**
277
+ * 网络实例的唯一标识,如 vpc 的 tunnel_id
278
+ */
279
+ VNI?: number;
280
+ /**
281
+ * 创建时间
282
+ */
283
+ InsertTime?: number;
284
+ }[];
285
+ /**
286
+ * UGN ID
287
+ */
288
+ UGNID?: string;
289
+ }
290
+ /**
291
+ * CreateSimpleUGNBwPackage - 云联网简洁版创建带宽包
292
+ */
293
+ export interface CreateSimpleUGNBwPackageRequest {
294
+ /**
295
+ * ugn 资源 id
296
+ */
297
+ UGNID: string;
298
+ /**
299
+ * 地域 A 名称
300
+ */
301
+ RegionA: string;
302
+ /**
303
+ * 地域 B 名称
304
+ */
305
+ RegionB: string;
306
+ /**
307
+ * 购买的带宽值
308
+ */
309
+ BandWidth: number;
310
+ /**
311
+ * 计费模式 FixedBw:固定带宽|Max5:第五峰值|Traffic:流量计费 固定带宽:按月/按年 Max5:后付费 流量计费:后付费
312
+ */
313
+ PayMode: string;
314
+ /**
315
+ * 付费方式 Month:按月|Year:按年|PostPay:后付费|Count:按量
316
+ */
317
+ ChargeType: string;
318
+ /**
319
+ * 购买份数,主要用于预付费
320
+ */
321
+ Quantity: number;
322
+ /**
323
+ * 带宽包名称
324
+ */
325
+ Name?: string;
326
+ /**
327
+ * 备注
328
+ */
329
+ Remark?: string;
330
+ /**
331
+ * 服务质量 Diamond:钻石|Platinum:铂金|Gold:黄金
332
+ */
333
+ Qos?: string;
334
+ /**
335
+ * 智能路径 Delay:最低时延|IGP:普通线路|TCO:最低成本
336
+ */
337
+ Path?: string;
338
+ /**
339
+ * 代金券 id
340
+ */
341
+ CouponId?: string;
342
+ }
343
+ /**
344
+ * CreateSimpleUGNBwPackage - 云联网简洁版创建带宽包
345
+ */
346
+ export interface CreateSimpleUGNBwPackageResponse {
347
+ }
348
+ /**
349
+ * CreateUGN - 创建云联网
350
+ */
351
+ export interface CreateUGNRequest {
352
+ /**
353
+ * UGN名称
354
+ */
355
+ Name?: string;
356
+ /**
357
+ * 备注
358
+ */
359
+ Remark?: string;
360
+ /**
361
+ *
362
+ */
363
+ Networks?: {
364
+ /**
365
+ * 网络实例 ID,如 uvnet-xxxx
366
+ */
367
+ NetworkID?: string;
368
+ /**
369
+ * 网络实例类型,枚举值:VPC/UCVR/...
370
+ */
371
+ Type?: string;
372
+ /**
373
+ * 网络实例所属地域,如 cn-sh2
374
+ */
375
+ Region?: string;
376
+ /**
377
+ * 网络实例所属项目名,如 org-xxx
378
+ */
379
+ OrgName?: string;
380
+ }[];
381
+ }
382
+ /**
383
+ * CreateUGN - 创建云联网
384
+ */
385
+ export interface CreateUGNResponse {
386
+ /**
387
+ * UGN ID
388
+ */
389
+ UGNID?: string;
390
+ /**
391
+ * 网络实例列表
392
+ */
393
+ Networks?: {
394
+ /**
395
+ * 网络实例所在地域
396
+ */
397
+ Region: string;
398
+ /**
399
+ * 网络实例的ID,如 vnet-xxxxx
400
+ */
401
+ NetworkID: string;
402
+ /**
403
+ * 网络实例名称
404
+ */
405
+ Name: string;
406
+ /**
407
+ * 网络实例类型:VPC/UCVR/...
408
+ */
409
+ Type: string;
410
+ /**
411
+ * 网络实例所在项目名
412
+ */
413
+ OrgName: string;
414
+ /**
415
+ * 网络实例所属公司ID
416
+ */
417
+ CompanyID: number;
418
+ /**
419
+ * 网络实例所在地域ID
420
+ */
421
+ RegionID?: number;
422
+ /**
423
+ * 网络实例所在项目的ID
424
+ */
425
+ OrgID?: number;
426
+ /**
427
+ * 网络实例的唯一标识,如 vpc 的 tunnel_id
428
+ */
429
+ VNI?: number;
430
+ /**
431
+ * 创建时间
432
+ */
433
+ InsertTime?: number;
434
+ }[];
435
+ }
436
+ /**
437
+ * DelUGN - 删除云联网,仅云联网内无带宽包或网络实例时才可以被删除
438
+ */
439
+ export interface DelUGNRequest {
440
+ /**
441
+ * UGNID
442
+ */
443
+ UGNID: string;
444
+ }
445
+ /**
446
+ * DelUGN - 删除云联网,仅云联网内无带宽包或网络实例时才可以被删除
447
+ */
448
+ export interface DelUGNResponse {
449
+ }
450
+ /**
451
+ * DeleteRoutePolicy - 删除路由策略
452
+ */
453
+ export interface DeleteRoutePolicyRequest {
454
+ /**
455
+ * 云联网实例ID
456
+ */
457
+ UGNID: string;
458
+ /**
459
+ * 需要删除的路由策略ID数组
460
+ */
461
+ PolicyIds: string[];
462
+ }
463
+ /**
464
+ * DeleteRoutePolicy - 删除路由策略
465
+ */
466
+ export interface DeleteRoutePolicyResponse {
467
+ }
468
+ /**
469
+ * DeleteUGNBwPackage - 删除带宽包,互通地域仅保留默认带宽包
470
+ */
471
+ export interface DeleteUGNBwPackageRequest {
472
+ /**
473
+ * 带宽包ID
474
+ */
475
+ BwPackageID: string;
476
+ /**
477
+ * UGNID
478
+ */
479
+ UGNID: string;
480
+ }
481
+ /**
482
+ * DeleteUGNBwPackage - 删除带宽包,互通地域仅保留默认带宽包
483
+ */
484
+ export interface DeleteUGNBwPackageResponse {
485
+ }
486
+ /**
487
+ * DescribeSimpleUGN - 获取简洁版UGN详情
488
+ */
489
+ export interface DescribeSimpleUGNRequest {
490
+ /**
491
+ * UGN ID
492
+ */
493
+ UGNID: string;
494
+ }
495
+ /**
496
+ * DescribeSimpleUGN - 获取简洁版UGN详情
497
+ */
498
+ export interface DescribeSimpleUGNResponse {
499
+ /**
500
+ * 云联网实例基本信息
501
+ */
502
+ UGN: {
503
+ /**
504
+ * 云联网资源 ID
505
+ */
506
+ UGNID: string;
507
+ /**
508
+ * 云联网名称
509
+ */
510
+ Name: string;
511
+ /**
512
+ * 云联网备注
513
+ */
514
+ Remark: string;
515
+ /**
516
+ * 云联网创建时间
517
+ */
518
+ CreateTime: number;
519
+ /**
520
+ * 关联网络实例数量
521
+ */
522
+ NetworkCount: number;
523
+ /**
524
+ * 绑定带宽包数量
525
+ */
526
+ BwPackageCount: number;
527
+ /**
528
+ * 关联的路由策略数量
529
+ */
530
+ PolicyCount: number;
531
+ /**
532
+ * 申请待加入的网络数量
533
+ */
534
+ ApplyNetworksCount: number;
535
+ };
536
+ /**
537
+ * 加入云联网网络实例基本信息
538
+ */
539
+ Networks: {
540
+ /**
541
+ * 网络实例所在地域
542
+ */
543
+ Region: string;
544
+ /**
545
+ * 网络实例的ID,如 vnet-xxxxx
546
+ */
547
+ NetworkID: string;
548
+ /**
549
+ * 网络实例名称
550
+ */
551
+ Name: string;
552
+ /**
553
+ * 网络实例类型:VPC/HybridGW/...
554
+ */
555
+ Type: string;
556
+ /**
557
+ * 网络实例所在项目名
558
+ */
559
+ OrgName: string;
560
+ /**
561
+ * 网络实例所在地域ID
562
+ */
563
+ RegionID?: number;
564
+ /**
565
+ * 网络实例所在项目的ID
566
+ */
567
+ OrgID?: number;
568
+ /**
569
+ *
570
+ */
571
+ CreateTime?: number;
572
+ }[];
573
+ /**
574
+ * 云联网下的带宽基本信息
575
+ */
576
+ BwPackages: {
577
+ /**
578
+ * 带宽包 ID
579
+ */
580
+ PackageID: string;
581
+ /**
582
+ * UGN ID
583
+ */
584
+ UGNID: string;
585
+ /**
586
+ * 计费模式 FixedBw:固定带宽|Peak95:经典95|Max5:第五峰值|Traffic:流量计费
587
+ */
588
+ PayMode: string;
589
+ /**
590
+ * 地域A名称
591
+ */
592
+ RegionA: string;
593
+ /**
594
+ * 地域B名称
595
+ */
596
+ RegionB: string;
597
+ /**
598
+ * 带宽值
599
+ */
600
+ BandWidth: number;
601
+ /**
602
+ * 服务质量Diamond:钻石|Platinum:铂金|Gold:黄金
603
+ */
604
+ Qos: string;
605
+ /**
606
+ * 智能路径Delay:最低时延|IGP:普通线路|TCO:最低成本
607
+ */
608
+ Path: string;
609
+ /**
610
+ * 创建时间
611
+ */
612
+ CreateTime: number;
613
+ /**
614
+ * 带宽包名称
615
+ */
616
+ Name?: string;
617
+ /**
618
+ * 备注
619
+ */
620
+ Remark?: string;
621
+ /**
622
+ * 过期时间
623
+ */
624
+ ExpireTime?: number;
625
+ /**
626
+ * 带宽包切换状态
627
+ */
628
+ ChangeStatus?: number;
629
+ /**
630
+ * 带宽包切换时间
631
+ */
632
+ ChangeTime?: number;
633
+ /**
634
+ * 带宽包切换计费类型
635
+ */
636
+ ChangePayMode?: string;
637
+ }[];
638
+ /**
639
+ * 云联网下的路由基本信息
640
+ */
641
+ Routes: {
642
+ /**
643
+ * 目的网段
644
+ */
645
+ DstAddr?: string;
646
+ /**
647
+ * 下一跳网络实例 ID
648
+ */
649
+ NextHopID?: string;
650
+ /**
651
+ * 下一跳网络实例类型
652
+ */
653
+ NextHopType?: string;
654
+ /**
655
+ * 下一跳网络实例所属地域
656
+ */
657
+ NextHopRegion?: string;
658
+ /**
659
+ * 下一跳网络实例所属地域 id
660
+ */
661
+ NextHopRegionID?: number;
662
+ /**
663
+ * 路由优先级
664
+ */
665
+ Priority?: number;
666
+ /**
667
+ * true: 由于命中路由策略而失效
668
+ */
669
+ Deny?: boolean;
670
+ /**
671
+ * true: 由于优先级比其他前缀相同的路由低而失效
672
+ */
673
+ Restrict?: boolean;
674
+ /**
675
+ * true: 由于优先级相同但插入数据库的时间比其他前缀相同的路由晚而失效
676
+ */
677
+ Conflict?: boolean;
678
+ /**
679
+ * 匹配中的入向路由策略id
680
+ */
681
+ InPolicyId?: string;
682
+ /**
683
+ * 匹配中的入向路由策略名称
684
+ */
685
+ InPolicyName?: string;
686
+ /**
687
+ * 匹配中的出向路由策略id
688
+ */
689
+ OutPolicyId?: string;
690
+ /**
691
+ * 匹配中的出向路由策略名称
692
+ */
693
+ OutPolicyName?: string;
694
+ }[];
695
+ /**
696
+ * 云联网的路由策略基本信息
697
+ */
698
+ Policies?: {
699
+ /**
700
+ * 作用地域
701
+ */
702
+ Region?: string;
703
+ /**
704
+ * 路由策略ID
705
+ */
706
+ PolicyId?: string;
707
+ /**
708
+ * 路由策略名称,限定长度255
709
+ */
710
+ Name?: string;
711
+ /**
712
+ * 策略方向,限定取值:"In"/"Out"
713
+ */
714
+ Direction?: string;
715
+ /**
716
+ * 是否启用
717
+ */
718
+ Enabled?: boolean;
719
+ /**
720
+ * 策略优先级,范围:[1,255],数值越小优先级越大,同一方向,策略优先级不可重复
721
+ */
722
+ Priority?: number;
723
+ /**
724
+ * 策略执行动作,限定取值:"Permit"/"Deny"
725
+ */
726
+ Action?: string;
727
+ /**
728
+ * 当执行动作为 "Permit" 时,给匹配中的路由设置路由优先级,范围:[1,255],数值越小优先级越大
729
+ */
730
+ RoutePriority?: number;
731
+ /**
732
+ * 路由策略需要匹配的路由的所在地域数组
733
+ */
734
+ SrcRegions?: string[];
735
+ /**
736
+ * 路由策略需要匹配的路由的网络实例类型数组,限定取值:"VPC" / "UWAN-VRouter"
737
+ */
738
+ SrcNetworkTypes?: string[];
739
+ /**
740
+ * 路由策略需要匹配的路由的网络实例类型以及该实例下的网段信息
741
+ */
742
+ SrcNetworks?: {
743
+ /**
744
+ * 网络实例ID
745
+ */
746
+ NetworkId?: string;
747
+ /**
748
+ * 网络实例上报的网段
749
+ */
750
+ Prefixes?: string[];
751
+ }[];
752
+ /**
753
+ * 路由策略需要作用的网络实例类型数组,限定取值:"VPC" / "UWAN-VRouter"
754
+ */
755
+ DstNetworkTypes?: string[];
756
+ /**
757
+ * 路由策略需要作用的网络实例ID
758
+ */
759
+ DstNetworks?: {
760
+ /**
761
+ * 网络实例ID
762
+ */
763
+ NetworkId?: string;
764
+ /**
765
+ * 网络实例上报的网段
766
+ */
767
+ Prefixes?: string[];
768
+ }[];
769
+ /**
770
+ * 创建时间
771
+ */
772
+ CreateTime?: number;
773
+ /**
774
+ * 是否匹配中路由
775
+ */
776
+ Matched?: boolean;
777
+ }[];
778
+ }
779
+ /**
780
+ * DetachUGNNetworks - 批量解除关联网络实例
781
+ */
782
+ export interface DetachUGNNetworksRequest {
783
+ /**
784
+ * UGNID
785
+ */
786
+ UGNID: string;
787
+ /**
788
+ * 网络实例 ID
789
+ */
790
+ Networks: string[];
791
+ }
792
+ /**
793
+ * DetachUGNNetworks - 批量解除关联网络实例
794
+ */
795
+ export interface DetachUGNNetworksResponse {
796
+ /**
797
+ * 数组,数组内每个元素的字段如下: NetworkID:string,网络实例 ID,如 uvnet-xxxx; Type:string,网络实例类型,枚举值:VPC/UCVR/...; Region:string,网络实例所属地域,如 cn-sh2; OrgName:string,网络实例所属项目名,如 org-xxx
798
+ */
799
+ Networks: {
800
+ /**
801
+ * 网络实例所在地域
802
+ */
803
+ Region: string;
804
+ /**
805
+ * 网络实例的ID,如 vnet-xxxxx
806
+ */
807
+ NetworkID: string;
808
+ /**
809
+ * 网络实例名称
810
+ */
811
+ Name: string;
812
+ /**
813
+ * 网络实例类型:VPC/UCVR/...
814
+ */
815
+ Type: string;
816
+ /**
817
+ * 网络实例所在项目名
818
+ */
819
+ OrgName: string;
820
+ /**
821
+ * 网络实例所属公司ID
822
+ */
823
+ CompanyID: number;
824
+ /**
825
+ * 网络实例所在地域ID
826
+ */
827
+ RegionID?: number;
828
+ /**
829
+ * 网络实例所在项目的ID
830
+ */
831
+ OrgID?: number;
832
+ /**
833
+ * 网络实例的唯一标识,如 vpc 的 tunnel_id
834
+ */
835
+ VNI?: number;
836
+ /**
837
+ * 创建时间
838
+ */
839
+ InsertTime?: number;
840
+ }[];
841
+ /**
842
+ * UGN ID
843
+ */
844
+ UGNID?: string;
845
+ }
846
+ /**
847
+ * EnableRoutePolicy - 启用\停用路由策略
848
+ */
849
+ export interface EnableRoutePolicyRequest {
850
+ /**
851
+ * 云联网实例ID
852
+ */
853
+ UGNID: string;
854
+ /**
855
+ * 路由策略ID
856
+ */
857
+ PolicyId: string;
858
+ /**
859
+ * 是否启用
860
+ */
861
+ Enable: boolean;
862
+ }
863
+ /**
864
+ * EnableRoutePolicy - 启用\停用路由策略
865
+ */
866
+ export interface EnableRoutePolicyResponse {
867
+ }
868
+ /**
869
+ * GetSimpleBuyBwPrice - 获取简洁版带宽包价格
870
+ */
871
+ export interface GetSimpleBuyBwPriceRequest {
872
+ /**
873
+ * 地域 A 名称
874
+ */
875
+ RegionA: string;
876
+ /**
877
+ * 地域 B 名称
878
+ */
879
+ RegionB: string;
880
+ /**
881
+ * 计费模式 FixedBw:固定带宽|Max5:第五峰值|Traffic:流量计费 固定带宽:按月/按年 Max5:后付费 流量计费:按量付费
882
+ */
883
+ PayMode: string;
884
+ /**
885
+ * 付费方式 Month:按月|Year:按年|PostPay:后付费|Count:按量
886
+ */
887
+ ChargeType: string;
888
+ /**
889
+ * 服务质量 Diamond:钻石|Platinum:铂金|Gold:黄金
890
+ */
891
+ Qos: string;
892
+ /**
893
+ * 智能路径 Delay:最低时延|IGP:普通线路|TCO:最低成本
894
+ */
895
+ Path: string;
896
+ /**
897
+ * 购买的带宽值,默认为1
898
+ */
899
+ BandWidth?: number;
900
+ }
901
+ /**
902
+ * GetSimpleBuyBwPrice - 获取简洁版带宽包价格
903
+ */
904
+ export interface GetSimpleBuyBwPriceResponse {
905
+ /**
906
+ * 最终价格 = 原价 * 用户折扣 * 产品折扣
907
+ */
908
+ TotalPrice: number;
909
+ /**
910
+ * 客户折扣价 = 原价 * 用户折扣
911
+ */
912
+ CustomPrice: number;
913
+ /**
914
+ * 原价
915
+ */
916
+ OriginalPrice: number;
917
+ }
918
+ /**
919
+ * GetSimpleUGNBwPackages - 获取指定云联网内的带宽包
920
+ */
921
+ export interface GetSimpleUGNBwPackagesRequest {
922
+ /**
923
+ * UGN ID
924
+ */
925
+ UGNID: string;
926
+ /**
927
+ * 偏移量,默认0
928
+ */
929
+ Offset?: number;
930
+ /**
931
+ * 分页大小,默认20
932
+ */
933
+ Limit?: number;
934
+ /**
935
+ * 带宽包ID列表,不填查询UGN下全部带宽包
936
+ */
937
+ PackageIds?: string[];
938
+ }
939
+ /**
940
+ * GetSimpleUGNBwPackages - 获取指定云联网内的带宽包
941
+ */
942
+ export interface GetSimpleUGNBwPackagesResponse {
943
+ /**
944
+ * 带宽包列表
945
+ */
946
+ BwPackages: {
947
+ /**
948
+ * 带宽包 ID
949
+ */
950
+ PackageID: string;
951
+ /**
952
+ * UGN ID
953
+ */
954
+ UGNID: string;
955
+ /**
956
+ * 计费模式 FixedBw:固定带宽|Peak95:经典95|Max5:第五峰值|Traffic:流量计费
957
+ */
958
+ PayMode: string;
959
+ /**
960
+ * 地域A名称
961
+ */
962
+ RegionA: string;
963
+ /**
964
+ * 地域B名称
965
+ */
966
+ RegionB: string;
967
+ /**
968
+ * 带宽值
969
+ */
970
+ BandWidth: number;
971
+ /**
972
+ * 服务质量Diamond:钻石|Platinum:铂金|Gold:黄金
973
+ */
974
+ Qos: string;
975
+ /**
976
+ * 智能路径Delay:最低时延|IGP:普通线路|TCO:最低成本
977
+ */
978
+ Path: string;
979
+ /**
980
+ * 创建时间
981
+ */
982
+ CreateTime: number;
983
+ /**
984
+ * 带宽包名称
985
+ */
986
+ Name?: string;
987
+ /**
988
+ * 备注
989
+ */
990
+ Remark?: string;
991
+ /**
992
+ * 过期时间
993
+ */
994
+ ExpireTime?: number;
995
+ /**
996
+ * 带宽包切换状态
997
+ */
998
+ ChangeStatus?: number;
999
+ /**
1000
+ * 带宽包切换时间
1001
+ */
1002
+ ChangeTime?: number;
1003
+ /**
1004
+ * 带宽包切换计费类型
1005
+ */
1006
+ ChangePayMode?: string;
1007
+ }[];
1008
+ /**
1009
+ * 带宽包数量
1010
+ */
1011
+ TotalCount: number;
1012
+ /**
1013
+ * 偏移量
1014
+ */
1015
+ Offset: number;
1016
+ /**
1017
+ * 分页大小
1018
+ */
1019
+ Limit: number;
1020
+ }
1021
+ /**
1022
+ * GetSwitchableBillingModes - 获取带宽包可以切换的计费类型
1023
+ */
1024
+ export interface GetSwitchableBillingModesRequest {
1025
+ /**
1026
+ * 带宽包 id
1027
+ */
1028
+ BwPackageID: string;
1029
+ }
1030
+ /**
1031
+ * GetSwitchableBillingModes - 获取带宽包可以切换的计费类型
1032
+ */
1033
+ export interface GetSwitchableBillingModesResponse {
1034
+ /**
1035
+ * 支持的计费类型。FixedBw:固定带宽,Traffic:流量计费,Max5:第五峰值。
1036
+ */
1037
+ PayModes: string[];
1038
+ }
1039
+ /**
1040
+ * GetUGNRouteTable - 获取云联网路由表
1041
+ */
1042
+ export interface GetUGNRouteTableRequest {
1043
+ /**
1044
+ * 云联网实例ID
1045
+ */
1046
+ UGNID: string;
1047
+ /**
1048
+ * 路由表类型,分为初始路由表、中阶路由表以及最终路由表,限定取值:"Origin"/"Middle"/"Final"
1049
+ */
1050
+ Type: string;
1051
+ }
1052
+ /**
1053
+ * GetUGNRouteTable - 获取云联网路由表
1054
+ */
1055
+ export interface GetUGNRouteTableResponse {
1056
+ /**
1057
+ * 云联网实例ID
1058
+ */
1059
+ UGNID: string;
1060
+ /**
1061
+ * 路由表,"Origin"/"Middle" 用这个
1062
+ */
1063
+ Routes: {
1064
+ /**
1065
+ * 目的网段
1066
+ */
1067
+ DstAddr?: string;
1068
+ /**
1069
+ * 下一跳网络实例 ID
1070
+ */
1071
+ NextHopID?: string;
1072
+ /**
1073
+ * 下一跳网络实例类型
1074
+ */
1075
+ NextHopType?: string;
1076
+ /**
1077
+ * 下一跳网络实例所属地域
1078
+ */
1079
+ NextHopRegion?: string;
1080
+ /**
1081
+ * 下一跳网络实例所属地域 id
1082
+ */
1083
+ NextHopRegionID?: number;
1084
+ /**
1085
+ * 路由优先级
1086
+ */
1087
+ Priority?: number;
1088
+ /**
1089
+ * true: 由于命中路由策略而失效
1090
+ */
1091
+ Deny?: boolean;
1092
+ /**
1093
+ * true: 由于优先级比其他前缀相同的路由低而失效
1094
+ */
1095
+ Restrict?: boolean;
1096
+ /**
1097
+ * true: 由于优先级相同但插入数据库的时间比其他前缀相同的路由晚而失效
1098
+ */
1099
+ Conflict?: boolean;
1100
+ /**
1101
+ * 匹配中的入向路由策略id
1102
+ */
1103
+ InPolicyId?: string;
1104
+ /**
1105
+ * 匹配中的入向路由策略名称
1106
+ */
1107
+ InPolicyName?: string;
1108
+ /**
1109
+ * 匹配中的出向路由策略id
1110
+ */
1111
+ OutPolicyId?: string;
1112
+ /**
1113
+ * 匹配中的出向路由策略名称
1114
+ */
1115
+ OutPolicyName?: string;
1116
+ }[];
1117
+ /**
1118
+ * 网络实例对应的路由表,"Final" 用这个
1119
+ */
1120
+ VRoutes: {
1121
+ /**
1122
+ * 网络实例ID
1123
+ */
1124
+ NetworkId?: string;
1125
+ /**
1126
+ * 该网络实例对应的路由
1127
+ */
1128
+ Routes?: {
1129
+ /**
1130
+ * 目的网段
1131
+ */
1132
+ DstAddr?: string;
1133
+ /**
1134
+ * 下一跳网络实例 ID
1135
+ */
1136
+ NextHopID?: string;
1137
+ /**
1138
+ * 下一跳网络实例类型
1139
+ */
1140
+ NextHopType?: string;
1141
+ /**
1142
+ * 下一跳网络实例所属地域
1143
+ */
1144
+ NextHopRegion?: string;
1145
+ /**
1146
+ * 下一跳网络实例所属地域 id
1147
+ */
1148
+ NextHopRegionID?: number;
1149
+ /**
1150
+ * 路由优先级
1151
+ */
1152
+ Priority?: number;
1153
+ /**
1154
+ * true: 由于命中路由策略而失效
1155
+ */
1156
+ Deny?: boolean;
1157
+ /**
1158
+ * true: 由于优先级比其他前缀相同的路由低而失效
1159
+ */
1160
+ Restrict?: boolean;
1161
+ /**
1162
+ * true: 由于优先级相同但插入数据库的时间比其他前缀相同的路由晚而失效
1163
+ */
1164
+ Conflict?: boolean;
1165
+ /**
1166
+ * 匹配中的入向路由策略id
1167
+ */
1168
+ InPolicyId?: string;
1169
+ /**
1170
+ * 匹配中的入向路由策略名称
1171
+ */
1172
+ InPolicyName?: string;
1173
+ /**
1174
+ * 匹配中的出向路由策略id
1175
+ */
1176
+ OutPolicyId?: string;
1177
+ /**
1178
+ * 匹配中的出向路由策略名称
1179
+ */
1180
+ OutPolicyName?: string;
1181
+ }[];
1182
+ }[];
1183
+ }
1184
+ /**
1185
+ * ListSimpleBwPackage - 获取当前项目下的带宽包列表
1186
+ */
1187
+ export interface ListSimpleBwPackageRequest {
1188
+ /**
1189
+ * 偏移量,默认0
1190
+ */
1191
+ Offset?: number;
1192
+ /**
1193
+ * 分页大小,默认20
1194
+ */
1195
+ Limit?: number;
1196
+ }
1197
+ /**
1198
+ * ListSimpleBwPackage - 获取当前项目下的带宽包列表
1199
+ */
1200
+ export interface ListSimpleBwPackageResponse {
1201
+ /**
1202
+ * 带宽包数量
1203
+ */
1204
+ TotalCount: number;
1205
+ /**
1206
+ * 偏移量
1207
+ */
1208
+ Offset: number;
1209
+ /**
1210
+ * 分页大小
1211
+ */
1212
+ Limit: number;
1213
+ /**
1214
+ * 带宽包列表
1215
+ */
1216
+ BwPackages: {
1217
+ /**
1218
+ * 带宽包 ID
1219
+ */
1220
+ PackageID: string;
1221
+ /**
1222
+ * UGN ID
1223
+ */
1224
+ UGNID: string;
1225
+ /**
1226
+ * 计费模式 FixedBw:固定带宽|Peak95:经典95|Max5:第五峰值|Traffic:流量计费
1227
+ */
1228
+ PayMode: string;
1229
+ /**
1230
+ * 地域A名称
1231
+ */
1232
+ RegionA: string;
1233
+ /**
1234
+ * 地域B名称
1235
+ */
1236
+ RegionB: string;
1237
+ /**
1238
+ * 带宽值
1239
+ */
1240
+ BandWidth: number;
1241
+ /**
1242
+ * 服务质量Diamond:钻石|Platinum:铂金|Gold:黄金
1243
+ */
1244
+ Qos: string;
1245
+ /**
1246
+ * 智能路径Delay:最低时延|IGP:普通线路|TCO:最低成本
1247
+ */
1248
+ Path: string;
1249
+ /**
1250
+ * 创建时间
1251
+ */
1252
+ CreateTime: number;
1253
+ /**
1254
+ * 带宽包名称
1255
+ */
1256
+ Name?: string;
1257
+ /**
1258
+ * 备注
1259
+ */
1260
+ Remark?: string;
1261
+ /**
1262
+ * 过期时间
1263
+ */
1264
+ ExpireTime?: number;
1265
+ /**
1266
+ * 带宽包切换状态
1267
+ */
1268
+ ChangeStatus?: number;
1269
+ /**
1270
+ * 带宽包切换时间
1271
+ */
1272
+ ChangeTime?: number;
1273
+ /**
1274
+ * 带宽包切换计费类型
1275
+ */
1276
+ ChangePayMode?: string;
1277
+ }[];
1278
+ }
1279
+ /**
1280
+ * ListUGN - 获取当前项目下所有云联网资源
1281
+ */
1282
+ export interface ListUGNRequest {
1283
+ /**
1284
+ * 分页大小,默认20
1285
+ */
1286
+ Limit?: number;
1287
+ /**
1288
+ * 偏移量,默认0
1289
+ */
1290
+ Offset?: number;
1291
+ }
1292
+ /**
1293
+ * ListUGN - 获取当前项目下所有云联网资源
1294
+ */
1295
+ export interface ListUGNResponse {
1296
+ /**
1297
+ * UGN 列表
1298
+ */
1299
+ UGNs: {
1300
+ /**
1301
+ * 云联网资源 ID
1302
+ */
1303
+ UGNID: string;
1304
+ /**
1305
+ * 云联网名称
1306
+ */
1307
+ Name: string;
1308
+ /**
1309
+ * 云联网备注
1310
+ */
1311
+ Remark: string;
1312
+ /**
1313
+ * 云联网创建时间
1314
+ */
1315
+ CreateTime: number;
1316
+ /**
1317
+ * 关联网络实例数量
1318
+ */
1319
+ NetworkCount: number;
1320
+ /**
1321
+ * 绑定带宽包数量
1322
+ */
1323
+ BwPackageCount: number;
1324
+ /**
1325
+ * 关联的路由策略数量
1326
+ */
1327
+ PolicyCount: number;
1328
+ /**
1329
+ * 申请待加入的网络数量
1330
+ */
1331
+ ApplyNetworksCount: number;
1332
+ }[];
1333
+ /**
1334
+ * UGN数量
1335
+ */
1336
+ TotalCount?: number;
1337
+ /**
1338
+ * 偏移量
1339
+ */
1340
+ Offset?: number;
1341
+ /**
1342
+ * 分页大小
1343
+ */
1344
+ Limit?: number;
1345
+ }
1346
+ /**
1347
+ * ListUGNRegions - 获取UGN的可加入地域列表
1348
+ */
1349
+ export interface ListUGNRegionsRequest {
1350
+ /**
1351
+ * 数组,已选区域,例如:cn-bj2, cn-wlcb
1352
+ */
1353
+ SelectedRegions?: string[];
1354
+ }
1355
+ /**
1356
+ * ListUGNRegions - 获取UGN的可加入地域列表
1357
+ */
1358
+ export interface ListUGNRegionsResponse {
1359
+ /**
1360
+ * 可加入地域列表
1361
+ */
1362
+ RegionLIst: {
1363
+ /**
1364
+ * 地域名称
1365
+ */
1366
+ Region: string;
1367
+ /**
1368
+ * 地域ID
1369
+ */
1370
+ RegIonId: number;
1371
+ /**
1372
+ * 是否为海外地域
1373
+ */
1374
+ IsOverseas: boolean;
1375
+ /**
1376
+ * 是否上线
1377
+ */
1378
+ IsOnline: boolean;
1379
+ /**
1380
+ * 添加region需要做的校验
1381
+ */
1382
+ Needs?: string[];
1383
+ }[];
1384
+ }
1385
+ /**
1386
+ * ModifyUGNBandwidth - 修改云联网带宽大小
1387
+ */
1388
+ export interface ModifyUGNBandwidthRequest {
1389
+ /**
1390
+ * 带宽包id
1391
+ */
1392
+ PackageID: string;
1393
+ /**
1394
+ * 云联网id
1395
+ */
1396
+ UGNID: string;
1397
+ /**
1398
+ * 带宽值
1399
+ */
1400
+ BandWidth: number;
1401
+ }
1402
+ /**
1403
+ * ModifyUGNBandwidth - 修改云联网带宽大小
1404
+ */
1405
+ export interface ModifyUGNBandwidthResponse {
1406
+ }
1407
+ /**
1408
+ * SendUGNApplyNetwork - 跨账号网络实例申请加入 UGN
1409
+ */
1410
+ export interface SendUGNApplyNetworkRequest {
1411
+ /**
1412
+ * 可用区。参见 [可用区列表](https://docs.ucloud.cn/api/summary/regionlist)
1413
+ */
1414
+ Zone?: string;
1415
+ /**
1416
+ * 网络实例 ID,如 uvnet-xxxx
1417
+ */
1418
+ NetworkID: string;
1419
+ /**
1420
+ * 网络实例类型,枚举值:VPC/UWAN-VRouter/...
1421
+ */
1422
+ NetworkType: string;
1423
+ /**
1424
+ * 网络实例所属地域,如 cn-sh2
1425
+ */
1426
+ NetworkRegion: string;
1427
+ /**
1428
+ * 网络实例所属项目名,如 org-xxx
1429
+ */
1430
+ NetworkOrgName: string;
1431
+ /**
1432
+ * UGN id
1433
+ */
1434
+ UGNID: string;
1435
+ /**
1436
+ * UGN所属公司 id
1437
+ */
1438
+ UGNCompanyID: number;
1439
+ }
1440
+ /**
1441
+ * SendUGNApplyNetwork - 跨账号网络实例申请加入 UGN
1442
+ */
1443
+ export interface SendUGNApplyNetworkResponse {
1444
+ }
1445
+ /**
1446
+ * UpdateRoutePolicy - 修改路由策略
1447
+ */
1448
+ export interface UpdateRoutePolicyRequest {
1449
+ /**
1450
+ * 云联网实例ID
1451
+ */
1452
+ UGNID: string;
1453
+ /**
1454
+ *
1455
+ */
1456
+ Policy?: {
1457
+ /**
1458
+ * 路由策略ID
1459
+ */
1460
+ PolicyId: string;
1461
+ /**
1462
+ * 策略名称,限定长度 255
1463
+ */
1464
+ Name?: string;
1465
+ /**
1466
+ * 策略方向,限定取值:"In"/"Out"
1467
+ */
1468
+ Direction?: string;
1469
+ /**
1470
+ * 策略优先级,范围:[1,255],数值越小优先级越大,同一方向,策略优先级不可重复
1471
+ */
1472
+ Priority?: number;
1473
+ /**
1474
+ * 策略执行动作,限定取值:"Permit"/"Deny"
1475
+ */
1476
+ RouteAction?: string;
1477
+ /**
1478
+ * 当执行动作为 "Permit" 时,给匹配中的路由设置路由优先级,范围:[1,255],数值越小优先级越大
1479
+ */
1480
+ RoutePriority?: number;
1481
+ /**
1482
+ * 路由策略需要匹配的路由的所在地域数组
1483
+ */
1484
+ SrcRegions?: string[];
1485
+ /**
1486
+ * 路由策略需要匹配的路由的网络实例类型数组,限定取值:"VPC" / "UWAN-VRouter"
1487
+ */
1488
+ SrcNetworkTypes?: string[];
1489
+ /**
1490
+ *
1491
+ */
1492
+ SrcNetworks?: {
1493
+ /**
1494
+ * 路由策略需要匹配的路由的网络实例ID数组
1495
+ */
1496
+ NetworkId?: string;
1497
+ /**
1498
+ * 路由策略需要匹配的路由的网络实例下的网段数组
1499
+ */
1500
+ Prefixes?: string[];
1501
+ }[];
1502
+ /**
1503
+ * 路由策略需要作用的网络实例类型数组,限定取值:"VPC" / "UWAN-VRouter"
1504
+ */
1505
+ DstNetworkTypes?: string[];
1506
+ /**
1507
+ *
1508
+ */
1509
+ DstNetworks?: {
1510
+ /**
1511
+ * 路由策略需要作用的网络实例ID数组
1512
+ */
1513
+ NetworkId?: string;
1514
+ }[];
1515
+ };
1516
+ }
1517
+ /**
1518
+ * UpdateRoutePolicy - 修改路由策略
1519
+ */
1520
+ export interface UpdateRoutePolicyResponse {
1521
+ }