@alicloud/ecd20201002 2.1.1 → 2.1.3

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/dist/client.d.ts CHANGED
@@ -1,15 +1,67 @@
1
1
  /**
2
- *
3
2
  */
4
3
  import * as $Util from '@alicloud/tea-util';
5
4
  import OpenApi, * as $OpenApi from '@alicloud/openapi-client';
6
5
  import * as $tea from '@alicloud/tea-typescript';
6
+ export declare class OssUploadCredential extends $tea.Model {
7
+ accessKeyId?: string;
8
+ endpoint?: string;
9
+ filePath?: string;
10
+ ossPolicy?: string;
11
+ ossSignature?: string;
12
+ stsToken?: string;
13
+ static names(): {
14
+ [key: string]: string;
15
+ };
16
+ static types(): {
17
+ [key: string]: any;
18
+ };
19
+ constructor(map?: {
20
+ [key: string]: any;
21
+ });
22
+ }
7
23
  export declare class ApproveFotaUpdateRequest extends $tea.Model {
24
+ /**
25
+ * @remarks
26
+ * This parameter is required.
27
+ *
28
+ * @example
29
+ * 0.0.1-D-20220513.14****
30
+ */
8
31
  appVersion?: string;
32
+ /**
33
+ * @remarks
34
+ * This parameter is required.
35
+ *
36
+ * @example
37
+ * d4452bd7-88df-4b90-a409-806da674****
38
+ */
9
39
  clientId?: string;
40
+ /**
41
+ * @example
42
+ * ecd-138dsptkrt00u****
43
+ */
10
44
  desktopId?: string;
45
+ /**
46
+ * @remarks
47
+ * This parameter is required.
48
+ *
49
+ * @example
50
+ * v18390c954ce59e2915ef16663205371721e0db9a46179ac89249a203320459523cb54ad08efe324784dd0eba25950****
51
+ */
11
52
  loginToken?: string;
53
+ /**
54
+ * @remarks
55
+ * This parameter is required.
56
+ *
57
+ * @example
58
+ * cn-hangzhou
59
+ */
12
60
  regionId?: string;
61
+ /**
62
+ * @example
63
+ * 4771b873-c757-4893-973c-7f5beejh****
64
+ */
13
65
  sessionId?: string;
14
66
  uuid?: string;
15
67
  static names(): {
@@ -23,6 +75,10 @@ export declare class ApproveFotaUpdateRequest extends $tea.Model {
23
75
  });
24
76
  }
25
77
  export declare class ApproveFotaUpdateResponseBody extends $tea.Model {
78
+ /**
79
+ * @example
80
+ * 1CBAFFAB-B697-4049-A9B1-67E1FC5F****
81
+ */
26
82
  requestId?: string;
27
83
  static names(): {
28
84
  [key: string]: string;
@@ -51,13 +107,66 @@ export declare class ApproveFotaUpdateResponse extends $tea.Model {
51
107
  });
52
108
  }
53
109
  export declare class ChangePasswordRequest extends $tea.Model {
110
+ /**
111
+ * @remarks
112
+ * This parameter is required.
113
+ *
114
+ * @example
115
+ * 42f6645a-9c3c-4772-be2a-cc5f5732****
116
+ */
54
117
  clientId?: string;
118
+ /**
119
+ * @remarks
120
+ * This parameter is required.
121
+ *
122
+ * @example
123
+ * liming
124
+ */
55
125
  endUserId?: string;
126
+ /**
127
+ * @remarks
128
+ * This parameter is required.
129
+ *
130
+ * @example
131
+ * v18101ac6a9e69c66b04a163031680463660b4b216cd758f34b60b9ad6a7c7f7334b83dd8f75eef4209c68f9f1080b****
132
+ */
56
133
  loginToken?: string;
134
+ /**
135
+ * @remarks
136
+ * This parameter is required.
137
+ *
138
+ * @example
139
+ * 67436290
140
+ */
57
141
  newPassword?: string;
142
+ /**
143
+ * @remarks
144
+ * This parameter is required.
145
+ *
146
+ * @example
147
+ * cn-shanghai+dir-227468****
148
+ */
58
149
  officeSiteId?: string;
150
+ /**
151
+ * @remarks
152
+ * This parameter is required.
153
+ *
154
+ * @example
155
+ * 12345678
156
+ */
59
157
  oldPassword?: string;
158
+ /**
159
+ * @remarks
160
+ * This parameter is required.
161
+ *
162
+ * @example
163
+ * cn-hangzhou
164
+ */
60
165
  regionId?: string;
166
+ /**
167
+ * @example
168
+ * 1
169
+ */
61
170
  sessionId?: string;
62
171
  static names(): {
63
172
  [key: string]: string;
@@ -70,7 +179,15 @@ export declare class ChangePasswordRequest extends $tea.Model {
70
179
  });
71
180
  }
72
181
  export declare class ChangePasswordResponseBody extends $tea.Model {
182
+ /**
183
+ * @example
184
+ * v18101ac6a9e69c66b04a163031680463660b4b216cd758f34b60b9ad6a7c7f7334b83dd8f75eef4209c68f9f1080b****
185
+ */
73
186
  loginToken?: string;
187
+ /**
188
+ * @example
189
+ * 484256DA-D816-44D2-9D86-B6EE4D5B****
190
+ */
74
191
  requestId?: string;
75
192
  static names(): {
76
193
  [key: string]: string;
@@ -99,11 +216,50 @@ export declare class ChangePasswordResponse extends $tea.Model {
99
216
  });
100
217
  }
101
218
  export declare class DeleteFingerPrintTemplateRequest extends $tea.Model {
219
+ /**
220
+ * @remarks
221
+ * This parameter is required.
222
+ *
223
+ * @example
224
+ * 59e86b39-ccac-4dfa-93d7-1f724052****
225
+ */
102
226
  clientId?: string;
227
+ /**
228
+ * @example
229
+ * 40401e62-5caf-4508-8de7-bf98af12****
230
+ */
103
231
  clientToken?: string;
232
+ /**
233
+ * @remarks
234
+ * This parameter is required.
235
+ *
236
+ * @example
237
+ * 1
238
+ */
104
239
  index?: number;
240
+ /**
241
+ * @remarks
242
+ * This parameter is required.
243
+ *
244
+ * @example
245
+ * v1c0436c721786529914f16516396228454fa6284c9b80f9917f25ebbec2aa30c10343e3f6f9aff64500ce13808aef****
246
+ */
105
247
  loginToken?: string;
248
+ /**
249
+ * @remarks
250
+ * This parameter is required.
251
+ *
252
+ * @example
253
+ * cn-hangzhou
254
+ */
106
255
  regionId?: string;
256
+ /**
257
+ * @remarks
258
+ * This parameter is required.
259
+ *
260
+ * @example
261
+ * 6df06330-3b75-4768-b334-41a73a64****
262
+ */
107
263
  sessionId?: string;
108
264
  static names(): {
109
265
  [key: string]: string;
@@ -116,6 +272,10 @@ export declare class DeleteFingerPrintTemplateRequest extends $tea.Model {
116
272
  });
117
273
  }
118
274
  export declare class DeleteFingerPrintTemplateResponseBody extends $tea.Model {
275
+ /**
276
+ * @example
277
+ * 134BD0B2-B848-5743-9CE2-C1FD3D5F****
278
+ */
119
279
  requestId?: string;
120
280
  static names(): {
121
281
  [key: string]: string;
@@ -144,8 +304,22 @@ export declare class DeleteFingerPrintTemplateResponse extends $tea.Model {
144
304
  });
145
305
  }
146
306
  export declare class DescribeDirectoriesRequest extends $tea.Model {
307
+ /**
308
+ * @remarks
309
+ * This parameter is required.
310
+ *
311
+ * @example
312
+ * 54c17e1d-2d72-4b87-aa33-25f3b3f2****
313
+ */
147
314
  clientId?: string;
148
315
  directoryId?: string[];
316
+ /**
317
+ * @remarks
318
+ * This parameter is required.
319
+ *
320
+ * @example
321
+ * cn-hangzhou
322
+ */
149
323
  regionId?: string;
150
324
  static names(): {
151
325
  [key: string]: string;
@@ -159,6 +333,10 @@ export declare class DescribeDirectoriesRequest extends $tea.Model {
159
333
  }
160
334
  export declare class DescribeDirectoriesResponseBody extends $tea.Model {
161
335
  directories?: DescribeDirectoriesResponseBodyDirectories[];
336
+ /**
337
+ * @example
338
+ * F369A091-002F-49C8-AD55-02A77629****
339
+ */
162
340
  requestId?: string;
163
341
  static names(): {
164
342
  [key: string]: string;
@@ -187,9 +365,37 @@ export declare class DescribeDirectoriesResponse extends $tea.Model {
187
365
  });
188
366
  }
189
367
  export declare class DescribeFingerPrintTemplatesRequest extends $tea.Model {
368
+ /**
369
+ * @remarks
370
+ * This parameter is required.
371
+ *
372
+ * @example
373
+ * 61e39dc6-0450-45f6-a372-2a09e938****
374
+ */
190
375
  clientId?: string;
376
+ /**
377
+ * @remarks
378
+ * This parameter is required.
379
+ *
380
+ * @example
381
+ * v189646d6f329e4dfcbf51653542202890570fec26e4f9ee26427c5920fcd93871f017d2190199c4c7d0c0bf00f573****
382
+ */
191
383
  loginToken?: string;
384
+ /**
385
+ * @remarks
386
+ * This parameter is required.
387
+ *
388
+ * @example
389
+ * cn-hangzhou
390
+ */
192
391
  regionId?: string;
392
+ /**
393
+ * @remarks
394
+ * This parameter is required.
395
+ *
396
+ * @example
397
+ * a5062d68-e550-4d09-8288-67c8ba9e****
398
+ */
193
399
  sessionId?: string;
194
400
  static names(): {
195
401
  [key: string]: string;
@@ -203,6 +409,10 @@ export declare class DescribeFingerPrintTemplatesRequest extends $tea.Model {
203
409
  }
204
410
  export declare class DescribeFingerPrintTemplatesResponseBody extends $tea.Model {
205
411
  fingerPrintTemplates?: DescribeFingerPrintTemplatesResponseBodyFingerPrintTemplates[];
412
+ /**
413
+ * @example
414
+ * 9C1D3FBE-84E1-5ABB-AD98-2003AC71****
415
+ */
206
416
  requestId?: string;
207
417
  static names(): {
208
418
  [key: string]: string;
@@ -231,24 +441,105 @@ export declare class DescribeFingerPrintTemplatesResponse extends $tea.Model {
231
441
  });
232
442
  }
233
443
  export declare class DescribeGlobalDesktopsRequest extends $tea.Model {
444
+ /**
445
+ * @remarks
446
+ * This parameter is required.
447
+ *
448
+ * @example
449
+ * c213150d-7ac3-432c-b749-6e1e090b****
450
+ */
234
451
  clientId?: string;
452
+ /**
453
+ * @example
454
+ * INTERNET
455
+ */
235
456
  desktopAccessType?: string;
236
457
  desktopId?: string[];
458
+ /**
459
+ * @example
460
+ * DesktopTest
461
+ */
237
462
  desktopName?: string;
463
+ /**
464
+ * @example
465
+ * Running
466
+ */
238
467
  desktopStatus?: string;
468
+ /**
469
+ * @example
470
+ * cn-hangzhou+dir-880841****
471
+ */
239
472
  directoryId?: string;
473
+ /**
474
+ * @remarks
475
+ * 关键字。支持模糊搜索桌面ID、云桌面名称和终端用户自定义的桌面名称。
476
+ *
477
+ * @example
478
+ * ecd
479
+ */
240
480
  keyword?: string;
481
+ /**
482
+ * @example
483
+ * cn-hangzhou
484
+ */
241
485
  loginRegionId?: string;
486
+ /**
487
+ * @remarks
488
+ * This parameter is required.
489
+ *
490
+ * @example
491
+ * v147c9114a180489f89691663893169****
492
+ */
242
493
  loginToken?: string;
494
+ /**
495
+ * @example
496
+ * 500
497
+ */
243
498
  maxResults?: number;
499
+ /**
500
+ * @example
501
+ * eyJkZWZhdWx0IjpbIjk2MjEy****
502
+ */
244
503
  nextToken?: string;
504
+ /**
505
+ * @example
506
+ * cn-hangzhou+dir-880841****
507
+ */
245
508
  officeSiteId?: string;
509
+ /**
510
+ * @example
511
+ * AssignTime
512
+ */
246
513
  orderBy?: string;
514
+ /**
515
+ * @example
516
+ * true
517
+ */
247
518
  queryFotaUpdate?: boolean;
519
+ /**
520
+ * @example
521
+ * cn-shanghai
522
+ */
248
523
  regionId?: string;
524
+ /**
525
+ * @example
526
+ * cn-shanghai
527
+ */
249
528
  searchRegionId?: string;
529
+ /**
530
+ * @example
531
+ * 5c456a41-1e65-4e72-ab4d-5dcfff52****
532
+ */
250
533
  sessionId?: string;
534
+ /**
535
+ * @example
536
+ * ASC
537
+ */
251
538
  sortType?: string;
539
+ /**
540
+ * @example
541
+ * true
542
+ */
252
543
  withoutLatency?: boolean;
253
544
  static names(): {
254
545
  [key: string]: string;
@@ -262,7 +553,15 @@ export declare class DescribeGlobalDesktopsRequest extends $tea.Model {
262
553
  }
263
554
  export declare class DescribeGlobalDesktopsResponseBody extends $tea.Model {
264
555
  desktops?: DescribeGlobalDesktopsResponseBodyDesktops[];
556
+ /**
557
+ * @example
558
+ * eyJkZWZhdWx0IjpbIjIwMjItMDgtMTdUM****
559
+ */
265
560
  nextToken?: string;
561
+ /**
562
+ * @example
563
+ * 4686A731-D601-548C-83E2-4CB6371E****
564
+ */
266
565
  requestId?: string;
267
566
  static names(): {
268
567
  [key: string]: string;
@@ -291,8 +590,22 @@ export declare class DescribeGlobalDesktopsResponse extends $tea.Model {
291
590
  });
292
591
  }
293
592
  export declare class DescribeOfficeSitesRequest extends $tea.Model {
593
+ /**
594
+ * @remarks
595
+ * This parameter is required.
596
+ *
597
+ * @example
598
+ * 42f6645a-9c3c-4772-be2a-cc5f5732****
599
+ */
294
600
  clientId?: string;
295
601
  officeSiteId?: string[];
602
+ /**
603
+ * @remarks
604
+ * This parameter is required.
605
+ *
606
+ * @example
607
+ * cn-hangzhou
608
+ */
296
609
  regionId?: string;
297
610
  static names(): {
298
611
  [key: string]: string;
@@ -306,6 +619,10 @@ export declare class DescribeOfficeSitesRequest extends $tea.Model {
306
619
  }
307
620
  export declare class DescribeOfficeSitesResponseBody extends $tea.Model {
308
621
  officeSites?: DescribeOfficeSitesResponseBodyOfficeSites[];
622
+ /**
623
+ * @example
624
+ * 1CBAFFAB-B697-4049-A9B1-67E1FC5F****
625
+ */
309
626
  requestId?: string;
310
627
  static names(): {
311
628
  [key: string]: string;
@@ -334,7 +651,18 @@ export declare class DescribeOfficeSitesResponse extends $tea.Model {
334
651
  });
335
652
  }
336
653
  export declare class DescribeRegionsRequest extends $tea.Model {
654
+ /**
655
+ * @remarks
656
+ * This parameter is required.
657
+ *
658
+ * @example
659
+ * ac4a73ad-789a-449a-a88f-d18571d6****
660
+ */
337
661
  clientId?: string;
662
+ /**
663
+ * @example
664
+ * cn-hangzhou
665
+ */
338
666
  regionId?: string;
339
667
  static names(): {
340
668
  [key: string]: string;
@@ -348,6 +676,10 @@ export declare class DescribeRegionsRequest extends $tea.Model {
348
676
  }
349
677
  export declare class DescribeRegionsResponseBody extends $tea.Model {
350
678
  regions?: DescribeRegionsResponseBodyRegions[];
679
+ /**
680
+ * @example
681
+ * 1CBAFFAB-B697-4049-A9B1-67E1FC5F****
682
+ */
351
683
  requestId?: string;
352
684
  static names(): {
353
685
  [key: string]: string;
@@ -376,13 +708,54 @@ export declare class DescribeRegionsResponse extends $tea.Model {
376
708
  });
377
709
  }
378
710
  export declare class DescribeSnapshotsRequest extends $tea.Model {
711
+ /**
712
+ * @remarks
713
+ * This parameter is required.
714
+ *
715
+ * @example
716
+ * 16dad2b6-3c6d-4e4c-b057-78ecb13c****
717
+ */
379
718
  clientId?: string;
719
+ /**
720
+ * @example
721
+ * ecd-gx2x1dhsmucyy****
722
+ */
380
723
  desktopId?: string;
724
+ /**
725
+ * @remarks
726
+ * This parameter is required.
727
+ *
728
+ * @example
729
+ * v16abfb945208fc5745061668654680853da4a25202d1a394fcad57bba484e9827ad43ea7d10fb6bf13d44a4adc0e9****
730
+ */
381
731
  loginToken?: string;
732
+ /**
733
+ * @example
734
+ * 10
735
+ */
382
736
  maxResults?: number;
737
+ /**
738
+ * @example
739
+ * AAAAAV3MpHK1AP0pfERHZN5pu6nmB7qrRFJ8vmttjxPL****
740
+ */
383
741
  nextToken?: string;
742
+ /**
743
+ * @remarks
744
+ * This parameter is required.
745
+ *
746
+ * @example
747
+ * cn-hangzhou
748
+ */
384
749
  regionId?: string;
750
+ /**
751
+ * @example
752
+ * a99b9aca-bac5-4da2-819e-400ce98f****
753
+ */
385
754
  sessionId?: string;
755
+ /**
756
+ * @example
757
+ * s-2ze81owrnv9pity4****
758
+ */
386
759
  snapshotId?: string;
387
760
  static names(): {
388
761
  [key: string]: string;
@@ -395,7 +768,15 @@ export declare class DescribeSnapshotsRequest extends $tea.Model {
395
768
  });
396
769
  }
397
770
  export declare class DescribeSnapshotsResponseBody extends $tea.Model {
771
+ /**
772
+ * @example
773
+ * AAAAAV3MpHK1AP0pfERHZN5pu6nmB7qrRFJ8vmttjxPL****
774
+ */
398
775
  nextToken?: string;
776
+ /**
777
+ * @example
778
+ * 51592A88-0F2C-55E6-AD2C-2AD9C10D****
779
+ */
399
780
  requestId?: string;
400
781
  snapshots?: DescribeSnapshotsResponseBodySnapshots[];
401
782
  static names(): {
@@ -425,12 +806,55 @@ export declare class DescribeSnapshotsResponse extends $tea.Model {
425
806
  });
426
807
  }
427
808
  export declare class EncryptPasswordRequest extends $tea.Model {
809
+ /**
810
+ * @remarks
811
+ * This parameter is required.
812
+ *
813
+ * @example
814
+ * 1d40776f-e9cb-4e2b-a8da-308d10e8****
815
+ */
428
816
  clientId?: string;
817
+ /**
818
+ * @example
819
+ * cn-beijing+dir-131196****
820
+ */
429
821
  directoryId?: string;
822
+ /**
823
+ * @remarks
824
+ * This parameter is required.
825
+ *
826
+ * @example
827
+ * v1b16dcff3ab21a6c5ec01652238375511cff5a1db59fd4dc49afb37e2ea7a626af6f38109fd0498b6abd9de1af7743****
828
+ */
430
829
  loginToken?: string;
830
+ /**
831
+ * @example
832
+ * cn-beijing+dir-131196****
833
+ */
431
834
  officeSiteId?: string;
835
+ /**
836
+ * @remarks
837
+ * This parameter is required.
838
+ *
839
+ * @example
840
+ * Ab123456
841
+ */
432
842
  password?: string;
843
+ /**
844
+ * @remarks
845
+ * This parameter is required.
846
+ *
847
+ * @example
848
+ * cn-beijing
849
+ */
433
850
  regionId?: string;
851
+ /**
852
+ * @remarks
853
+ * This parameter is required.
854
+ *
855
+ * @example
856
+ * c78e2e52-23d9-4401-a648-e67ac6ff****
857
+ */
434
858
  sessionId?: string;
435
859
  static names(): {
436
860
  [key: string]: string;
@@ -443,7 +867,15 @@ export declare class EncryptPasswordRequest extends $tea.Model {
443
867
  });
444
868
  }
445
869
  export declare class EncryptPasswordResponseBody extends $tea.Model {
870
+ /**
871
+ * @example
872
+ * d34601bc-e6b1-4433-b0cc-8f6c5e52;n4apvGub3OBoj4Grwg==;thhO4UEomJfdvwnwlA==
873
+ */
446
874
  encryptedPassword?: string;
875
+ /**
876
+ * @example
877
+ * AF538DA8-FFC6-52DA-8FF8-7B92579F****
878
+ */
447
879
  requestId?: string;
448
880
  static names(): {
449
881
  [key: string]: string;
@@ -472,10 +904,30 @@ export declare class EncryptPasswordResponse extends $tea.Model {
472
904
  });
473
905
  }
474
906
  export declare class GetCloudDriveServiceMountTokenRequest extends $tea.Model {
907
+ /**
908
+ * @example
909
+ * 00e122c3-13fb-4fc3-bc7a-5d9acb89****
910
+ */
475
911
  clientId?: string;
912
+ /**
913
+ * @example
914
+ * v1972cd3446f0e523598916520951742474e6624fcdea6652994d47bc6157d27f7cc900c339db67882j3no4nh5bk3b4****
915
+ */
476
916
  loginToken?: string;
917
+ /**
918
+ * @example
919
+ * cn-hangzhou+dir-7186763****
920
+ */
477
921
  officeSiteId?: string;
922
+ /**
923
+ * @example
924
+ * cn-hangzhou
925
+ */
478
926
  regionId?: string;
927
+ /**
928
+ * @example
929
+ * 14e1fe41-ce9b-491d-aa8c-345jk2n4bk****
930
+ */
479
931
  sessionId?: string;
480
932
  static names(): {
481
933
  [key: string]: string;
@@ -488,6 +940,10 @@ export declare class GetCloudDriveServiceMountTokenRequest extends $tea.Model {
488
940
  });
489
941
  }
490
942
  export declare class GetCloudDriveServiceMountTokenResponseBody extends $tea.Model {
943
+ /**
944
+ * @example
945
+ * DC27288A-F9E1-5092-9B5B-71C27D15****
946
+ */
491
947
  requestId?: string;
492
948
  token?: GetCloudDriveServiceMountTokenResponseBodyToken;
493
949
  static names(): {
@@ -517,18 +973,63 @@ export declare class GetCloudDriveServiceMountTokenResponse extends $tea.Model {
517
973
  });
518
974
  }
519
975
  export declare class GetConnectionTicketRequest extends $tea.Model {
976
+ /**
977
+ * @remarks
978
+ * This parameter is required.
979
+ *
980
+ * @example
981
+ * f4a0dc8e-1702-4728-9a60-95b27a35****
982
+ */
520
983
  clientId?: string;
984
+ /**
985
+ * @example
986
+ * Windows_NT 10.0.18363 x64
987
+ */
521
988
  clientOS?: string;
989
+ /**
990
+ * @example
991
+ * windows
992
+ */
522
993
  clientType?: string;
994
+ /**
995
+ * @example
996
+ * 2.1.0-R-20210731.151756
997
+ */
523
998
  clientVersion?: string;
524
999
  commandContent?: string;
1000
+ /**
1001
+ * @example
1002
+ * ecd-gx2x1dhsmucyy****
1003
+ */
525
1004
  desktopId?: string;
1005
+ /**
1006
+ * @remarks
1007
+ * This parameter is required.
1008
+ *
1009
+ * @example
1010
+ * v18101ac6a9e69c66b04a163031680463660b4b216cd758f34b60b9ad6a7c7f7334b83dd8f75eef4209c68f9f1080b****
1011
+ */
526
1012
  loginToken?: string;
527
1013
  ownerId?: number;
1014
+ /**
1015
+ * @remarks
1016
+ * This parameter is required.
1017
+ *
1018
+ * @example
1019
+ * cn-hangzhou
1020
+ */
528
1021
  regionId?: string;
529
1022
  resourceOwnerAccount?: string;
530
1023
  resourceOwnerId?: number;
1024
+ /**
1025
+ * @example
1026
+ * cd45e873-650d-4d70-acb9-f996187a****
1027
+ */
531
1028
  sessionId?: string;
1029
+ /**
1030
+ * @example
1031
+ * 2afbad19-778a-4fc5-9674-1f19c638****
1032
+ */
532
1033
  taskId?: string;
533
1034
  uuid?: string;
534
1035
  static names(): {
@@ -542,11 +1043,27 @@ export declare class GetConnectionTicketRequest extends $tea.Model {
542
1043
  });
543
1044
  }
544
1045
  export declare class GetConnectionTicketResponseBody extends $tea.Model {
1046
+ /**
1047
+ * @example
1048
+ * 1CBAFFAB-B697-4049-A9B1-67E1FC5F****
1049
+ */
545
1050
  requestId?: string;
546
1051
  taskCode?: string;
1052
+ /**
1053
+ * @example
1054
+ * 2afbad19-778a-4fc5-9674-1f19c63862da
1055
+ */
547
1056
  taskId?: string;
548
1057
  taskMessage?: string;
1058
+ /**
1059
+ * @example
1060
+ * FINISHED
1061
+ */
549
1062
  taskStatus?: string;
1063
+ /**
1064
+ * @example
1065
+ * W0VuY29kaW5nXQ0KSW5wdXRFbmNvZGluZz1V********
1066
+ */
550
1067
  ticket?: string;
551
1068
  static names(): {
552
1069
  [key: string]: string;
@@ -575,23 +1092,179 @@ export declare class GetConnectionTicketResponse extends $tea.Model {
575
1092
  });
576
1093
  }
577
1094
  export declare class GetLoginTokenRequest extends $tea.Model {
1095
+ /**
1096
+ * @remarks
1097
+ * The verification code that is generated by the virtual MFA device. This parameter is required if you set `CurrentStage` to `MFAVerify`.
1098
+ *
1099
+ * @example
1100
+ * 47****
1101
+ */
578
1102
  authenticationCode?: string;
1103
+ /**
1104
+ * @remarks
1105
+ * The ID of the Alibaba Cloud Workspace client. The system generates a unique ID for each client.
1106
+ *
1107
+ * This parameter is required.
1108
+ *
1109
+ * @example
1110
+ * f4a0dc8e-1702-4728-9a60-95b27a35****
1111
+ */
579
1112
  clientId?: string;
1113
+ /**
1114
+ * @remarks
1115
+ * The operating system (OS) of the device that runs an Alibaba Cloud Workspace client.
1116
+ *
1117
+ * @example
1118
+ * Windows_NT 10.0.1**** x64
1119
+ */
580
1120
  clientOS?: string;
1121
+ /**
1122
+ * @remarks
1123
+ * The type of Alibaba Cloud Workspace clients.
1124
+ *
1125
+ * Valid values:
1126
+ *
1127
+ * * HTML5: web client.
1128
+ *
1129
+ * * WINDOWS: Windows client.
1130
+ *
1131
+ * * MACOS: macOS client.
1132
+ *
1133
+ * * IOS: iOS client.
1134
+ *
1135
+ * * ANDROID: Android client.
1136
+ *
1137
+ * @example
1138
+ * Windows
1139
+ */
581
1140
  clientType?: string;
1141
+ /**
1142
+ * @remarks
1143
+ * The version of the client. When you use an Alibaba Cloud Workspace client, you can view the client version in the **About** dialog box on the client logon page.
1144
+ *
1145
+ * @example
1146
+ * 2.1.0-R-20210731.1****
1147
+ */
582
1148
  clientVersion?: string;
1149
+ /**
1150
+ * @remarks
1151
+ * The logon authentication stage. Valid values:
1152
+ *
1153
+ * * `ADPassword`: the stage to verify the identity of the Active Directory (AD) user. You must specify the value when the system verifies the identity of a convenience account or an AD account.
1154
+ * * `MFABind: the stage to bind a virtual multi-factor authentication (MFA) device.`
1155
+ * * `MFAVerify: the stage to verify the verification code that is generated by the virtual MFA device.`
1156
+ * * `TokenVerify`: the stage to perform two-factor authentication on an Alibaba Cloud Workspace client (hereinafter referred to as the client).
1157
+ * * `ChangePassword`: the stage to change the password of the user.
1158
+ * * `KeepAliveVerify`: the stage to obtain LoginToken if KeepAliveToken is valid.
1159
+ *
1160
+ * @example
1161
+ * ADPassword
1162
+ */
583
1163
  currentStage?: string;
1164
+ /**
1165
+ * @remarks
1166
+ * The office network ID. This parameter has the same meaning as `OfficeSiteId`. We recommend that you replace `DirectoryId` with `OfficeSiteId`. You can specify a value for `DirectoryId` or `OfficeSiteId`.
1167
+ *
1168
+ * @example
1169
+ * cn-hangzhou+dir-885351****
1170
+ */
584
1171
  directoryId?: string;
1172
+ /**
1173
+ * @remarks
1174
+ * The name of the convenience user or the AD user. This parameter is required if you set `CurrentStage` to `ADPassword`.
1175
+ *
1176
+ * @example
1177
+ * alice
1178
+ */
585
1179
  endUserId?: string;
1180
+ /**
1181
+ * @remarks
1182
+ * Specifies whether to keep the user logged on to the client.
1183
+ * Valid values:
1184
+ * * null: Default value. Do not keep the user logged on to the client.
1185
+ * * true: Keep the user logged on to the client.
1186
+ * * false: Do not keep the user logged on to the client.
1187
+ *
1188
+ * @example
1189
+ * false
1190
+ */
586
1191
  keepAlive?: boolean;
1192
+ /**
1193
+ * @remarks
1194
+ * The token to keep logging on to an Alibaba Cloud Workspace client. When an end user logs on to the Alibaba Cloud Workspace client and select Auto Sign-in, `KeepAliveToken` is returned after you call this operation. Within the valid period of the returned token``, you can call the `GetLoginToken` operation and set `CurrentStage` to `KeepAliveVerify`. Then, you can obtain LoginToken. If you set `CurrentStage` to `KeepAliveVerify`, `KeepAliveToken` is required.
1195
+ *
1196
+ * @example
1197
+ * hide
1198
+ */
587
1199
  keepAliveToken?: string;
1200
+ /**
1201
+ * @remarks
1202
+ * The new password. This parameter is required if you set `CurrentStage` to `ChangePassword`.
1203
+ *
1204
+ * @example
1205
+ * NewPassword
1206
+ */
588
1207
  newPassword?: string;
1208
+ /**
1209
+ * @remarks
1210
+ * The office network ID.
1211
+ *
1212
+ * @example
1213
+ * cn-hangzhou+dir-885351****
1214
+ */
589
1215
  officeSiteId?: string;
1216
+ /**
1217
+ * @remarks
1218
+ * The current password. This parameter is required if you set `CurrentStage` to `ChangePassword`.
1219
+ *
1220
+ * @example
1221
+ * OldPassword
1222
+ */
590
1223
  oldPassword?: string;
1224
+ /**
1225
+ * @remarks
1226
+ * The password of the convenience user or the AD user. This parameter is required if you set `CurrentStage` to `ADPassword`.
1227
+ *
1228
+ * @example
1229
+ * Password1234
1230
+ */
591
1231
  password?: string;
1232
+ /**
1233
+ * @remarks
1234
+ * The region ID. You can call the [DescribeRegions](https://help.aliyun.com/document_detail/196646.html) operation to query the regions supported by EDS.
1235
+ *
1236
+ * This parameter is required.
1237
+ *
1238
+ * @example
1239
+ * cn-hangzhou
1240
+ */
592
1241
  regionId?: string;
1242
+ /**
1243
+ * @remarks
1244
+ * The ID of the session.
1245
+ *
1246
+ * * If the virtual multi-factor authentication (MFA) device is not bound or two-factor authentication is not enabled for the client, you do not need to specify a value for `SessionId`.
1247
+ * * If the virtual MFA device is not bound or two-factor authentication is enabled for the client, you must specify a value for `SessionId` to verify the user identity after you specify a value for `ADPassword`. The value of the `SessionId` parameter is returned only if the CurrentStage parameter is set to `ADPassword` when you call the `GetLoginToken` operation.
1248
+ *
1249
+ * @example
1250
+ * cd45e873-650d-4d70-acb9-f996187a****
1251
+ */
593
1252
  sessionId?: string;
1253
+ /**
1254
+ * @remarks
1255
+ * If two-factor authentication is enabled for Alibaba Cloud Workspace terminals in the EDS console and the system detects that the current logon user is exposed to risks, the system sends a verification code to the email address of the user. This parameter is required if you set `CurrentStage` to `TokenVerify`.
1256
+ *
1257
+ * @example
1258
+ * 63****
1259
+ */
594
1260
  tokenCode?: string;
1261
+ /**
1262
+ * @remarks
1263
+ * The unique identifier of the client. When you use an Alibaba Cloud Workspace client, you can view the client version in the **About** dialog box on the client logon page.
1264
+ *
1265
+ * @example
1266
+ * C78CA9E99315687575DD2844C1F3****
1267
+ */
595
1268
  uuid?: string;
596
1269
  static names(): {
597
1270
  [key: string]: string;
@@ -604,23 +1277,153 @@ export declare class GetLoginTokenRequest extends $tea.Model {
604
1277
  });
605
1278
  }
606
1279
  export declare class GetLoginTokenResponseBody extends $tea.Model {
1280
+ /**
1281
+ * @remarks
1282
+ * The email address of the user. The system returns the email address in the return value of the LoginToken parameter after the user logs on to the client.
1283
+ *
1284
+ * * For a convenience user, the return value is the email address specified when the administrator creates the convenience user.
1285
+ * * For an AD user, the return value is in the following format: `Username@Name of the AD domain`.
1286
+ *
1287
+ * @example
1288
+ * alice
1289
+ */
607
1290
  email?: string;
1291
+ /**
1292
+ * @remarks
1293
+ * The account of the convenience user or the AD user.
1294
+ *
1295
+ * @example
1296
+ * alice
1297
+ */
608
1298
  endUserId?: string;
1299
+ /**
1300
+ * @remarks
1301
+ * > This is a parameter only for internal use.
1302
+ *
1303
+ * @example
1304
+ * edu
1305
+ */
609
1306
  industry?: string;
1307
+ /**
1308
+ * @remarks
1309
+ * The token used to keep the user logged on. After the user logs on to the client and select the Keep Logon option, `KeepAliveToken` is returned when you call the operation. If the user does not select the Keep Logon option, null is returned.
1310
+ *
1311
+ * @example
1312
+ * 006YwvYMsesWWsDBZnVB+Wq9AvJDVIqOY3YCktvtb7+KxMb3ClnNlV8+l/knhZYrXUmeP06IzkjF+IgcZ3vZKOyMprDyFHjCy1r27FRE/U7+geWCl8iQ+yF8GaCRHfJEkC2+ROs93HkT4tfHxyY1J8W7O7ZQGUC/cdCvm+cCP6FIy73IUuPuVR6PcKYXIpEZPW
1313
+ */
610
1314
  keepAliveToken?: string;
1315
+ /**
1316
+ * @remarks
1317
+ * The attribute of the convenience user. For an AD user, null is returned.
1318
+ *
1319
+ * @example
1320
+ * test:sample
1321
+ */
611
1322
  label?: string;
1323
+ /**
1324
+ * @remarks
1325
+ * The logon token.
1326
+ *
1327
+ * @example
1328
+ * v18101ac6a9e69c66b04a163031680463660b4b216cd758f34b60b9ad6a7c7f7334b83dd8f75eef4209c68f9f1080b****
1329
+ */
612
1330
  loginToken?: string;
1331
+ /**
1332
+ * @remarks
1333
+ * The next stage that is expected to enter. For example, an administrator enables MFA in the EDS console. When an end user enters the password, that is, the end user completes the `ADPassword` stage, this parameter returns `MFAVerify`. This indicates that MFA is required.
1334
+ *
1335
+ * > For more information about the authentication stages, see the `CurrentStage` parameter.
1336
+ *
1337
+ * @example
1338
+ * MFAVerify
1339
+ */
613
1340
  nextStage?: string;
614
- phone?: string;
615
- props?: {
616
- [key: string]: string;
1341
+ /**
1342
+ * @remarks
1343
+ * > This is a parameter only for internal use.
1344
+ */
1345
+ passwordStrategy?: GetLoginTokenResponseBodyPasswordStrategy;
1346
+ /**
1347
+ * @remarks
1348
+ * Enter the mobile number of the convenience user. For an AD user, null is returned.
1349
+ *
1350
+ * @example
1351
+ * 1381111****
1352
+ */
1353
+ phone?: string;
1354
+ /**
1355
+ * @remarks
1356
+ * > This is a parameter only for internal use.
1357
+ */
1358
+ props?: {
1359
+ [key: string]: string;
617
1360
  };
1361
+ /**
1362
+ * @remarks
1363
+ * The QR code that is generated when the virtual MFA device is bound. The value is encoded in Base64. This parameter can be empty. This parameter is required only when the CurrentStage parameter is set to `MFABind`.
1364
+ *
1365
+ * > For more information about each authentication stage, see the parameter description of the request parameter `CurrentStage`.
1366
+ *
1367
+ * @example
1368
+ * 5OCLLKKOJU5HPBX66H3QCTWY******
1369
+ */
618
1370
  qrCodePng?: string;
1371
+ /**
1372
+ * @remarks
1373
+ * > This is a parameter only for internal use.
1374
+ *
1375
+ * @example
1376
+ * null
1377
+ */
1378
+ reason?: string;
1379
+ /**
1380
+ * @remarks
1381
+ * The ID of the request.
1382
+ *
1383
+ * @example
1384
+ * 1CBAFFAB-B697-4049-A9B1-67E1FC5F****
1385
+ */
619
1386
  requestId?: string;
1387
+ /**
1388
+ * @remarks
1389
+ * Risk identification information regarding the signin process.
1390
+ */
620
1391
  riskVerifyInfo?: GetLoginTokenResponseBodyRiskVerifyInfo;
1392
+ /**
1393
+ * @remarks
1394
+ * The key that is generated when you bind the virtual MFA device. This parameter is required when the CurrentStage parameter is set to `MFABind`.
1395
+ *
1396
+ * > For more information about each authentication stage, see the parameter description of the request parameter `CurrentStage`.
1397
+ *
1398
+ * @example
1399
+ * 5OCLLKKOJU5HPBX66H3QCTWYI7MH****
1400
+ */
621
1401
  secret?: string;
1402
+ /**
1403
+ * @remarks
1404
+ * The ID of the session. The ID is returned the first time you call the `GetLoginToken` operation in the session. If MFA is required, you must specify this parameter in subsequent stages.
1405
+ *
1406
+ * > For more information about each authentication stage, see the parameter description of the request parameter `CurrentStage`.
1407
+ *
1408
+ * @example
1409
+ * d6ec166d-ab93-4286-bf7f-a18bb929****
1410
+ */
622
1411
  sessionId?: string;
1412
+ /**
1413
+ * @remarks
1414
+ * The ID of the Alibaba Cloud account. The ID is used for hardware client authentication.
1415
+ *
1416
+ * @example
1417
+ * 166353906220****
1418
+ */
623
1419
  tenantId?: number;
1420
+ /**
1421
+ * @remarks
1422
+ * > This is a parameter only for internal use.
1423
+ *
1424
+ * @example
1425
+ * mode
1426
+ */
624
1427
  windowDisplayMode?: string;
625
1428
  static names(): {
626
1429
  [key: string]: string;
@@ -649,8 +1452,23 @@ export declare class GetLoginTokenResponse extends $tea.Model {
649
1452
  });
650
1453
  }
651
1454
  export declare class IsKeepAliveRequest extends $tea.Model {
1455
+ /**
1456
+ * @remarks
1457
+ * This parameter is required.
1458
+ *
1459
+ * @example
1460
+ * f4a0dc8e-1702-4728-9a60-95b27a35****
1461
+ */
652
1462
  clientId?: string;
1463
+ /**
1464
+ * @example
1465
+ * cn-hangzhou+dir-885351****
1466
+ */
653
1467
  officeSiteId?: string;
1468
+ /**
1469
+ * @example
1470
+ * cn-hangzhou
1471
+ */
654
1472
  regionId?: string;
655
1473
  static names(): {
656
1474
  [key: string]: string;
@@ -663,9 +1481,25 @@ export declare class IsKeepAliveRequest extends $tea.Model {
663
1481
  });
664
1482
  }
665
1483
  export declare class IsKeepAliveResponseBody extends $tea.Model {
1484
+ /**
1485
+ * @example
1486
+ * True
1487
+ */
666
1488
  isKeepAlive?: boolean;
1489
+ /**
1490
+ * @example
1491
+ * cn-hangzhou+dir-885351****
1492
+ */
667
1493
  officeSiteId?: string;
1494
+ /**
1495
+ * @example
1496
+ * 1CBAFFAB-B697-4049-A9B1-67E1FC5F****
1497
+ */
668
1498
  requestId?: string;
1499
+ /**
1500
+ * @example
1501
+ * 141631846826****
1502
+ */
669
1503
  tenantId?: string;
670
1504
  static names(): {
671
1505
  [key: string]: string;
@@ -737,15 +1571,91 @@ export declare class QueryEdsAgentReportConfigResponse extends $tea.Model {
737
1571
  });
738
1572
  }
739
1573
  export declare class RebootDesktopsRequest extends $tea.Model {
1574
+ /**
1575
+ * @remarks
1576
+ * The client ID. The system generates a unique ID for each client.
1577
+ *
1578
+ * This parameter is required.
1579
+ *
1580
+ * @example
1581
+ * f4a0dc8e-1702-4728-9a60-95b27a35****
1582
+ */
740
1583
  clientId?: string;
1584
+ /**
1585
+ * @remarks
1586
+ * The operating system (OS) of the device that runs the Alibaba Cloud Workspace client (hereinafter referred to as WUYING client).
1587
+ *
1588
+ * @example
1589
+ * Windows_NT 10.0.18363 x64
1590
+ */
741
1591
  clientOS?: string;
1592
+ /**
1593
+ * @remarks
1594
+ * The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length. For more information, see [How do I ensure the idempotence of a request?](https://help.aliyun.com/document_detail/25693.html)
1595
+ *
1596
+ * @example
1597
+ * 40401e62-5caf-4508-8de7-bf98af12****
1598
+ */
742
1599
  clientToken?: string;
1600
+ /**
1601
+ * @remarks
1602
+ * The client version. If you use a WUYING client, you can view the client version in the **About** dialog box on the client logon page.
1603
+ *
1604
+ * @example
1605
+ * 2.1.0-R-20210731.151756
1606
+ */
743
1607
  clientVersion?: string;
1608
+ /**
1609
+ * @remarks
1610
+ * The IDs of the cloud computers. You can specify the IDs of 1 to 20 cloud computers.
1611
+ *
1612
+ * This parameter is required.
1613
+ *
1614
+ * @example
1615
+ * ecd-7w78ozhjcwa3u****
1616
+ */
744
1617
  desktopId?: string[];
1618
+ /**
1619
+ * @remarks
1620
+ * The logon token.
1621
+ *
1622
+ * @example
1623
+ * v18101ac6a9e69c66b04a163031680463660b4b216cd758f34b60b9ad6a7c7f7334b83dd8f75eef4209c68f9f1080b****
1624
+ */
745
1625
  loginToken?: string;
1626
+ /**
1627
+ * @remarks
1628
+ * The region ID. You can call the [DescribeRegions](https://help.aliyun.com/document_detail/196646.html) operation to query the regions supported by WUYING Workspace.
1629
+ *
1630
+ * This parameter is required.
1631
+ *
1632
+ * @example
1633
+ * cn-hangzhou
1634
+ */
746
1635
  regionId?: string;
1636
+ /**
1637
+ * @remarks
1638
+ * The session ID.
1639
+ *
1640
+ * @example
1641
+ * cd45e873-650d-4d70-acb9-f996187a****
1642
+ */
747
1643
  sessionId?: string;
1644
+ /**
1645
+ * @remarks
1646
+ * The logon token.
1647
+ *
1648
+ * @example
1649
+ * 04b7b80a0b020715c5c1b4175fc4771698****9e2a759557a4624665fd53ae40
1650
+ */
748
1651
  sessionToken?: string;
1652
+ /**
1653
+ * @remarks
1654
+ * The UUID of the client.
1655
+ *
1656
+ * @example
1657
+ * 91761ED27169E2FC564F29388E2D****
1658
+ */
749
1659
  uuid?: string;
750
1660
  static names(): {
751
1661
  [key: string]: string;
@@ -758,6 +1668,13 @@ export declare class RebootDesktopsRequest extends $tea.Model {
758
1668
  });
759
1669
  }
760
1670
  export declare class RebootDesktopsResponseBody extends $tea.Model {
1671
+ /**
1672
+ * @remarks
1673
+ * The request ID.
1674
+ *
1675
+ * @example
1676
+ * 1CBAFFAB-B697-4049-A9B1-67E1FC5F****
1677
+ */
761
1678
  requestId?: string;
762
1679
  static names(): {
763
1680
  [key: string]: string;
@@ -786,12 +1703,52 @@ export declare class RebootDesktopsResponse extends $tea.Model {
786
1703
  });
787
1704
  }
788
1705
  export declare class RefreshLoginTokenRequest extends $tea.Model {
1706
+ /**
1707
+ * @remarks
1708
+ * This parameter is required.
1709
+ *
1710
+ * @example
1711
+ * f4a0dc8e-1702-4728-9a60-95b27a35****
1712
+ */
789
1713
  clientId?: string;
1714
+ /**
1715
+ * @example
1716
+ * cn-hangzhou+dir-jedbpr4sl9l37****
1717
+ */
790
1718
  directoryId?: string;
1719
+ /**
1720
+ * @remarks
1721
+ * This parameter is required.
1722
+ *
1723
+ * @example
1724
+ * alice
1725
+ */
791
1726
  endUserId?: string;
1727
+ /**
1728
+ * @remarks
1729
+ * This parameter is required.
1730
+ *
1731
+ * @example
1732
+ * v18101ac6a9e69c66b04a163031680463660b4b216cd758f34b60b9ad6a7c7f7334b83dd8f75eef4209c68f9f1080b****
1733
+ */
792
1734
  loginToken?: string;
1735
+ /**
1736
+ * @example
1737
+ * cn-shanghai+dir-238191****
1738
+ */
793
1739
  officeSiteId?: string;
1740
+ /**
1741
+ * @remarks
1742
+ * This parameter is required.
1743
+ *
1744
+ * @example
1745
+ * cn-hangzhou
1746
+ */
794
1747
  regionId?: string;
1748
+ /**
1749
+ * @example
1750
+ * cd45e873-650d-4d70-acb9-f996187a****
1751
+ */
795
1752
  sessionId?: string;
796
1753
  static names(): {
797
1754
  [key: string]: string;
@@ -804,7 +1761,15 @@ export declare class RefreshLoginTokenRequest extends $tea.Model {
804
1761
  });
805
1762
  }
806
1763
  export declare class RefreshLoginTokenResponseBody extends $tea.Model {
1764
+ /**
1765
+ * @example
1766
+ * v1c27bab6c205b2fdfac916434306375722776d6aa89e30b7836d18c95ade9137f0f5ac4325260782184e96ee2b3f0****
1767
+ */
807
1768
  loginToken?: string;
1769
+ /**
1770
+ * @example
1771
+ * 1CBAFFAB-B697-4049-A9B1-67E1FC5F****
1772
+ */
808
1773
  requestId?: string;
809
1774
  static names(): {
810
1775
  [key: string]: string;
@@ -876,11 +1841,50 @@ export declare class ReportEdsAgentInfoResponse extends $tea.Model {
876
1841
  });
877
1842
  }
878
1843
  export declare class ReportSessionStatusRequest extends $tea.Model {
1844
+ /**
1845
+ * @example
1846
+ * liming
1847
+ */
879
1848
  endUserId?: string;
1849
+ /**
1850
+ * @remarks
1851
+ * This parameter is required.
1852
+ *
1853
+ * @example
1854
+ * i-bp167fcodoa90ixn****
1855
+ */
880
1856
  instanceId?: string;
1857
+ /**
1858
+ * @remarks
1859
+ * This parameter is required.
1860
+ *
1861
+ * @example
1862
+ * cn-beijing
1863
+ */
881
1864
  regionId?: string;
1865
+ /**
1866
+ * @remarks
1867
+ * This parameter is required.
1868
+ *
1869
+ * @example
1870
+ * 1642909143781
1871
+ */
882
1872
  sessionChangeTime?: number;
1873
+ /**
1874
+ * @remarks
1875
+ * This parameter is required.
1876
+ *
1877
+ * @example
1878
+ * 2
1879
+ */
883
1880
  sessionId?: string;
1881
+ /**
1882
+ * @remarks
1883
+ * This parameter is required.
1884
+ *
1885
+ * @example
1886
+ * SessionLogOn
1887
+ */
884
1888
  sessionStatus?: string;
885
1889
  static names(): {
886
1890
  [key: string]: string;
@@ -893,6 +1897,10 @@ export declare class ReportSessionStatusRequest extends $tea.Model {
893
1897
  });
894
1898
  }
895
1899
  export declare class ReportSessionStatusResponseBody extends $tea.Model {
1900
+ /**
1901
+ * @example
1902
+ * 0EE5DE20-25F4-5870-9D56-C259A45B****
1903
+ */
896
1904
  requestId?: string;
897
1905
  static names(): {
898
1906
  [key: string]: string;
@@ -921,12 +1929,52 @@ export declare class ReportSessionStatusResponse extends $tea.Model {
921
1929
  });
922
1930
  }
923
1931
  export declare class ResetPasswordRequest extends $tea.Model {
1932
+ /**
1933
+ * @remarks
1934
+ * This parameter is required.
1935
+ *
1936
+ * @example
1937
+ * 95e41934-383e-4c9f-824f-3b93b19b****
1938
+ */
924
1939
  clientId?: string;
1940
+ /**
1941
+ * @example
1942
+ * 2f00ab32-a473-4c90-9aae-dd8842ae****
1943
+ */
925
1944
  clientToken?: string;
1945
+ /**
1946
+ * @example
1947
+ * a***@example.edu
1948
+ */
926
1949
  email?: string;
1950
+ /**
1951
+ * @remarks
1952
+ * This parameter is required.
1953
+ *
1954
+ * @example
1955
+ * liming
1956
+ */
927
1957
  endUserId?: string;
1958
+ /**
1959
+ * @remarks
1960
+ * This parameter is required.
1961
+ *
1962
+ * @example
1963
+ * cn-hangzhou+dir-899235****
1964
+ */
928
1965
  officeSiteId?: string;
1966
+ /**
1967
+ * @remarks
1968
+ * This parameter is required.
1969
+ *
1970
+ * @example
1971
+ * cn-hangzhou
1972
+ */
929
1973
  regionId?: string;
1974
+ /**
1975
+ * @example
1976
+ * 1827912****
1977
+ */
930
1978
  phone?: string;
931
1979
  static names(): {
932
1980
  [key: string]: string;
@@ -939,6 +1987,10 @@ export declare class ResetPasswordRequest extends $tea.Model {
939
1987
  });
940
1988
  }
941
1989
  export declare class ResetPasswordResponseBody extends $tea.Model {
1990
+ /**
1991
+ * @example
1992
+ * A00477A5-167F-56D2-A315-EA77E4BD****
1993
+ */
942
1994
  requestId?: string;
943
1995
  static names(): {
944
1996
  [key: string]: string;
@@ -967,10 +2019,42 @@ export declare class ResetPasswordResponse extends $tea.Model {
967
2019
  });
968
2020
  }
969
2021
  export declare class ResetSnapshotRequest extends $tea.Model {
2022
+ /**
2023
+ * @remarks
2024
+ * This parameter is required.
2025
+ *
2026
+ * @example
2027
+ * b9d8ddfd-65d4-4857-9e97-56477d1f****
2028
+ */
970
2029
  clientId?: string;
2030
+ /**
2031
+ * @remarks
2032
+ * This parameter is required.
2033
+ *
2034
+ * @example
2035
+ * v1fdef51b727aa91d6c881658978508114d3f5680fa99a66b2a631d17d5bb4860cccf1173be24d77d5ef1423c83aea****
2036
+ */
971
2037
  loginToken?: string;
2038
+ /**
2039
+ * @remarks
2040
+ * This parameter is required.
2041
+ *
2042
+ * @example
2043
+ * cn-hangzhou
2044
+ */
972
2045
  regionId?: string;
2046
+ /**
2047
+ * @example
2048
+ * 05182b8c-bb0d-49d3-963c-ee63a507****
2049
+ */
973
2050
  sessionId?: string;
2051
+ /**
2052
+ * @remarks
2053
+ * This parameter is required.
2054
+ *
2055
+ * @example
2056
+ * s-2zeipxmnhej803x7****
2057
+ */
974
2058
  snapshotId?: string;
975
2059
  static names(): {
976
2060
  [key: string]: string;
@@ -983,6 +2067,10 @@ export declare class ResetSnapshotRequest extends $tea.Model {
983
2067
  });
984
2068
  }
985
2069
  export declare class ResetSnapshotResponseBody extends $tea.Model {
2070
+ /**
2071
+ * @example
2072
+ * 1CBAFFAB-B697-4049-A9B1-67E1FC5F****
2073
+ */
986
2074
  requestId?: string;
987
2075
  static names(): {
988
2076
  [key: string]: string;
@@ -1011,13 +2099,48 @@ export declare class ResetSnapshotResponse extends $tea.Model {
1011
2099
  });
1012
2100
  }
1013
2101
  export declare class SendTokenCodeRequest extends $tea.Model {
2102
+ /**
2103
+ * @remarks
2104
+ * This parameter is required.
2105
+ *
2106
+ * @example
2107
+ * f4a0dc8e-1702-4728-9a60-95b27a35****
2108
+ */
1014
2109
  clientId?: string;
2110
+ /**
2111
+ * @example
2112
+ * Windows_NT 10.0.18363 x64
2113
+ */
1015
2114
  clientOS?: string;
2115
+ /**
2116
+ * @example
2117
+ * 2.1.0-R-20210731.151756
2118
+ */
1016
2119
  clientVersion?: string;
2120
+ /**
2121
+ * @example
2122
+ * alice
2123
+ */
1017
2124
  endUserId?: string;
2125
+ /**
2126
+ * @example
2127
+ * v28101ac6a9e69c66b04a163031680463660b4b216cd758f34b60b9ad6a7c7f7334b83dd8f75eef4209c68f9f1080b****
2128
+ */
1018
2129
  loginToken?: string;
2130
+ /**
2131
+ * @example
2132
+ * cn-hangzhou+dir-2925105532
2133
+ */
1019
2134
  officeSiteId?: string;
2135
+ /**
2136
+ * @example
2137
+ * cd45e873-650d-4d70-acb9-f996187a****
2138
+ */
1020
2139
  sessionId?: string;
2140
+ /**
2141
+ * @example
2142
+ * 63****
2143
+ */
1021
2144
  tokenCode?: string;
1022
2145
  static names(): {
1023
2146
  [key: string]: string;
@@ -1030,6 +2153,10 @@ export declare class SendTokenCodeRequest extends $tea.Model {
1030
2153
  });
1031
2154
  }
1032
2155
  export declare class SendTokenCodeResponseBody extends $tea.Model {
2156
+ /**
2157
+ * @example
2158
+ * 134BD0B2-B848-5743-9CE2-C1FD3D5F****
2159
+ */
1033
2160
  requestId?: string;
1034
2161
  static names(): {
1035
2162
  [key: string]: string;
@@ -1058,15 +2185,70 @@ export declare class SendTokenCodeResponse extends $tea.Model {
1058
2185
  });
1059
2186
  }
1060
2187
  export declare class SetFingerPrintTemplateRequest extends $tea.Model {
2188
+ /**
2189
+ * @remarks
2190
+ * This parameter is required.
2191
+ *
2192
+ * @example
2193
+ * 347431a9-90f6-448e-82c4-42bc84a9****
2194
+ */
1061
2195
  clientId?: string;
2196
+ /**
2197
+ * @example
2198
+ * 123e4567-e89b-12d3-a456-42665544****
2199
+ */
1062
2200
  clientToken?: string;
2201
+ /**
2202
+ * @example
2203
+ * testDescription
2204
+ */
1063
2205
  description?: string;
2206
+ /**
2207
+ * @example
2208
+ * AAAAAAAAAAAAAA
2209
+ */
1064
2210
  encryptedFingerPrintTemplate?: string;
2211
+ /**
2212
+ * @example
2213
+ * drjfspchj
2214
+ */
1065
2215
  encryptedKey?: string;
2216
+ /**
2217
+ * @example
2218
+ * goG3gG8AAABhujtscn
2219
+ */
1066
2220
  fingerPrintTemplate?: string;
2221
+ /**
2222
+ * @remarks
2223
+ * This parameter is required.
2224
+ *
2225
+ * @example
2226
+ * v11c73e7af0cb43ff39301651142485099ffb447085d76c4147519dbaa21c3bd90d53045e327c1f525ee6331c52556****
2227
+ */
1067
2228
  loginToken?: string;
2229
+ /**
2230
+ * @remarks
2231
+ * This parameter is required.
2232
+ *
2233
+ * @example
2234
+ * As53328794
2235
+ */
1068
2236
  password?: string;
2237
+ /**
2238
+ * @remarks
2239
+ * This parameter is required.
2240
+ *
2241
+ * @example
2242
+ * cn-hangzhou
2243
+ */
1069
2244
  regionId?: string;
2245
+ /**
2246
+ * @remarks
2247
+ * This parameter is required.
2248
+ *
2249
+ * @example
2250
+ * 8b42538a-246e-45a1-95ea-e5c65b09****
2251
+ */
1070
2252
  sessionId?: string;
1071
2253
  static names(): {
1072
2254
  [key: string]: string;
@@ -1079,8 +2261,20 @@ export declare class SetFingerPrintTemplateRequest extends $tea.Model {
1079
2261
  });
1080
2262
  }
1081
2263
  export declare class SetFingerPrintTemplateResponseBody extends $tea.Model {
2264
+ /**
2265
+ * @example
2266
+ * 0711abb9-4cf8-41b2-9d0e-b51209468631;da4VFPNxwY3CZegFjOrCNw==;iHp2l9/qGcfD4tWx7jZIZQ==
2267
+ */
1082
2268
  encryptedPassword?: string;
2269
+ /**
2270
+ * @example
2271
+ * 1
2272
+ */
1083
2273
  index?: number;
2274
+ /**
2275
+ * @example
2276
+ * CDE666EA-4FCD-5024-895C-8698E3D3****
2277
+ */
1084
2278
  requestId?: string;
1085
2279
  static names(): {
1086
2280
  [key: string]: string;
@@ -1109,12 +2303,58 @@ export declare class SetFingerPrintTemplateResponse extends $tea.Model {
1109
2303
  });
1110
2304
  }
1111
2305
  export declare class SetFingerPrintTemplateDescriptionRequest extends $tea.Model {
2306
+ /**
2307
+ * @remarks
2308
+ * This parameter is required.
2309
+ *
2310
+ * @example
2311
+ * 0764064c-1609-4d3c-8cb7-ab8d3feg****
2312
+ */
1112
2313
  clientId?: string;
2314
+ /**
2315
+ * @example
2316
+ * 40401e62-5caf-4508-8de7-bf98af12****
2317
+ */
1113
2318
  clientToken?: string;
2319
+ /**
2320
+ * @remarks
2321
+ * This parameter is required.
2322
+ *
2323
+ * @example
2324
+ * Finger 1
2325
+ */
1114
2326
  description?: string;
2327
+ /**
2328
+ * @remarks
2329
+ * This parameter is required.
2330
+ *
2331
+ * @example
2332
+ * 1
2333
+ */
1115
2334
  index?: number;
2335
+ /**
2336
+ * @remarks
2337
+ * This parameter is required.
2338
+ *
2339
+ * @example
2340
+ * v14e5a2404c495249f7541646535779667ea0b5d87754b5d2d2a3099bda774f3832e24756ef3e66eb574b1f3e99078****
2341
+ */
1116
2342
  loginToken?: string;
2343
+ /**
2344
+ * @remarks
2345
+ * This parameter is required.
2346
+ *
2347
+ * @example
2348
+ * cn-hangzhou
2349
+ */
1117
2350
  regionId?: string;
2351
+ /**
2352
+ * @remarks
2353
+ * This parameter is required.
2354
+ *
2355
+ * @example
2356
+ * d28520d4-da0b-4a97-981d-683db865****
2357
+ */
1118
2358
  sessionId?: string;
1119
2359
  static names(): {
1120
2360
  [key: string]: string;
@@ -1127,6 +2367,10 @@ export declare class SetFingerPrintTemplateDescriptionRequest extends $tea.Model
1127
2367
  });
1128
2368
  }
1129
2369
  export declare class SetFingerPrintTemplateDescriptionResponseBody extends $tea.Model {
2370
+ /**
2371
+ * @example
2372
+ * BBD7DFD1-A5DE-51D9-8FD6-3BF54EF4****
2373
+ */
1130
2374
  requestId?: string;
1131
2375
  static names(): {
1132
2376
  [key: string]: string;
@@ -1155,14 +2399,85 @@ export declare class SetFingerPrintTemplateDescriptionResponse extends $tea.Mode
1155
2399
  });
1156
2400
  }
1157
2401
  export declare class StartDesktopsRequest extends $tea.Model {
2402
+ /**
2403
+ * @remarks
2404
+ * The ID of the Alibaba Cloud Workspace client (hereinafter referred to as WUYING client). The system generates a unique ID for each client.
2405
+ *
2406
+ * This parameter is required.
2407
+ *
2408
+ * @example
2409
+ * f4a0dc8e-1702-4728-9a60-95b27a35****
2410
+ */
1158
2411
  clientId?: string;
2412
+ /**
2413
+ * @remarks
2414
+ * The operating system (OS) of the device that run the client.
2415
+ *
2416
+ * @example
2417
+ * Windows_NT 10.0.18363 x64
2418
+ */
1159
2419
  clientOS?: string;
2420
+ /**
2421
+ * @remarks
2422
+ * The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length. For more information, see [How to ensure idempotence](https://help.aliyun.com/document_detail/25693.html).
2423
+ *
2424
+ * @example
2425
+ * 21e7be12-aa4f-4389-b3e1-82f4a1b5****
2426
+ */
1160
2427
  clientToken?: string;
2428
+ /**
2429
+ * @remarks
2430
+ * The client version. If you use a WUYING client, you can click **About** on the client logon page to view the version of the client.
2431
+ *
2432
+ * @example
2433
+ * 2.1.0-R-20210731.151756
2434
+ */
1161
2435
  clientVersion?: string;
2436
+ /**
2437
+ * @remarks
2438
+ * The IDs of the cloud computers. You can specify the IDs of 1 to 20 cloud computers.
2439
+ *
2440
+ * This parameter is required.
2441
+ *
2442
+ * @example
2443
+ * ecd-cg27ufmapab08****
2444
+ */
1162
2445
  desktopId?: string[];
2446
+ /**
2447
+ * @remarks
2448
+ * The logon token.
2449
+ *
2450
+ * This parameter is required.
2451
+ *
2452
+ * @example
2453
+ * v18101ac6a9e69c66b04a163031680463660b4b216cd758f34b60b9ad6a7c7f7334b83dd8f75eef4209c68f9f1080b****
2454
+ */
1163
2455
  loginToken?: string;
2456
+ /**
2457
+ * @remarks
2458
+ * The region ID. You can call the [DescribeRegions](https://help.aliyun.com/document_detail/196646.html) operation to query the regions supported by WUYING Workspace.
2459
+ *
2460
+ * This parameter is required.
2461
+ *
2462
+ * @example
2463
+ * cn-hangzhou
2464
+ */
1164
2465
  regionId?: string;
2466
+ /**
2467
+ * @remarks
2468
+ * The session ID.
2469
+ *
2470
+ * @example
2471
+ * cd45e873-650d-4d70-acb9-f996187a****
2472
+ */
1165
2473
  sessionId?: string;
2474
+ /**
2475
+ * @remarks
2476
+ * The UUID of the client.
2477
+ *
2478
+ * @example
2479
+ * 71F6A700735E74A61161A53F0C47****
2480
+ */
1166
2481
  uuid?: string;
1167
2482
  static names(): {
1168
2483
  [key: string]: string;
@@ -1175,6 +2490,13 @@ export declare class StartDesktopsRequest extends $tea.Model {
1175
2490
  });
1176
2491
  }
1177
2492
  export declare class StartDesktopsResponseBody extends $tea.Model {
2493
+ /**
2494
+ * @remarks
2495
+ * The request ID.
2496
+ *
2497
+ * @example
2498
+ * 1CBAFFAB-B697-4049-A9B1-67E1FC5F****
2499
+ */
1178
2500
  requestId?: string;
1179
2501
  static names(): {
1180
2502
  [key: string]: string;
@@ -1203,13 +2525,33 @@ export declare class StartDesktopsResponse extends $tea.Model {
1203
2525
  });
1204
2526
  }
1205
2527
  export declare class StartRecordContentRequest extends $tea.Model {
2528
+ /**
2529
+ * @remarks
2530
+ * This parameter is required.
2531
+ */
1206
2532
  clientId?: string;
1207
2533
  clientOS?: string;
1208
2534
  clientVersion?: string;
2535
+ /**
2536
+ * @remarks
2537
+ * This parameter is required.
2538
+ */
1209
2539
  desktopId?: string;
1210
2540
  filePath?: string;
2541
+ /**
2542
+ * @remarks
2543
+ * This parameter is required.
2544
+ */
1211
2545
  loginToken?: string;
2546
+ /**
2547
+ * @remarks
2548
+ * This parameter is required.
2549
+ */
1212
2550
  regionId?: string;
2551
+ /**
2552
+ * @remarks
2553
+ * This parameter is required.
2554
+ */
1213
2555
  sessionId?: string;
1214
2556
  static names(): {
1215
2557
  [key: string]: string;
@@ -1250,14 +2592,83 @@ export declare class StartRecordContentResponse extends $tea.Model {
1250
2592
  });
1251
2593
  }
1252
2594
  export declare class StopDesktopsRequest extends $tea.Model {
2595
+ /**
2596
+ * @remarks
2597
+ * The client ID. The system generates a unique ID for each client.
2598
+ *
2599
+ * This parameter is required.
2600
+ *
2601
+ * @example
2602
+ * f4a0dc8e-1702-4728-9a60-95b27a35****
2603
+ */
1253
2604
  clientId?: string;
2605
+ /**
2606
+ * @remarks
2607
+ * The operating system (OS) of the device that runs the Alibaba Cloud Workspace client (hereinafter referred to as WUYING client).
2608
+ *
2609
+ * @example
2610
+ * Windows_NT 10.0.18363 x64
2611
+ */
1254
2612
  clientOS?: string;
2613
+ /**
2614
+ * @remarks
2615
+ * The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length. For more information, see [How do I ensure the idempotence of a request?](https://help.aliyun.com/document_detail/25693.html)
2616
+ *
2617
+ * @example
2618
+ * 6ce412a8-399f-49f9-9518-66ee028a****
2619
+ */
1255
2620
  clientToken?: string;
2621
+ /**
2622
+ * @remarks
2623
+ * The client version. If you use a WUYING client, you can view the client version in the **About** dialog box on the client logon page.
2624
+ *
2625
+ * @example
2626
+ * 2.1.0-R-20210731.151756
2627
+ */
1256
2628
  clientVersion?: string;
2629
+ /**
2630
+ * @remarks
2631
+ * The IDs of the cloud computers. You can specify the IDs of 1 to 20 cloud computers.
2632
+ *
2633
+ * This parameter is required.
2634
+ *
2635
+ * @example
2636
+ * ecd-7w78ozhjcwa3u****
2637
+ */
1257
2638
  desktopId?: string[];
2639
+ /**
2640
+ * @remarks
2641
+ * The logon token.
2642
+ *
2643
+ * @example
2644
+ * v18101ac6a9e69c66b04a163031680463660b4b216cd758f34b60b9ad6a7c7f7334b83dd8f75eef4209c68f9f1080b****
2645
+ */
1258
2646
  loginToken?: string;
2647
+ /**
2648
+ * @remarks
2649
+ * The region ID. You can call the [DescribeRegions](https://help.aliyun.com/document_detail/196646.html) operation to query the regions supported by WUYING Workspace.
2650
+ *
2651
+ * This parameter is required.
2652
+ *
2653
+ * @example
2654
+ * cn-hangzhou
2655
+ */
1259
2656
  regionId?: string;
2657
+ /**
2658
+ * @remarks
2659
+ * The session ID.
2660
+ *
2661
+ * @example
2662
+ * cd45e873-650d-4d70-acb9-f996187a****
2663
+ */
1260
2664
  sessionId?: string;
2665
+ /**
2666
+ * @remarks
2667
+ * The logon token.
2668
+ *
2669
+ * @example
2670
+ * 04b7b80a0b020715c5c1b4175fc4771698****9e2a759557a4624665fd53ae40
2671
+ */
1261
2672
  sessionToken?: string;
1262
2673
  static names(): {
1263
2674
  [key: string]: string;
@@ -1270,6 +2681,13 @@ export declare class StopDesktopsRequest extends $tea.Model {
1270
2681
  });
1271
2682
  }
1272
2683
  export declare class StopDesktopsResponseBody extends $tea.Model {
2684
+ /**
2685
+ * @remarks
2686
+ * The request ID.
2687
+ *
2688
+ * @example
2689
+ * 1CBAFFAB-B697-4049-A9B1-67E1FC5F****
2690
+ */
1273
2691
  requestId?: string;
1274
2692
  static names(): {
1275
2693
  [key: string]: string;
@@ -1298,12 +2716,32 @@ export declare class StopDesktopsResponse extends $tea.Model {
1298
2716
  });
1299
2717
  }
1300
2718
  export declare class StopRecordContentRequest extends $tea.Model {
2719
+ /**
2720
+ * @remarks
2721
+ * This parameter is required.
2722
+ */
1301
2723
  clientId?: string;
1302
2724
  clientOS?: string;
1303
2725
  clientVersion?: string;
2726
+ /**
2727
+ * @remarks
2728
+ * This parameter is required.
2729
+ */
1304
2730
  desktopId?: string;
2731
+ /**
2732
+ * @remarks
2733
+ * This parameter is required.
2734
+ */
1305
2735
  loginToken?: string;
2736
+ /**
2737
+ * @remarks
2738
+ * This parameter is required.
2739
+ */
1306
2740
  regionId?: string;
2741
+ /**
2742
+ * @remarks
2743
+ * This parameter is required.
2744
+ */
1307
2745
  sessionId?: string;
1308
2746
  static names(): {
1309
2747
  [key: string]: string;
@@ -1344,12 +2782,55 @@ export declare class StopRecordContentResponse extends $tea.Model {
1344
2782
  });
1345
2783
  }
1346
2784
  export declare class UnbindUserDesktopRequest extends $tea.Model {
2785
+ /**
2786
+ * @remarks
2787
+ * This parameter is required.
2788
+ *
2789
+ * @example
2790
+ * 58f96f67-7944-4f97-9342-****
2791
+ */
1347
2792
  clientId?: string;
2793
+ /**
2794
+ * @example
2795
+ * windows
2796
+ */
1348
2797
  clientType?: string;
2798
+ /**
2799
+ * @example
2800
+ * true
2801
+ */
1349
2802
  force?: boolean;
2803
+ /**
2804
+ * @remarks
2805
+ * This parameter is required.
2806
+ *
2807
+ * @example
2808
+ * v12307f5e0****
2809
+ */
1350
2810
  loginToken?: string;
2811
+ /**
2812
+ * @remarks
2813
+ * This parameter is required.
2814
+ *
2815
+ * @example
2816
+ * cn-hangzhou
2817
+ */
1351
2818
  regionId?: string;
2819
+ /**
2820
+ * @remarks
2821
+ * This parameter is required.
2822
+ *
2823
+ * @example
2824
+ * 3b053331-dc98-43d8-b247-****
2825
+ */
1352
2826
  sessionId?: string;
2827
+ /**
2828
+ * @remarks
2829
+ * This parameter is required.
2830
+ *
2831
+ * @example
2832
+ * ud-sdfs****
2833
+ */
1353
2834
  userDesktopId?: string;
1354
2835
  static names(): {
1355
2836
  [key: string]: string;
@@ -1362,7 +2843,11 @@ export declare class UnbindUserDesktopRequest extends $tea.Model {
1362
2843
  });
1363
2844
  }
1364
2845
  export declare class UnbindUserDesktopResponseBody extends $tea.Model {
1365
- requestId?: string;
2846
+ /**
2847
+ * @example
2848
+ * D5B7CF35-E078-5EBF-A010-****
2849
+ */
2850
+ requestId?: string;
1366
2851
  static names(): {
1367
2852
  [key: string]: string;
1368
2853
  };
@@ -1390,13 +2875,60 @@ export declare class UnbindUserDesktopResponse extends $tea.Model {
1390
2875
  });
1391
2876
  }
1392
2877
  export declare class VerifyCredentialRequest extends $tea.Model {
2878
+ /**
2879
+ * @remarks
2880
+ * This parameter is required.
2881
+ *
2882
+ * @example
2883
+ * d0b95762-0541-4b53-a0e4-7ed09f39****
2884
+ */
1393
2885
  clientId?: string;
2886
+ /**
2887
+ * @remarks
2888
+ * This parameter is required.
2889
+ *
2890
+ * @example
2891
+ * 123456789cyG
2892
+ */
1394
2893
  credential?: string;
2894
+ /**
2895
+ * @example
2896
+ * Password
2897
+ */
1395
2898
  credentialType?: string;
2899
+ /**
2900
+ * @example
2901
+ * drjfs****
2902
+ */
1396
2903
  encryptedKey?: string;
2904
+ /**
2905
+ * @remarks
2906
+ * This parameter is required.
2907
+ *
2908
+ * @example
2909
+ * v1f5772a1c60dbea9fd8e1648567079018086448d234b5bc8e30bec0ba6e80c41c767c4dd0db51e9e5c4e0f111431a****
2910
+ */
1397
2911
  loginToken?: string;
2912
+ /**
2913
+ * @remarks
2914
+ * This parameter is required.
2915
+ *
2916
+ * @example
2917
+ * cn-shanghai+dir-227468****
2918
+ */
1398
2919
  officeSiteId?: string;
2920
+ /**
2921
+ * @remarks
2922
+ * This parameter is required.
2923
+ *
2924
+ * @example
2925
+ * cn-beijing
2926
+ */
1399
2927
  regionId?: string;
2928
+ /**
2929
+ * @example
2930
+ * eb17af2e-1dd6-4cc4-a3ee-3a14d0d7****
2931
+ */
1400
2932
  sessionId?: string;
1401
2933
  static names(): {
1402
2934
  [key: string]: string;
@@ -1409,6 +2941,10 @@ export declare class VerifyCredentialRequest extends $tea.Model {
1409
2941
  });
1410
2942
  }
1411
2943
  export declare class VerifyCredentialResponseBody extends $tea.Model {
2944
+ /**
2945
+ * @example
2946
+ * D5F0BDFB-A229-5F1D-B790-33709D43****
2947
+ */
1412
2948
  requestId?: string;
1413
2949
  static names(): {
1414
2950
  [key: string]: string;
@@ -1437,10 +2973,30 @@ export declare class VerifyCredentialResponse extends $tea.Model {
1437
2973
  });
1438
2974
  }
1439
2975
  export declare class DescribeDirectoriesResponseBodyDirectories extends $tea.Model {
2976
+ /**
2977
+ * @example
2978
+ * INTERNET
2979
+ */
1440
2980
  desktopAccessType?: string;
2981
+ /**
2982
+ * @example
2983
+ * cn-hangzhou+dir-gx2x1dhsmu52rd****
2984
+ */
1441
2985
  directoryId?: string;
2986
+ /**
2987
+ * @example
2988
+ * AD_CONNECTOR
2989
+ */
1442
2990
  directoryType?: string;
2991
+ /**
2992
+ * @example
2993
+ * 26842
2994
+ */
1443
2995
  providerId?: string;
2996
+ /**
2997
+ * @example
2998
+ * https://eds-cn-shanghai-67726****
2999
+ */
1444
3000
  ssoServiceUrl?: string;
1445
3001
  static names(): {
1446
3002
  [key: string]: string;
@@ -1453,12 +3009,40 @@ export declare class DescribeDirectoriesResponseBodyDirectories extends $tea.Mod
1453
3009
  });
1454
3010
  }
1455
3011
  export declare class DescribeFingerPrintTemplatesResponseBodyFingerPrintTemplates extends $tea.Model {
3012
+ /**
3013
+ * @example
3014
+ * 2258a3d5-b8f8-4d79-a221-eaecf211****
3015
+ */
1456
3016
  clientId?: string;
3017
+ /**
3018
+ * @example
3019
+ * 2022-03-13T13:26:29Z
3020
+ */
1457
3021
  creationTime?: string;
3022
+ /**
3023
+ * @example
3024
+ * Finger 1
3025
+ */
1458
3026
  description?: string;
3027
+ /**
3028
+ * @example
3029
+ * liming
3030
+ */
1459
3031
  endUserId?: string;
3032
+ /**
3033
+ * @example
3034
+ * 1
3035
+ */
1460
3036
  index?: number;
3037
+ /**
3038
+ * @example
3039
+ * 2022-03-13T13:26:29Z
3040
+ */
1461
3041
  loginTime?: string;
3042
+ /**
3043
+ * @example
3044
+ * cn-hangzhou+dir-074949****
3045
+ */
1462
3046
  officeSiteId?: string;
1463
3047
  static names(): {
1464
3048
  [key: string]: string;
@@ -1471,7 +3055,31 @@ export declare class DescribeFingerPrintTemplatesResponseBodyFingerPrintTemplate
1471
3055
  });
1472
3056
  }
1473
3057
  export declare class DescribeGlobalDesktopsResponseBodyDesktopsClients extends $tea.Model {
3058
+ /**
3059
+ * @remarks
3060
+ * 客户端类型,取值:
3061
+ *
3062
+ * - macos:Mac客户端
3063
+ * - ios:IOS客户端
3064
+ * - android:Android客户端
3065
+ * - html5:Web客户端
3066
+ * - windows:Windows客户端
3067
+ * - linux:Linux客户端
3068
+ *
3069
+ * @example
3070
+ * windows
3071
+ */
1474
3072
  clientType?: string;
3073
+ /**
3074
+ * @remarks
3075
+ * 客户端状态,取值:
3076
+ *
3077
+ * - ON:允许登录
3078
+ * - OFF:不允许登录
3079
+ *
3080
+ * @example
3081
+ * ON
3082
+ */
1475
3083
  status?: string;
1476
3084
  static names(): {
1477
3085
  [key: string]: string;
@@ -1485,12 +3093,32 @@ export declare class DescribeGlobalDesktopsResponseBodyDesktopsClients extends $
1485
3093
  }
1486
3094
  export declare class DescribeGlobalDesktopsResponseBodyDesktopsDesktopTimers extends $tea.Model {
1487
3095
  allowClientSetting?: boolean;
3096
+ /**
3097
+ * @example
3098
+ * 0 0 0 ? * 1
3099
+ */
1488
3100
  cronExpression?: string;
3101
+ /**
3102
+ * @example
3103
+ * false
3104
+ */
1489
3105
  enforce?: boolean;
1490
3106
  executionTime?: string;
3107
+ /**
3108
+ * @example
3109
+ * 60
3110
+ */
1491
3111
  interval?: number;
1492
3112
  operationType?: string;
3113
+ /**
3114
+ * @example
3115
+ * RESET_TYPE_BOTH
3116
+ */
1493
3117
  resetType?: string;
3118
+ /**
3119
+ * @example
3120
+ * NoConnectShutdown
3121
+ */
1494
3122
  timerType?: string;
1495
3123
  static names(): {
1496
3124
  [key: string]: string;
@@ -1503,8 +3131,20 @@ export declare class DescribeGlobalDesktopsResponseBodyDesktopsDesktopTimers ext
1503
3131
  });
1504
3132
  }
1505
3133
  export declare class DescribeGlobalDesktopsResponseBodyDesktopsDisks extends $tea.Model {
3134
+ /**
3135
+ * @example
3136
+ * d-jedbpr4sl9l37****
3137
+ */
1506
3138
  diskId?: string;
3139
+ /**
3140
+ * @example
3141
+ * 80
3142
+ */
1507
3143
  diskSize?: number;
3144
+ /**
3145
+ * @example
3146
+ * SYSTEM
3147
+ */
1508
3148
  diskType?: string;
1509
3149
  static names(): {
1510
3150
  [key: string]: string;
@@ -1517,14 +3157,38 @@ export declare class DescribeGlobalDesktopsResponseBodyDesktopsDisks extends $te
1517
3157
  });
1518
3158
  }
1519
3159
  export declare class DescribeGlobalDesktopsResponseBodyDesktopsFotaUpdate extends $tea.Model {
3160
+ /**
3161
+ * @example
3162
+ * Enterprise
3163
+ */
1520
3164
  channel?: string;
3165
+ /**
3166
+ * @example
3167
+ * 0.0.0-D-20220102.xxxx
3168
+ */
1521
3169
  currentAppVersion?: string;
3170
+ /**
3171
+ * @example
3172
+ * false
3173
+ */
1522
3174
  force?: boolean;
3175
+ /**
3176
+ * @example
3177
+ * 0.0.0-R-20220307.xxxx
3178
+ */
1523
3179
  newAppVersion?: string;
3180
+ /**
3181
+ * @example
3182
+ * testProject
3183
+ */
1524
3184
  project?: string;
1525
3185
  releaseNote?: string;
1526
3186
  releaseNoteEn?: string;
1527
3187
  releaseNoteJp?: string;
3188
+ /**
3189
+ * @example
3190
+ * 100
3191
+ */
1528
3192
  size?: string;
1529
3193
  static names(): {
1530
3194
  [key: string]: string;
@@ -1537,7 +3201,15 @@ export declare class DescribeGlobalDesktopsResponseBodyDesktopsFotaUpdate extend
1537
3201
  });
1538
3202
  }
1539
3203
  export declare class DescribeGlobalDesktopsResponseBodyDesktopsSessions extends $tea.Model {
3204
+ /**
3205
+ * @example
3206
+ * User1
3207
+ */
1540
3208
  endUserId?: string;
3209
+ /**
3210
+ * @example
3211
+ * 2021-03-07T08:23Z
3212
+ */
1541
3213
  establishmentTime?: string;
1542
3214
  static names(): {
1543
3215
  [key: string]: string;
@@ -1550,43 +3222,152 @@ export declare class DescribeGlobalDesktopsResponseBodyDesktopsSessions extends
1550
3222
  });
1551
3223
  }
1552
3224
  export declare class DescribeGlobalDesktopsResponseBodyDesktops extends $tea.Model {
3225
+ /**
3226
+ * @example
3227
+ * PostPaid
3228
+ */
1553
3229
  chargeType?: string;
3230
+ /**
3231
+ * @remarks
3232
+ * 支持的客户端信息
3233
+ */
1554
3234
  clients?: DescribeGlobalDesktopsResponseBodyDesktopsClients[];
3235
+ /**
3236
+ * @example
3237
+ * Disconnected
3238
+ */
1555
3239
  connectionStatus?: string;
3240
+ /**
3241
+ * @example
3242
+ * 2
3243
+ */
1556
3244
  cpu?: number;
3245
+ /**
3246
+ * @example
3247
+ * 2020-11-06T08:28Z
3248
+ */
1557
3249
  creationTime?: string;
3250
+ /**
3251
+ * @example
3252
+ * dg-3uiojcc0j4kh7****
3253
+ */
1558
3254
  desktopGroupId?: string;
3255
+ /**
3256
+ * @example
3257
+ * ecd-gx2x1dhsmucyy****
3258
+ */
1559
3259
  desktopId?: string;
3260
+ /**
3261
+ * @example
3262
+ * testDesktopName
3263
+ */
1560
3264
  desktopName?: string;
3265
+ /**
3266
+ * @example
3267
+ * Running
3268
+ */
1561
3269
  desktopStatus?: string;
1562
3270
  desktopTimers?: DescribeGlobalDesktopsResponseBodyDesktopsDesktopTimers[];
3271
+ /**
3272
+ * @example
3273
+ * ecd.basic.large
3274
+ */
1563
3275
  desktopType?: string;
3276
+ /**
3277
+ * @example
3278
+ * cn-hangzhou+dir-jedbpr4sl9l37****
3279
+ */
1564
3280
  directoryId?: string;
1565
3281
  disks?: DescribeGlobalDesktopsResponseBodyDesktopsDisks[];
3282
+ /**
3283
+ * @example
3284
+ * User1
3285
+ */
1566
3286
  endUserId?: string;
1567
3287
  endUserIds?: string[];
3288
+ /**
3289
+ * @example
3290
+ * 2021-12-31T15:59Z
3291
+ */
1568
3292
  expiredTime?: string;
1569
3293
  fotaUpdate?: DescribeGlobalDesktopsResponseBodyDesktopsFotaUpdate;
3294
+ /**
3295
+ * @example
3296
+ * 2048
3297
+ */
1570
3298
  gpuMemory?: number;
1571
3299
  hibernationBeta?: boolean;
3300
+ /**
3301
+ * @example
3302
+ * testName
3303
+ */
1572
3304
  hostName?: string;
3305
+ /**
3306
+ * @example
3307
+ * m-4zfb6zj728hhr****
3308
+ */
1573
3309
  imageId?: string;
3310
+ /**
3311
+ * @example
3312
+ * 2021-07-13T15:59Z
3313
+ */
1574
3314
  lastStartTime?: string;
1575
3315
  localName?: string;
1576
3316
  managementFlags?: string[];
3317
+ /**
3318
+ * @example
3319
+ * 4096
3320
+ */
1577
3321
  memory?: number;
3322
+ /**
3323
+ * @example
3324
+ * 192.168.xx.xx
3325
+ */
1578
3326
  networkInterfaceIp?: string;
3327
+ /**
3328
+ * @example
3329
+ * cn-hangzhou+dir-363353****
3330
+ */
1579
3331
  officeSiteId?: string;
1580
3332
  os?: string;
3333
+ /**
3334
+ * @example
3335
+ * Windows
3336
+ */
1581
3337
  osType?: string;
1582
3338
  platform?: string;
3339
+ /**
3340
+ * @example
3341
+ * pg-9cktlowtxfl6****
3342
+ */
1583
3343
  policyGroupId?: string;
3344
+ /**
3345
+ * @example
3346
+ * ASP
3347
+ */
1584
3348
  protocolType?: string;
3349
+ /**
3350
+ * @example
3351
+ * ecd-gx2x1dhsm****
3352
+ */
1585
3353
  realDesktopId?: string;
3354
+ /**
3355
+ * @example
3356
+ * cn-hangzhou
3357
+ */
1586
3358
  regionId?: string;
3359
+ regionLocation?: string;
1587
3360
  sessionType?: string;
1588
3361
  sessions?: DescribeGlobalDesktopsResponseBodyDesktopsSessions[];
3362
+ /**
3363
+ * @example
3364
+ * true
3365
+ */
1589
3366
  supportHibernation?: boolean;
3367
+ /**
3368
+ * @example
3369
+ * testDesktop
3370
+ */
1590
3371
  userCustomName?: string;
1591
3372
  static names(): {
1592
3373
  [key: string]: string;
@@ -1599,11 +3380,35 @@ export declare class DescribeGlobalDesktopsResponseBodyDesktops extends $tea.Mod
1599
3380
  });
1600
3381
  }
1601
3382
  export declare class DescribeOfficeSitesResponseBodyOfficeSites extends $tea.Model {
3383
+ /**
3384
+ * @example
3385
+ * VPC
3386
+ */
1602
3387
  desktopAccessType?: string;
3388
+ /**
3389
+ * @example
3390
+ * http://ep-bp1s2vmbj55r5rzc****.epsrv-bp1pcfhpwvlpny01****.cn-hangzhou.privatelink.aliyuncs.com
3391
+ */
1603
3392
  desktopVpcEndpoint?: string;
3393
+ /**
3394
+ * @example
3395
+ * cn-hangzhou+dir-363353****
3396
+ */
1604
3397
  officeSiteId?: string;
3398
+ /**
3399
+ * @example
3400
+ * SIMPLE
3401
+ */
1605
3402
  officeSiteType?: string;
3403
+ /**
3404
+ * @example
3405
+ * 268****
3406
+ */
1606
3407
  providerId?: string;
3408
+ /**
3409
+ * @example
3410
+ * https://eds-cn-shanghai-67****
3411
+ */
1607
3412
  ssoServiceUrl?: string;
1608
3413
  static names(): {
1609
3414
  [key: string]: string;
@@ -1616,7 +3421,15 @@ export declare class DescribeOfficeSitesResponseBodyOfficeSites extends $tea.Mod
1616
3421
  });
1617
3422
  }
1618
3423
  export declare class DescribeRegionsResponseBodyRegions extends $tea.Model {
3424
+ /**
3425
+ * @example
3426
+ * ecd.cn-hangzhou.aliyuncs.com
3427
+ */
1619
3428
  regionEndpoint?: string;
3429
+ /**
3430
+ * @example
3431
+ * cn-hangzhou
3432
+ */
1620
3433
  regionId?: string;
1621
3434
  static names(): {
1622
3435
  [key: string]: string;
@@ -1629,16 +3442,60 @@ export declare class DescribeRegionsResponseBodyRegions extends $tea.Model {
1629
3442
  });
1630
3443
  }
1631
3444
  export declare class DescribeSnapshotsResponseBodySnapshots extends $tea.Model {
3445
+ /**
3446
+ * @example
3447
+ * 2020-12-20T14:52:28Z
3448
+ */
1632
3449
  creationTime?: string;
3450
+ /**
3451
+ * @example
3452
+ * testDescription
3453
+ */
1633
3454
  description?: string;
3455
+ /**
3456
+ * @example
3457
+ * ecd-g03l3tlm8djoj****
3458
+ */
1634
3459
  desktopId?: string;
3460
+ /**
3461
+ * @example
3462
+ * 100%
3463
+ */
1635
3464
  progress?: string;
3465
+ /**
3466
+ * @example
3467
+ * 30
3468
+ */
1636
3469
  remainTime?: number;
3470
+ /**
3471
+ * @example
3472
+ * s-2zeipxmnhej803x7****
3473
+ */
1637
3474
  snapshotId?: string;
3475
+ /**
3476
+ * @example
3477
+ * testSnapshotName
3478
+ */
1638
3479
  snapshotName?: string;
3480
+ /**
3481
+ * @example
3482
+ * USER
3483
+ */
1639
3484
  snapshotType?: string;
3485
+ /**
3486
+ * @example
3487
+ * 150
3488
+ */
1640
3489
  sourceDiskSize?: string;
3490
+ /**
3491
+ * @example
3492
+ * SYSTEM
3493
+ */
1641
3494
  sourceDiskType?: string;
3495
+ /**
3496
+ * @example
3497
+ * ACCOMPLISHED
3498
+ */
1642
3499
  status?: string;
1643
3500
  static names(): {
1644
3501
  [key: string]: string;
@@ -1651,11 +3508,35 @@ export declare class DescribeSnapshotsResponseBodySnapshots extends $tea.Model {
1651
3508
  });
1652
3509
  }
1653
3510
  export declare class GetCloudDriveServiceMountTokenResponseBodyToken extends $tea.Model {
3511
+ /**
3512
+ * @example
3513
+ * h****
3514
+ */
1654
3515
  domainId?: string;
3516
+ /**
3517
+ * @example
3518
+ * 2022-10-10T04:41:35Z
3519
+ */
1655
3520
  expiredAfter?: string;
3521
+ /**
3522
+ * @example
3523
+ * enabled
3524
+ */
1656
3525
  status?: string;
3526
+ /**
3527
+ * @example
3528
+ * 7836fa6eced7dc8d54c775k34iu3h4i2kh534f****
3529
+ */
1657
3530
  token?: string;
3531
+ /**
3532
+ * @example
3533
+ * 6050416754750
3534
+ */
1658
3535
  totalSize?: number;
3536
+ /**
3537
+ * @example
3538
+ * 605089
3539
+ */
1659
3540
  usedSize?: number;
1660
3541
  static names(): {
1661
3542
  [key: string]: string;
@@ -1667,10 +3548,62 @@ export declare class GetCloudDriveServiceMountTokenResponseBodyToken extends $te
1667
3548
  [key: string]: any;
1668
3549
  });
1669
3550
  }
3551
+ export declare class GetLoginTokenResponseBodyPasswordStrategy extends $tea.Model {
3552
+ /**
3553
+ * @remarks
3554
+ * > This is a parameter only for internal use.
3555
+ */
3556
+ tenantAlternativeChars?: string[];
3557
+ /**
3558
+ * @remarks
3559
+ * > This is a parameter only for internal use.
3560
+ *
3561
+ * @example
3562
+ * null
3563
+ */
3564
+ tenantPasswordLength?: string;
3565
+ static names(): {
3566
+ [key: string]: string;
3567
+ };
3568
+ static types(): {
3569
+ [key: string]: any;
3570
+ };
3571
+ constructor(map?: {
3572
+ [key: string]: any;
3573
+ });
3574
+ }
1670
3575
  export declare class GetLoginTokenResponseBodyRiskVerifyInfo extends $tea.Model {
3576
+ /**
3577
+ * @remarks
3578
+ * The email used for authentication.
3579
+ *
3580
+ * @example
3581
+ * user@example.com
3582
+ */
1671
3583
  email?: string;
3584
+ /**
3585
+ * @remarks
3586
+ * The duration of the lock.
3587
+ *
3588
+ * @example
3589
+ * 1713749778
3590
+ */
1672
3591
  lastLockDuration?: number;
3592
+ /**
3593
+ * @remarks
3594
+ * Whether the account is locked or not.
3595
+ *
3596
+ * @example
3597
+ * true
3598
+ */
1673
3599
  locked?: string;
3600
+ /**
3601
+ * @remarks
3602
+ * The mobile number used for authentication.
3603
+ *
3604
+ * @example
3605
+ * 1388888****
3606
+ */
1674
3607
  phone?: string;
1675
3608
  static names(): {
1676
3609
  [key: string]: string;
@@ -1699,90 +3632,394 @@ export default class Client extends OpenApi {
1699
3632
  getEndpoint(productId: string, regionId: string, endpointRule: string, network: string, suffix: string, endpointMap: {
1700
3633
  [key: string]: string;
1701
3634
  }, endpoint: string): string;
3635
+ /**
3636
+ * 允许桌面FOTA升级
3637
+ *
3638
+ * @param request - ApproveFotaUpdateRequest
3639
+ * @param runtime - runtime options for this request RuntimeOptions
3640
+ * @returns ApproveFotaUpdateResponse
3641
+ */
1702
3642
  approveFotaUpdateWithOptions(request: ApproveFotaUpdateRequest, runtime: $Util.RuntimeOptions): Promise<ApproveFotaUpdateResponse>;
3643
+ /**
3644
+ * 允许桌面FOTA升级
3645
+ *
3646
+ * @param request - ApproveFotaUpdateRequest
3647
+ * @returns ApproveFotaUpdateResponse
3648
+ */
1703
3649
  approveFotaUpdate(request: ApproveFotaUpdateRequest): Promise<ApproveFotaUpdateResponse>;
3650
+ /**
3651
+ * @param request - ChangePasswordRequest
3652
+ * @param runtime - runtime options for this request RuntimeOptions
3653
+ * @returns ChangePasswordResponse
3654
+ */
1704
3655
  changePasswordWithOptions(request: ChangePasswordRequest, runtime: $Util.RuntimeOptions): Promise<ChangePasswordResponse>;
3656
+ /**
3657
+ * @param request - ChangePasswordRequest
3658
+ * @returns ChangePasswordResponse
3659
+ */
1705
3660
  changePassword(request: ChangePasswordRequest): Promise<ChangePasswordResponse>;
3661
+ /**
3662
+ * @param request - DeleteFingerPrintTemplateRequest
3663
+ * @param runtime - runtime options for this request RuntimeOptions
3664
+ * @returns DeleteFingerPrintTemplateResponse
3665
+ */
1706
3666
  deleteFingerPrintTemplateWithOptions(request: DeleteFingerPrintTemplateRequest, runtime: $Util.RuntimeOptions): Promise<DeleteFingerPrintTemplateResponse>;
3667
+ /**
3668
+ * @param request - DeleteFingerPrintTemplateRequest
3669
+ * @returns DeleteFingerPrintTemplateResponse
3670
+ */
1707
3671
  deleteFingerPrintTemplate(request: DeleteFingerPrintTemplateRequest): Promise<DeleteFingerPrintTemplateResponse>;
3672
+ /**
3673
+ * @param request - DescribeDirectoriesRequest
3674
+ * @param runtime - runtime options for this request RuntimeOptions
3675
+ * @returns DescribeDirectoriesResponse
3676
+ */
1708
3677
  describeDirectoriesWithOptions(request: DescribeDirectoriesRequest, runtime: $Util.RuntimeOptions): Promise<DescribeDirectoriesResponse>;
3678
+ /**
3679
+ * @param request - DescribeDirectoriesRequest
3680
+ * @returns DescribeDirectoriesResponse
3681
+ */
1709
3682
  describeDirectories(request: DescribeDirectoriesRequest): Promise<DescribeDirectoriesResponse>;
3683
+ /**
3684
+ * @param request - DescribeFingerPrintTemplatesRequest
3685
+ * @param runtime - runtime options for this request RuntimeOptions
3686
+ * @returns DescribeFingerPrintTemplatesResponse
3687
+ */
1710
3688
  describeFingerPrintTemplatesWithOptions(request: DescribeFingerPrintTemplatesRequest, runtime: $Util.RuntimeOptions): Promise<DescribeFingerPrintTemplatesResponse>;
3689
+ /**
3690
+ * @param request - DescribeFingerPrintTemplatesRequest
3691
+ * @returns DescribeFingerPrintTemplatesResponse
3692
+ */
1711
3693
  describeFingerPrintTemplates(request: DescribeFingerPrintTemplatesRequest): Promise<DescribeFingerPrintTemplatesResponse>;
3694
+ /**
3695
+ * @param request - DescribeGlobalDesktopsRequest
3696
+ * @param runtime - runtime options for this request RuntimeOptions
3697
+ * @returns DescribeGlobalDesktopsResponse
3698
+ */
1712
3699
  describeGlobalDesktopsWithOptions(request: DescribeGlobalDesktopsRequest, runtime: $Util.RuntimeOptions): Promise<DescribeGlobalDesktopsResponse>;
3700
+ /**
3701
+ * @param request - DescribeGlobalDesktopsRequest
3702
+ * @returns DescribeGlobalDesktopsResponse
3703
+ */
1713
3704
  describeGlobalDesktops(request: DescribeGlobalDesktopsRequest): Promise<DescribeGlobalDesktopsResponse>;
3705
+ /**
3706
+ * @param request - DescribeOfficeSitesRequest
3707
+ * @param runtime - runtime options for this request RuntimeOptions
3708
+ * @returns DescribeOfficeSitesResponse
3709
+ */
1714
3710
  describeOfficeSitesWithOptions(request: DescribeOfficeSitesRequest, runtime: $Util.RuntimeOptions): Promise<DescribeOfficeSitesResponse>;
3711
+ /**
3712
+ * @param request - DescribeOfficeSitesRequest
3713
+ * @returns DescribeOfficeSitesResponse
3714
+ */
1715
3715
  describeOfficeSites(request: DescribeOfficeSitesRequest): Promise<DescribeOfficeSitesResponse>;
3716
+ /**
3717
+ * @param request - DescribeRegionsRequest
3718
+ * @param runtime - runtime options for this request RuntimeOptions
3719
+ * @returns DescribeRegionsResponse
3720
+ */
1716
3721
  describeRegionsWithOptions(request: DescribeRegionsRequest, runtime: $Util.RuntimeOptions): Promise<DescribeRegionsResponse>;
3722
+ /**
3723
+ * @param request - DescribeRegionsRequest
3724
+ * @returns DescribeRegionsResponse
3725
+ */
1717
3726
  describeRegions(request: DescribeRegionsRequest): Promise<DescribeRegionsResponse>;
3727
+ /**
3728
+ * 列举快照
3729
+ *
3730
+ * @param request - DescribeSnapshotsRequest
3731
+ * @param runtime - runtime options for this request RuntimeOptions
3732
+ * @returns DescribeSnapshotsResponse
3733
+ */
1718
3734
  describeSnapshotsWithOptions(request: DescribeSnapshotsRequest, runtime: $Util.RuntimeOptions): Promise<DescribeSnapshotsResponse>;
3735
+ /**
3736
+ * 列举快照
3737
+ *
3738
+ * @param request - DescribeSnapshotsRequest
3739
+ * @returns DescribeSnapshotsResponse
3740
+ */
1719
3741
  describeSnapshots(request: DescribeSnapshotsRequest): Promise<DescribeSnapshotsResponse>;
3742
+ /**
3743
+ * @param request - EncryptPasswordRequest
3744
+ * @param runtime - runtime options for this request RuntimeOptions
3745
+ * @returns EncryptPasswordResponse
3746
+ */
1720
3747
  encryptPasswordWithOptions(request: EncryptPasswordRequest, runtime: $Util.RuntimeOptions): Promise<EncryptPasswordResponse>;
3748
+ /**
3749
+ * @param request - EncryptPasswordRequest
3750
+ * @returns EncryptPasswordResponse
3751
+ */
1721
3752
  encryptPassword(request: EncryptPasswordRequest): Promise<EncryptPasswordResponse>;
3753
+ /**
3754
+ * 获取无影云盘的免密token
3755
+ *
3756
+ * @param request - GetCloudDriveServiceMountTokenRequest
3757
+ * @param runtime - runtime options for this request RuntimeOptions
3758
+ * @returns GetCloudDriveServiceMountTokenResponse
3759
+ */
1722
3760
  getCloudDriveServiceMountTokenWithOptions(request: GetCloudDriveServiceMountTokenRequest, runtime: $Util.RuntimeOptions): Promise<GetCloudDriveServiceMountTokenResponse>;
3761
+ /**
3762
+ * 获取无影云盘的免密token
3763
+ *
3764
+ * @param request - GetCloudDriveServiceMountTokenRequest
3765
+ * @returns GetCloudDriveServiceMountTokenResponse
3766
+ */
1723
3767
  getCloudDriveServiceMountToken(request: GetCloudDriveServiceMountTokenRequest): Promise<GetCloudDriveServiceMountTokenResponse>;
3768
+ /**
3769
+ * @param request - GetConnectionTicketRequest
3770
+ * @param runtime - runtime options for this request RuntimeOptions
3771
+ * @returns GetConnectionTicketResponse
3772
+ */
1724
3773
  getConnectionTicketWithOptions(request: GetConnectionTicketRequest, runtime: $Util.RuntimeOptions): Promise<GetConnectionTicketResponse>;
3774
+ /**
3775
+ * @param request - GetConnectionTicketRequest
3776
+ * @returns GetConnectionTicketResponse
3777
+ */
1725
3778
  getConnectionTicket(request: GetConnectionTicketRequest): Promise<GetConnectionTicketResponse>;
3779
+ /**
3780
+ * Obtains logon credentials.
3781
+ *
3782
+ * @param request - GetLoginTokenRequest
3783
+ * @param runtime - runtime options for this request RuntimeOptions
3784
+ * @returns GetLoginTokenResponse
3785
+ */
1726
3786
  getLoginTokenWithOptions(request: GetLoginTokenRequest, runtime: $Util.RuntimeOptions): Promise<GetLoginTokenResponse>;
3787
+ /**
3788
+ * Obtains logon credentials.
3789
+ *
3790
+ * @param request - GetLoginTokenRequest
3791
+ * @returns GetLoginTokenResponse
3792
+ */
1727
3793
  getLoginToken(request: GetLoginTokenRequest): Promise<GetLoginTokenResponse>;
3794
+ /**
3795
+ * 是否保持登录判断接口
3796
+ *
3797
+ * @param request - IsKeepAliveRequest
3798
+ * @param runtime - runtime options for this request RuntimeOptions
3799
+ * @returns IsKeepAliveResponse
3800
+ */
1728
3801
  isKeepAliveWithOptions(request: IsKeepAliveRequest, runtime: $Util.RuntimeOptions): Promise<IsKeepAliveResponse>;
3802
+ /**
3803
+ * 是否保持登录判断接口
3804
+ *
3805
+ * @param request - IsKeepAliveRequest
3806
+ * @returns IsKeepAliveResponse
3807
+ */
1729
3808
  isKeepAlive(request: IsKeepAliveRequest): Promise<IsKeepAliveResponse>;
3809
+ /**
3810
+ * 查询Agent需要上报的配置信息
3811
+ *
3812
+ * @param request - QueryEdsAgentReportConfigRequest
3813
+ * @param runtime - runtime options for this request RuntimeOptions
3814
+ * @returns QueryEdsAgentReportConfigResponse
3815
+ */
1730
3816
  queryEdsAgentReportConfigWithOptions(request: QueryEdsAgentReportConfigRequest, runtime: $Util.RuntimeOptions): Promise<QueryEdsAgentReportConfigResponse>;
3817
+ /**
3818
+ * 查询Agent需要上报的配置信息
3819
+ *
3820
+ * @param request - QueryEdsAgentReportConfigRequest
3821
+ * @returns QueryEdsAgentReportConfigResponse
3822
+ */
1731
3823
  queryEdsAgentReportConfig(request: QueryEdsAgentReportConfigRequest): Promise<QueryEdsAgentReportConfigResponse>;
3824
+ /**
3825
+ * Restart cloud computers.
3826
+ *
3827
+ * @param request - RebootDesktopsRequest
3828
+ * @param runtime - runtime options for this request RuntimeOptions
3829
+ * @returns RebootDesktopsResponse
3830
+ */
1732
3831
  rebootDesktopsWithOptions(request: RebootDesktopsRequest, runtime: $Util.RuntimeOptions): Promise<RebootDesktopsResponse>;
3832
+ /**
3833
+ * Restart cloud computers.
3834
+ *
3835
+ * @param request - RebootDesktopsRequest
3836
+ * @returns RebootDesktopsResponse
3837
+ */
1733
3838
  rebootDesktops(request: RebootDesktopsRequest): Promise<RebootDesktopsResponse>;
3839
+ /**
3840
+ * @param request - RefreshLoginTokenRequest
3841
+ * @param runtime - runtime options for this request RuntimeOptions
3842
+ * @returns RefreshLoginTokenResponse
3843
+ */
1734
3844
  refreshLoginTokenWithOptions(request: RefreshLoginTokenRequest, runtime: $Util.RuntimeOptions): Promise<RefreshLoginTokenResponse>;
3845
+ /**
3846
+ * @param request - RefreshLoginTokenRequest
3847
+ * @returns RefreshLoginTokenResponse
3848
+ */
1735
3849
  refreshLoginToken(request: RefreshLoginTokenRequest): Promise<RefreshLoginTokenResponse>;
3850
+ /**
3851
+ * 上报edsAgent的信息
3852
+ *
3853
+ * @param request - ReportEdsAgentInfoRequest
3854
+ * @param runtime - runtime options for this request RuntimeOptions
3855
+ * @returns ReportEdsAgentInfoResponse
3856
+ */
1736
3857
  reportEdsAgentInfoWithOptions(request: ReportEdsAgentInfoRequest, runtime: $Util.RuntimeOptions): Promise<ReportEdsAgentInfoResponse>;
3858
+ /**
3859
+ * 上报edsAgent的信息
3860
+ *
3861
+ * @param request - ReportEdsAgentInfoRequest
3862
+ * @returns ReportEdsAgentInfoResponse
3863
+ */
1737
3864
  reportEdsAgentInfo(request: ReportEdsAgentInfoRequest): Promise<ReportEdsAgentInfoResponse>;
3865
+ /**
3866
+ * @param request - ReportSessionStatusRequest
3867
+ * @param runtime - runtime options for this request RuntimeOptions
3868
+ * @returns ReportSessionStatusResponse
3869
+ */
1738
3870
  reportSessionStatusWithOptions(request: ReportSessionStatusRequest, runtime: $Util.RuntimeOptions): Promise<ReportSessionStatusResponse>;
3871
+ /**
3872
+ * @param request - ReportSessionStatusRequest
3873
+ * @returns ReportSessionStatusResponse
3874
+ */
1739
3875
  reportSessionStatus(request: ReportSessionStatusRequest): Promise<ReportSessionStatusResponse>;
3876
+ /**
3877
+ * @param request - ResetPasswordRequest
3878
+ * @param runtime - runtime options for this request RuntimeOptions
3879
+ * @returns ResetPasswordResponse
3880
+ */
1740
3881
  resetPasswordWithOptions(request: ResetPasswordRequest, runtime: $Util.RuntimeOptions): Promise<ResetPasswordResponse>;
3882
+ /**
3883
+ * @param request - ResetPasswordRequest
3884
+ * @returns ResetPasswordResponse
3885
+ */
1741
3886
  resetPassword(request: ResetPasswordRequest): Promise<ResetPasswordResponse>;
3887
+ /**
3888
+ * 还原快照
3889
+ *
3890
+ * @param request - ResetSnapshotRequest
3891
+ * @param runtime - runtime options for this request RuntimeOptions
3892
+ * @returns ResetSnapshotResponse
3893
+ */
1742
3894
  resetSnapshotWithOptions(request: ResetSnapshotRequest, runtime: $Util.RuntimeOptions): Promise<ResetSnapshotResponse>;
3895
+ /**
3896
+ * 还原快照
3897
+ *
3898
+ * @param request - ResetSnapshotRequest
3899
+ * @returns ResetSnapshotResponse
3900
+ */
1743
3901
  resetSnapshot(request: ResetSnapshotRequest): Promise<ResetSnapshotResponse>;
3902
+ /**
3903
+ * @param request - SendTokenCodeRequest
3904
+ * @param runtime - runtime options for this request RuntimeOptions
3905
+ * @returns SendTokenCodeResponse
3906
+ */
1744
3907
  sendTokenCodeWithOptions(request: SendTokenCodeRequest, runtime: $Util.RuntimeOptions): Promise<SendTokenCodeResponse>;
3908
+ /**
3909
+ * @param request - SendTokenCodeRequest
3910
+ * @returns SendTokenCodeResponse
3911
+ */
1745
3912
  sendTokenCode(request: SendTokenCodeRequest): Promise<SendTokenCodeResponse>;
3913
+ /**
3914
+ * @param request - SetFingerPrintTemplateRequest
3915
+ * @param runtime - runtime options for this request RuntimeOptions
3916
+ * @returns SetFingerPrintTemplateResponse
3917
+ */
1746
3918
  setFingerPrintTemplateWithOptions(request: SetFingerPrintTemplateRequest, runtime: $Util.RuntimeOptions): Promise<SetFingerPrintTemplateResponse>;
3919
+ /**
3920
+ * @param request - SetFingerPrintTemplateRequest
3921
+ * @returns SetFingerPrintTemplateResponse
3922
+ */
1747
3923
  setFingerPrintTemplate(request: SetFingerPrintTemplateRequest): Promise<SetFingerPrintTemplateResponse>;
3924
+ /**
3925
+ * @param request - SetFingerPrintTemplateDescriptionRequest
3926
+ * @param runtime - runtime options for this request RuntimeOptions
3927
+ * @returns SetFingerPrintTemplateDescriptionResponse
3928
+ */
1748
3929
  setFingerPrintTemplateDescriptionWithOptions(request: SetFingerPrintTemplateDescriptionRequest, runtime: $Util.RuntimeOptions): Promise<SetFingerPrintTemplateDescriptionResponse>;
3930
+ /**
3931
+ * @param request - SetFingerPrintTemplateDescriptionRequest
3932
+ * @returns SetFingerPrintTemplateDescriptionResponse
3933
+ */
1749
3934
  setFingerPrintTemplateDescription(request: SetFingerPrintTemplateDescriptionRequest): Promise<SetFingerPrintTemplateDescriptionResponse>;
1750
3935
  /**
1751
- * The cloud computers that you want to start must be in the Stopped state. After you call this operation, the cloud computers enter the Running state.
1752
- *
1753
- * @param request StartDesktopsRequest
1754
- * @param runtime runtime options for this request RuntimeOptions
1755
- * @return StartDesktopsResponse
3936
+ * Start cloud computers.
3937
+ *
3938
+ * @remarks
3939
+ * The cloud computers that you want to start must be in the Stopped state. After you call this operation, the cloud computers enter the Running state.
3940
+ *
3941
+ * @param request - StartDesktopsRequest
3942
+ * @param runtime - runtime options for this request RuntimeOptions
3943
+ * @returns StartDesktopsResponse
1756
3944
  */
1757
3945
  startDesktopsWithOptions(request: StartDesktopsRequest, runtime: $Util.RuntimeOptions): Promise<StartDesktopsResponse>;
1758
3946
  /**
1759
- * The cloud computers that you want to start must be in the Stopped state. After you call this operation, the cloud computers enter the Running state.
1760
- *
1761
- * @param request StartDesktopsRequest
1762
- * @return StartDesktopsResponse
3947
+ * Start cloud computers.
3948
+ *
3949
+ * @remarks
3950
+ * The cloud computers that you want to start must be in the Stopped state. After you call this operation, the cloud computers enter the Running state.
3951
+ *
3952
+ * @param request - StartDesktopsRequest
3953
+ * @returns StartDesktopsResponse
1763
3954
  */
1764
3955
  startDesktops(request: StartDesktopsRequest): Promise<StartDesktopsResponse>;
3956
+ /**
3957
+ * @param request - StartRecordContentRequest
3958
+ * @param runtime - runtime options for this request RuntimeOptions
3959
+ * @returns StartRecordContentResponse
3960
+ */
1765
3961
  startRecordContentWithOptions(request: StartRecordContentRequest, runtime: $Util.RuntimeOptions): Promise<StartRecordContentResponse>;
3962
+ /**
3963
+ * @param request - StartRecordContentRequest
3964
+ * @returns StartRecordContentResponse
3965
+ */
1766
3966
  startRecordContent(request: StartRecordContentRequest): Promise<StartRecordContentResponse>;
1767
3967
  /**
1768
- * The cloud computers that you want to stop must be in the Running state. After you call this operation, the cloud computers enter the Stopped state.
1769
- *
1770
- * @param request StopDesktopsRequest
1771
- * @param runtime runtime options for this request RuntimeOptions
1772
- * @return StopDesktopsResponse
3968
+ * Stops cloud computers.
3969
+ *
3970
+ * @remarks
3971
+ * The cloud computers that you want to stop must be in the Running state. After you call this operation, the cloud computers enter the Stopped state.
3972
+ *
3973
+ * @param request - StopDesktopsRequest
3974
+ * @param runtime - runtime options for this request RuntimeOptions
3975
+ * @returns StopDesktopsResponse
1773
3976
  */
1774
3977
  stopDesktopsWithOptions(request: StopDesktopsRequest, runtime: $Util.RuntimeOptions): Promise<StopDesktopsResponse>;
1775
3978
  /**
1776
- * The cloud computers that you want to stop must be in the Running state. After you call this operation, the cloud computers enter the Stopped state.
1777
- *
1778
- * @param request StopDesktopsRequest
1779
- * @return StopDesktopsResponse
3979
+ * Stops cloud computers.
3980
+ *
3981
+ * @remarks
3982
+ * The cloud computers that you want to stop must be in the Running state. After you call this operation, the cloud computers enter the Stopped state.
3983
+ *
3984
+ * @param request - StopDesktopsRequest
3985
+ * @returns StopDesktopsResponse
1780
3986
  */
1781
3987
  stopDesktops(request: StopDesktopsRequest): Promise<StopDesktopsResponse>;
3988
+ /**
3989
+ * @param request - StopRecordContentRequest
3990
+ * @param runtime - runtime options for this request RuntimeOptions
3991
+ * @returns StopRecordContentResponse
3992
+ */
1782
3993
  stopRecordContentWithOptions(request: StopRecordContentRequest, runtime: $Util.RuntimeOptions): Promise<StopRecordContentResponse>;
3994
+ /**
3995
+ * @param request - StopRecordContentRequest
3996
+ * @returns StopRecordContentResponse
3997
+ */
1783
3998
  stopRecordContent(request: StopRecordContentRequest): Promise<StopRecordContentResponse>;
3999
+ /**
4000
+ * 解绑用户桌面
4001
+ *
4002
+ * @param request - UnbindUserDesktopRequest
4003
+ * @param runtime - runtime options for this request RuntimeOptions
4004
+ * @returns UnbindUserDesktopResponse
4005
+ */
1784
4006
  unbindUserDesktopWithOptions(request: UnbindUserDesktopRequest, runtime: $Util.RuntimeOptions): Promise<UnbindUserDesktopResponse>;
4007
+ /**
4008
+ * 解绑用户桌面
4009
+ *
4010
+ * @param request - UnbindUserDesktopRequest
4011
+ * @returns UnbindUserDesktopResponse
4012
+ */
1785
4013
  unbindUserDesktop(request: UnbindUserDesktopRequest): Promise<UnbindUserDesktopResponse>;
4014
+ /**
4015
+ * @param request - VerifyCredentialRequest
4016
+ * @param runtime - runtime options for this request RuntimeOptions
4017
+ * @returns VerifyCredentialResponse
4018
+ */
1786
4019
  verifyCredentialWithOptions(request: VerifyCredentialRequest, runtime: $Util.RuntimeOptions): Promise<VerifyCredentialResponse>;
4020
+ /**
4021
+ * @param request - VerifyCredentialRequest
4022
+ * @returns VerifyCredentialResponse
4023
+ */
1787
4024
  verifyCredential(request: VerifyCredentialRequest): Promise<VerifyCredentialResponse>;
1788
4025
  }