@alicloud/pai-dlc20201203 1.4.19 → 1.4.20

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
@@ -128,21 +128,33 @@ export declare class LifecyclePreStop extends $dara.Model {
128
128
  }
129
129
  export declare class CreateJobRequestCodeSource extends $dara.Model {
130
130
  /**
131
+ * @remarks
132
+ * The branch of the referenced code repository. By default, the branch configured in the code source is used. This parameter is optional.
133
+ *
131
134
  * @example
132
135
  * master
133
136
  */
134
137
  branch?: string;
135
138
  /**
139
+ * @remarks
140
+ * The ID of the code source.
141
+ *
136
142
  * @example
137
143
  * code-20210111103721-xxxxxxx
138
144
  */
139
145
  codeSourceId?: string;
140
146
  /**
147
+ * @remarks
148
+ * The commit ID of the code to be downloaded. By default, the commit ID configured in the code source is used. This parameter is optional.
149
+ *
141
150
  * @example
142
151
  * 44da109b5******
143
152
  */
144
153
  commit?: string;
145
154
  /**
155
+ * @remarks
156
+ * The path to which the job is mounted. By default, the mount path configured in the data source is used. This parameter is optional.
157
+ *
146
158
  * @example
147
159
  * /root/data
148
160
  */
@@ -160,18 +172,39 @@ export declare class CreateJobRequestCodeSource extends $dara.Model {
160
172
  }
161
173
  export declare class CreateJobRequestDataSources extends $dara.Model {
162
174
  /**
175
+ * @remarks
176
+ * The data source ID.
177
+ *
163
178
  * @example
164
179
  * d-cn9dl*******
165
180
  */
166
181
  dataSourceId?: string;
167
182
  dataSourceVersion?: string;
183
+ mountAccess?: string;
168
184
  /**
185
+ * @remarks
186
+ * The path to which the job is mounted. By default, the mount path in the data source configuration is used. This parameter is optional.
187
+ *
169
188
  * @example
170
189
  * /root/data
171
190
  */
172
191
  mountPath?: string;
192
+ /**
193
+ * @remarks
194
+ * The mount attribute of the custom dataset. Set the value to OSS.
195
+ *
196
+ * @example
197
+ * {
198
+ * "fs.oss.download.thread.concurrency": "10",
199
+ * "fs.oss.upload.thread.concurrency": "10",
200
+ * "fs.jindo.args": "-oattr_timeout=3 -oentry_timeout=0 -onegative_timeout=0 -oauto_cache -ono_symlink"
201
+ * }
202
+ */
173
203
  options?: string;
174
204
  /**
205
+ * @remarks
206
+ * The data source path.
207
+ *
175
208
  * @example
176
209
  * oss://bucket.oss-cn-hangzhou-internal.aliyuncs.com/path/
177
210
  */
@@ -188,19 +221,48 @@ export declare class CreateJobRequestDataSources extends $dara.Model {
188
221
  });
189
222
  }
190
223
  export declare class CreateJobRequestUserVpc extends $dara.Model {
224
+ /**
225
+ * @remarks
226
+ * The default route. Default value: false. Valid values:
227
+ *
228
+ * * eth0: The default network interface is used to access the Internet through the public gateway.
229
+ * * eth1: The user\\"s Elastic Network Interface is used to access the Internet through the private gateway. For more information about the configuration method, see [Enable Internet access for a DSW instance by using a private Internet NAT gateway](https://help.aliyun.com/document_detail/2525343.html).
230
+ *
231
+ * @example
232
+ * eth0
233
+ */
191
234
  defaultRoute?: string;
235
+ /**
236
+ * @remarks
237
+ * The extended CIDR block.
238
+ *
239
+ * * If you leave the SwitchId and ExtendedCIDRs parameters empty, the system automatically obtains all CIDR blocks in a VPC.
240
+ * * If you configure the SwitchId and ExtendedCIDRs parameters, we recommend that you specify all CIDR blocks in a VPC.
241
+ */
192
242
  extendedCIDRs?: string[];
193
243
  /**
244
+ * @remarks
245
+ * The ID of the security group.
246
+ *
194
247
  * @example
195
248
  * sg-abcdef****
196
249
  */
197
250
  securityGroupId?: string;
198
251
  /**
252
+ * @remarks
253
+ * The vSwitch ID. This parameter is optional.
254
+ *
255
+ * * If you leave this parameter empty, the system automatically selects a vSwitch based on the inventory status.
256
+ * * You can also specify a vSwitch ID.
257
+ *
199
258
  * @example
200
259
  * vs-abcdef****
201
260
  */
202
261
  switchId?: string;
203
262
  /**
263
+ * @remarks
264
+ * The VPC ID.
265
+ *
204
266
  * @example
205
267
  * vpc-abcdef****
206
268
  */
@@ -218,21 +280,33 @@ export declare class CreateJobRequestUserVpc extends $dara.Model {
218
280
  }
219
281
  export declare class GetJobResponseBodyCodeSource extends $dara.Model {
220
282
  /**
283
+ * @remarks
284
+ * The code branch.
285
+ *
221
286
  * @example
222
287
  * master
223
288
  */
224
289
  branch?: string;
225
290
  /**
291
+ * @remarks
292
+ * The code source ID.
293
+ *
226
294
  * @example
227
295
  * code******
228
296
  */
229
297
  codeSourceId?: string;
230
298
  /**
299
+ * @remarks
300
+ * The code commit ID
301
+ *
231
302
  * @example
232
303
  * 44da109b59f8596152987eaa8f3b2487xxxxxx
233
304
  */
234
305
  commit?: string;
235
306
  /**
307
+ * @remarks
308
+ * The local mount path.
309
+ *
236
310
  * @example
237
311
  * /mnt/data
238
312
  */
@@ -250,16 +324,25 @@ export declare class GetJobResponseBodyCodeSource extends $dara.Model {
250
324
  }
251
325
  export declare class GetJobResponseBodyDataSources extends $dara.Model {
252
326
  /**
327
+ * @remarks
328
+ * The data source ID.
329
+ *
253
330
  * @example
254
331
  * d*******
255
332
  */
256
333
  dataSourceId?: string;
257
334
  /**
335
+ * @remarks
336
+ * The local mount path. This parameter is optional. The default value is empty, which specifies that the mount path in the data source is used.
337
+ *
258
338
  * @example
259
339
  * /mnt/data/
260
340
  */
261
341
  mountPath?: string;
262
342
  /**
343
+ * @remarks
344
+ * The data source URL.
345
+ *
263
346
  * @example
264
347
  * oss://bucket.oss-cn-hangzhou-internal.aliyuncs.com/path/
265
348
  */
@@ -277,51 +360,84 @@ export declare class GetJobResponseBodyDataSources extends $dara.Model {
277
360
  }
278
361
  export declare class GetJobResponseBodyPodsHistoryPods extends $dara.Model {
279
362
  /**
363
+ * @remarks
364
+ * The time when the node was created (UTC).
365
+ *
280
366
  * @example
281
367
  * 2021-01-12T14:36:01Z
282
368
  */
283
369
  gmtCreateTime?: string;
284
370
  /**
371
+ * @remarks
372
+ * The end time of the node (UTC).
373
+ *
285
374
  * @example
286
375
  * 2021-01-12T14:36:01Z
287
376
  */
288
377
  gmtFinishTime?: string;
289
378
  /**
379
+ * @remarks
380
+ * The start time of the node (UTC).
381
+ *
290
382
  * @example
291
383
  * 2021-01-12T14:36:01Z
292
384
  */
293
385
  gmtStartTime?: string;
294
386
  /**
387
+ * @remarks
388
+ * The IP address of the node.
389
+ *
295
390
  * @example
296
391
  * 10.0.1.3
297
392
  */
298
393
  ip?: string;
299
394
  /**
395
+ * @remarks
396
+ * The ID of the node.
397
+ *
300
398
  * @example
301
399
  * Worker
302
400
  */
303
401
  podId?: string;
304
402
  /**
403
+ * @remarks
404
+ * The UID of the node.
405
+ *
305
406
  * @example
306
407
  * fe846462-af2c-4521-bd6f-96787a57591d
307
408
  */
308
409
  podUid?: string;
309
410
  /**
411
+ * @remarks
412
+ * The resource type of the node.
413
+ *
310
414
  * @example
311
415
  * Normal
312
416
  */
313
417
  resourceType?: string;
314
418
  /**
419
+ * @remarks
420
+ * The status of the node.
421
+ *
315
422
  * @example
316
423
  * Failed
317
424
  */
318
425
  status?: string;
319
426
  /**
427
+ * @remarks
428
+ * The sub-status of the node, such as its preemption status. Valid values:
429
+ *
430
+ * * Normal
431
+ * * Evicted
432
+ *
320
433
  * @example
321
434
  * Normal
322
435
  */
323
436
  subStatus?: string;
324
437
  /**
438
+ * @remarks
439
+ * The type of the node.
440
+ *
325
441
  * @example
326
442
  * Worker
327
443
  */
@@ -339,52 +455,95 @@ export declare class GetJobResponseBodyPodsHistoryPods extends $dara.Model {
339
455
  }
340
456
  export declare class GetJobResponseBodyPods extends $dara.Model {
341
457
  /**
458
+ * @remarks
459
+ * The time when the node was created (UTC).
460
+ *
342
461
  * @example
343
462
  * 2021-01-12T14:36:01Z
344
463
  */
345
464
  gmtCreateTime?: string;
346
465
  /**
466
+ * @remarks
467
+ * The end time of the node (UTC).
468
+ *
347
469
  * @example
348
470
  * 2021-01-12T15:36:05Z
349
471
  */
350
472
  gmtFinishTime?: string;
351
473
  /**
474
+ * @remarks
475
+ * The start time of the node (UTC).
476
+ *
352
477
  * @example
353
478
  * 2021-01-12T14:36:01Z
354
479
  */
355
480
  gmtStartTime?: string;
481
+ /**
482
+ * @remarks
483
+ * The historical nodes.
484
+ */
356
485
  historyPods?: GetJobResponseBodyPodsHistoryPods[];
357
486
  /**
487
+ * @remarks
488
+ * The IP address of the node.
489
+ *
358
490
  * @example
359
491
  * 10.0.1.2
360
492
  */
361
493
  ip?: string;
362
494
  /**
495
+ * @remarks
496
+ * The node ID. It can be used in the GetPodLogs and GetPodEvents operations to obtain the detailed logs and events of the node.
497
+ *
363
498
  * @example
364
499
  * Worker
365
500
  */
366
501
  podId?: string;
367
502
  /**
503
+ * @remarks
504
+ * The UID of the node.
505
+ *
368
506
  * @example
369
507
  * fe846462-af2c-4521-bd6f-96787a57591d
370
508
  */
371
509
  podUid?: string;
372
510
  /**
511
+ * @remarks
512
+ * The resource type of the node.
513
+ *
373
514
  * @example
374
515
  * Normal
375
516
  */
376
517
  resourceType?: string;
377
518
  /**
519
+ * @remarks
520
+ * The status of the node. Valid values:
521
+ *
522
+ * * Pending
523
+ * * Running
524
+ * * Succeeded
525
+ * * Failed
526
+ * * Unknown
527
+ *
378
528
  * @example
379
529
  * Running
380
530
  */
381
531
  status?: string;
382
532
  /**
533
+ * @remarks
534
+ * The sub-status of the node, such as its preemption status. Valid values:
535
+ *
536
+ * * Normal
537
+ * * Evicted
538
+ *
383
539
  * @example
384
540
  * Normal
385
541
  */
386
542
  subStatus?: string;
387
543
  /**
544
+ * @remarks
545
+ * The node type, which corresponds to a specific JobSpec in JobSpecs of the CreateJob operation.
546
+ *
388
547
  * @example
389
548
  * Worker
390
549
  */
@@ -401,19 +560,38 @@ export declare class GetJobResponseBodyPods extends $dara.Model {
401
560
  });
402
561
  }
403
562
  export declare class GetJobResponseBodyUserVpc extends $dara.Model {
563
+ /**
564
+ * @remarks
565
+ * The default router. This parameter is valid only for general-purpose computing resources. Valid values:
566
+ *
567
+ * eth0: The default network interface is used to access the Internet through the public gateway. eth1: The user\\"s Elastic Network Interface is used to access the Internet through the private gateway.
568
+ */
404
569
  defaultRoute?: string;
570
+ /**
571
+ * @remarks
572
+ * The extended CIDR block. Example: 192.168.0.1/24.
573
+ */
405
574
  extendedCidrs?: string[];
406
575
  /**
576
+ * @remarks
577
+ * The security group ID.
578
+ *
407
579
  * @example
408
580
  * sg-abcdef****
409
581
  */
410
582
  securityGroupId?: string;
411
583
  /**
584
+ * @remarks
585
+ * The vSwitch ID.
586
+ *
412
587
  * @example
413
588
  * vs-abcdef****
414
589
  */
415
590
  switchId?: string;
416
591
  /**
592
+ * @remarks
593
+ * The VPC ID.
594
+ *
417
595
  * @example
418
596
  * vpc-abcdef****
419
597
  */
@@ -1033,9 +1211,15 @@ export declare class EventInfo extends $dara.Model {
1033
1211
  export declare class ExtraPodSpec extends $dara.Model {
1034
1212
  initContainers?: ContainerSpec[];
1035
1213
  lifecycle?: Lifecycle;
1214
+ /**
1215
+ * @deprecated
1216
+ */
1036
1217
  podAnnotations?: {
1037
1218
  [key: string]: string;
1038
1219
  };
1220
+ /**
1221
+ * @deprecated
1222
+ */
1039
1223
  podLabels?: {
1040
1224
  [key: string]: string;
1041
1225
  };
@@ -1714,6 +1898,7 @@ export declare class Lifecycle extends $dara.Model {
1714
1898
  export declare class LogInfo extends $dara.Model {
1715
1899
  content?: string;
1716
1900
  id?: string;
1901
+ isTruncated?: boolean;
1717
1902
  podId?: string;
1718
1903
  podUid?: string;
1719
1904
  /**
@@ -1817,6 +2002,7 @@ export declare class PodItem extends $dara.Model {
1817
2002
  * 10.0.1.2
1818
2003
  */
1819
2004
  ip?: string;
2005
+ nodeName?: string;
1820
2006
  /**
1821
2007
  * @example
1822
2008
  * dlc-20210126170216-mtl37ge7gkvdz-worker-0
@@ -1832,6 +2018,7 @@ export declare class PodItem extends $dara.Model {
1832
2018
  * Stopped
1833
2019
  */
1834
2020
  status?: string;
2021
+ subStatus?: string;
1835
2022
  /**
1836
2023
  * @example
1837
2024
  * Worker
@@ -2075,6 +2262,51 @@ export declare class SanityCheckResultItem extends $dara.Model {
2075
2262
  [key: string]: any;
2076
2263
  });
2077
2264
  }
2265
+ export declare class SeccompProfile extends $dara.Model {
2266
+ /**
2267
+ * @example
2268
+ * my-profiles/profile-allow.json
2269
+ */
2270
+ localhostProfile?: string;
2271
+ /**
2272
+ * @example
2273
+ * Unconfined
2274
+ */
2275
+ type?: string;
2276
+ static names(): {
2277
+ [key: string]: string;
2278
+ };
2279
+ static types(): {
2280
+ [key: string]: any;
2281
+ };
2282
+ validate(): void;
2283
+ constructor(map?: {
2284
+ [key: string]: any;
2285
+ });
2286
+ }
2287
+ export declare class SecurityContext extends $dara.Model {
2288
+ /**
2289
+ * @example
2290
+ * 1000
2291
+ */
2292
+ runAsGroup?: number;
2293
+ /**
2294
+ * @example
2295
+ * 1000
2296
+ */
2297
+ runAsUser?: number;
2298
+ seccompProfile?: SeccompProfile;
2299
+ static names(): {
2300
+ [key: string]: string;
2301
+ };
2302
+ static types(): {
2303
+ [key: string]: any;
2304
+ };
2305
+ validate(): void;
2306
+ constructor(map?: {
2307
+ [key: string]: any;
2308
+ });
2309
+ }
2078
2310
  export declare class SmartCache extends $dara.Model {
2079
2311
  /**
2080
2312
  * @example
@@ -2431,39 +2663,106 @@ export declare class Workspace extends $dara.Model {
2431
2663
  });
2432
2664
  }
2433
2665
  export declare class CreateJobRequest extends $dara.Model {
2666
+ /**
2667
+ * @remarks
2668
+ * The job visibility. Valid values:
2669
+ *
2670
+ * * PUBLIC: The job is visible to all members in the workspace.
2671
+ * * PRIVATE: The job is visible only to you and the administrator of the workspace.
2672
+ *
2673
+ * @example
2674
+ * PRIVATE
2675
+ */
2434
2676
  accessibility?: string;
2677
+ /**
2678
+ * @remarks
2679
+ * The code source of the job. Before the node of the job runs, DLC automatically downloads the configured code from the code source and mounts the code to the local path of the container.
2680
+ */
2435
2681
  codeSource?: CreateJobRequestCodeSource;
2682
+ /**
2683
+ * @remarks
2684
+ * The access credential configuration.
2685
+ */
2436
2686
  credentialConfig?: CredentialConfig;
2687
+ /**
2688
+ * @remarks
2689
+ * The data sources for job running.
2690
+ */
2437
2691
  dataSources?: CreateJobRequestDataSources[];
2438
2692
  /**
2693
+ * @remarks
2694
+ * This parameter is not supported.
2695
+ *
2439
2696
  * @example
2440
2697
  * “”
2441
2698
  */
2442
2699
  debuggerConfigContent?: string;
2443
2700
  /**
2444
2701
  * @remarks
2702
+ * The job name. The name must be in the following format:
2703
+ *
2704
+ * * The name must be 1 to 256 characters in length.
2705
+ * * The name can contain digits, letters, underscores (_), periods (.), and hyphens (-).
2706
+ *
2445
2707
  * This parameter is required.
2446
2708
  *
2447
2709
  * @example
2448
2710
  * tf-mnist-test
2449
2711
  */
2450
2712
  displayName?: string;
2713
+ /**
2714
+ * @remarks
2715
+ * This parameter is not supported.
2716
+ */
2451
2717
  elasticSpec?: JobElasticSpec;
2718
+ /**
2719
+ * @remarks
2720
+ * The environment variables.
2721
+ */
2452
2722
  envs?: {
2453
2723
  [key: string]: string;
2454
2724
  };
2455
2725
  /**
2726
+ * @remarks
2727
+ * The maximum running duration of the job. Unit: minutes.
2728
+ *
2456
2729
  * @example
2457
2730
  * 1024
2458
2731
  */
2459
2732
  jobMaxRunningTimeMinutes?: number;
2460
2733
  /**
2461
2734
  * @remarks
2735
+ * The configurations for job running, such as the image address, startup command, node resource declaration, and number of replicas.****
2736
+ *
2737
+ * A DLC job consists of different types of nodes. If nodes of the same type have exactly the same configuration, the configuration is called JobSpec. **JobSpecs** specifies the configurations of all types of nodes. The value is of the array type.
2738
+ *
2462
2739
  * This parameter is required.
2463
2740
  */
2464
2741
  jobSpecs?: JobSpec[];
2465
2742
  /**
2466
2743
  * @remarks
2744
+ * The job type. The value is case-sensitive. Valid values:
2745
+ *
2746
+ * * TFJob
2747
+ * * PyTorchJob
2748
+ * * MPIJob
2749
+ * * XGBoostJob
2750
+ * * OneFlowJob
2751
+ * * ElasticBatchJob
2752
+ * * SlurmJob
2753
+ * * RayJob
2754
+ *
2755
+ * Valid values for each job type:
2756
+ *
2757
+ * * OneFlowJob: OneFlow.
2758
+ * * PyTorchJob: PyTorch.
2759
+ * * SlurmJob: Slurm.
2760
+ * * XGBoostJob: XGBoost.
2761
+ * * ElasticBatchJob: ElasticBatch.
2762
+ * * MPIJob: MPIJob.
2763
+ * * TFJob: Tensorflow.
2764
+ * * RayJob: Ray.
2765
+ *
2467
2766
  * This parameter is required.
2468
2767
  *
2469
2768
  * @example
@@ -2471,42 +2770,83 @@ export declare class CreateJobRequest extends $dara.Model {
2471
2770
  */
2472
2771
  jobType?: string;
2473
2772
  /**
2773
+ * @remarks
2774
+ * The additional configuration of the job. You can use this parameter to adjust the behavior of the attached data source. For example, if the attached data source of the job is of the OSS type, you can use this parameter to add the following configurations to override the default parameters of JindoFS: `fs.oss.download.thread.concurrency=4,fs.oss.download.queue.size=16`.
2775
+ *
2474
2776
  * @example
2475
2777
  * key1=value1,key2=value2
2476
2778
  */
2477
2779
  options?: string;
2478
2780
  /**
2781
+ * @remarks
2782
+ * The priority of the job. Default value: 1. Valid values: 1 to 9.
2783
+ *
2784
+ * * 1: the lowest priority.
2785
+ * * 9: the highest priority.
2786
+ *
2479
2787
  * @example
2480
2788
  * 8
2481
2789
  */
2482
2790
  priority?: number;
2483
2791
  /**
2792
+ * @remarks
2793
+ * The ID of the resource group. This parameter is optional.
2794
+ *
2795
+ * * If you leave this parameter empty, the job is submitted to a public resource group.
2796
+ * * If a resource quota is associated with the current workspace, you can specify the resource quota ID. For more information about how to query the resource quota ID, see [Manage resource quotas](https://help.aliyun.com/document_detail/2651299.html).
2797
+ *
2484
2798
  * @example
2485
2799
  * rs-xxx
2486
2800
  */
2487
2801
  resourceId?: string;
2802
+ /**
2803
+ * @remarks
2804
+ * The additional parameter configurations of the job.
2805
+ */
2488
2806
  settings?: JobSettings;
2489
2807
  /**
2808
+ * @remarks
2809
+ * The policy that is used to check whether a distributed multi-node job is successful. Only TensorFlow distributed multi-node jobs are supported.
2810
+ *
2811
+ * * ChiefWorker: If you use this policy, the job is considered successful when the pod on the chief node completes operations.
2812
+ * * AllWorkers (default): If you use this policy, the job is considered successful when all worker nodes complete operations.
2813
+ *
2490
2814
  * @example
2491
2815
  * AllWorkers
2492
2816
  */
2493
2817
  successPolicy?: string;
2494
2818
  /**
2819
+ * @remarks
2820
+ * The folder in which the third-party Python library file requirements.txt is stored. Before the startup command specified by the UserCommand parameter is run on each node, DLC fetches the requirements.txt file from the folder and runs `pip install -r` to install the required package and library.
2821
+ *
2495
2822
  * @example
2496
2823
  * /root/code/
2497
2824
  */
2498
2825
  thirdpartyLibDir?: string;
2826
+ /**
2827
+ * @remarks
2828
+ * The third-party Python libraries to be installed.
2829
+ */
2499
2830
  thirdpartyLibs?: string[];
2500
2831
  /**
2501
2832
  * @remarks
2833
+ * The startup command for all nodes of the job.
2834
+ *
2502
2835
  * This parameter is required.
2503
2836
  *
2504
2837
  * @example
2505
2838
  * python /root/code/mnist.py
2506
2839
  */
2507
2840
  userCommand?: string;
2841
+ /**
2842
+ * @remarks
2843
+ * The VPC settings.
2844
+ */
2508
2845
  userVpc?: CreateJobRequestUserVpc;
2509
2846
  /**
2847
+ * @remarks
2848
+ * The workspace ID.
2849
+ *
2510
2850
  * @example
2511
2851
  * ws-20210126170216-xxxxxxx
2512
2852
  */
@@ -2524,11 +2864,17 @@ export declare class CreateJobRequest extends $dara.Model {
2524
2864
  }
2525
2865
  export declare class CreateJobResponseBody extends $dara.Model {
2526
2866
  /**
2867
+ * @remarks
2868
+ * The job ID.
2869
+ *
2527
2870
  * @example
2528
2871
  * dlc7*******
2529
2872
  */
2530
2873
  jobId?: string;
2531
2874
  /**
2875
+ * @remarks
2876
+ * The request ID used to troubleshoot issues.
2877
+ *
2532
2878
  * @example
2533
2879
  * 473469C7-AA6F-4DC5-B3DB-xxxxxxx
2534
2880
  */
@@ -2562,74 +2908,168 @@ export declare class CreateJobResponse extends $dara.Model {
2562
2908
  });
2563
2909
  }
2564
2910
  export declare class CreateTensorboardRequest extends $dara.Model {
2911
+ /**
2912
+ * @remarks
2913
+ * The visibility of the job. Valid values:
2914
+ *
2915
+ * * PUBLIC: The configuration is public in the workspace.
2916
+ * * PRIVATE: The configuration is visible only to you and the administrator of the workspace.
2917
+ *
2918
+ * @example
2919
+ * PRIVATE
2920
+ */
2565
2921
  accessibility?: string;
2566
2922
  /**
2923
+ * @remarks
2924
+ * The number of vCPU cores.
2925
+ *
2567
2926
  * @example
2568
2927
  * 1
2569
2928
  */
2570
2929
  cpu?: number;
2571
2930
  /**
2931
+ * @remarks
2932
+ * The dataset ID.
2933
+ * <props="china">Call [ListDatasets](https://help.aliyun.com/document_detail/457222.html) to get the dataset ID.
2934
+ *
2572
2935
  * @example
2573
2936
  * d-xxxxxxxx
2574
2937
  */
2575
2938
  dataSourceId?: string;
2939
+ /**
2940
+ * @remarks
2941
+ * The dataset type. Valid values:
2942
+ *
2943
+ * * OSS
2944
+ * * NAS
2945
+ *
2946
+ * @example
2947
+ * OSS
2948
+ */
2576
2949
  dataSourceType?: string;
2950
+ /**
2951
+ * @remarks
2952
+ * The configurations of the data source.
2953
+ */
2577
2954
  dataSources?: DataSourceItem[];
2578
2955
  /**
2956
+ * @remarks
2957
+ * The TensorBoard name
2958
+ *
2579
2959
  * @example
2580
2960
  * tensorboard
2581
2961
  */
2582
2962
  displayName?: string;
2583
2963
  /**
2964
+ * @remarks
2965
+ * The job ID. Call [ListJobs](https://help.aliyun.com/document_detail/459676.html) to get the job ID.
2966
+ *
2584
2967
  * @example
2585
2968
  * dlc-20210126170216-mtl37ge7gkvdz
2586
2969
  */
2587
2970
  jobId?: string;
2588
2971
  /**
2972
+ * @remarks
2973
+ * The maximum running duration. Unit: minutes.
2974
+ *
2589
2975
  * @example
2590
2976
  * 240
2591
2977
  */
2592
2978
  maxRunningTimeMinutes?: number;
2593
2979
  /**
2980
+ * @remarks
2981
+ * The memory size. Unit: GB.
2982
+ *
2594
2983
  * @example
2595
2984
  * 1000
2596
2985
  */
2597
2986
  memory?: number;
2598
2987
  /**
2988
+ * @remarks
2989
+ * The extended fields of the dataset are in the JSON format. MountPath: the path to mount the dataset.
2990
+ *
2599
2991
  * @example
2600
2992
  * {"mountpath":"/root/data/"}
2601
2993
  */
2602
2994
  options?: string;
2603
- priority?: string;
2604
- quotaId?: string;
2605
2995
  /**
2996
+ * @remarks
2997
+ * The priority of the job. Default value: 1. Valid values: 1 to 9.
2998
+ *
2999
+ * * 1 is the lowest priority.
3000
+ * * 9 is the highest priority.
3001
+ *
2606
3002
  * @example
2607
- * dlc-xxxxxx
3003
+ * 1
2608
3004
  */
2609
- sourceId?: string;
3005
+ priority?: string;
2610
3006
  /**
2611
- * @example
3007
+ * @remarks
3008
+ * The resource quota ID. This parameter is required when you create a TensorBoard job by using a resource quota. <props="china">Call [ListQuotas](https://help.aliyun.com/document_detail/2628071.html) to get the quota ID.
3009
+ * This feature is currently limited to whitelisted users. If you need to use this feature, contact us.
3010
+ *
3011
+ * @example
3012
+ * quota12345
3013
+ */
3014
+ quotaId?: string;
3015
+ /**
3016
+ * @remarks
3017
+ * The source ID.
3018
+ *
3019
+ * @example
3020
+ * dlc-xxxxxx
3021
+ */
3022
+ sourceId?: string;
3023
+ /**
3024
+ * @remarks
3025
+ * The source type.
3026
+ *
3027
+ * @example
2612
3028
  * job
2613
3029
  */
2614
3030
  sourceType?: string;
2615
3031
  /**
3032
+ * @remarks
3033
+ * The directory of summary.
3034
+ *
2616
3035
  * @example
2617
3036
  * /root/data/
2618
3037
  */
2619
3038
  summaryPath?: string;
2620
3039
  /**
3040
+ * @remarks
3041
+ * The relative path of summary.
3042
+ *
2621
3043
  * @example
2622
3044
  * /summary/
2623
3045
  */
2624
3046
  summaryRelativePath?: string;
3047
+ /**
3048
+ * @remarks
3049
+ * The configurations of datasets mounted with the TensorBoard job.
3050
+ */
2625
3051
  tensorboardDataSources?: TensorboardDataSourceSpec[];
3052
+ /**
3053
+ * @remarks
3054
+ * The pay-as-you-go configuration of TensorBoard, which is used to create TensorBoard jobs that use pay-as-you-go resources.
3055
+ */
2626
3056
  tensorboardSpec?: TensorboardSpec;
2627
3057
  /**
3058
+ * @remarks
3059
+ * The dataset URI.
3060
+ *
3061
+ * * Value format when DataSourceType is set to OSS: `oss://[oss-bucket].[endpoint]/[path]`.
3062
+ * * Value format when DataSourceType is set to NAS:`nas://[nas-filesystem-id].[region]/[path]`.
3063
+ *
2628
3064
  * @example
2629
3065
  * oss://.oss-cn-shanghai-finance-1.aliyuncs.com/
2630
3066
  */
2631
3067
  uri?: string;
2632
3068
  /**
3069
+ * @remarks
3070
+ * The workspace ID.
3071
+ * <props="china">Call [ListWorkspaces](https://help.aliyun.com/document_detail/449124.html) to obtain the workspace ID.
3072
+ *
2633
3073
  * @example
2634
3074
  * 123***
2635
3075
  */
@@ -2647,21 +3087,33 @@ export declare class CreateTensorboardRequest extends $dara.Model {
2647
3087
  }
2648
3088
  export declare class CreateTensorboardResponseBody extends $dara.Model {
2649
3089
  /**
3090
+ * @remarks
3091
+ * The dataset ID.
3092
+ *
2650
3093
  * @example
2651
3094
  * ds-20210126170216-xxxxxxxx
2652
3095
  */
2653
3096
  dataSourceId?: string;
2654
3097
  /**
3098
+ * @remarks
3099
+ * The job ID.
3100
+ *
2655
3101
  * @example
2656
3102
  * dlc-20210126170216-xxxxxxxx
2657
3103
  */
2658
3104
  jobId?: string;
2659
3105
  /**
3106
+ * @remarks
3107
+ * The ID of the request.
3108
+ *
2660
3109
  * @example
2661
3110
  * 473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
2662
3111
  */
2663
3112
  requestId?: string;
2664
3113
  /**
3114
+ * @remarks
3115
+ * TensorBoard ID
3116
+ *
2665
3117
  * @example
2666
3118
  * tbxxxxxxxx
2667
3119
  */
@@ -2696,11 +3148,17 @@ export declare class CreateTensorboardResponse extends $dara.Model {
2696
3148
  }
2697
3149
  export declare class DeleteJobResponseBody extends $dara.Model {
2698
3150
  /**
3151
+ * @remarks
3152
+ * The job ID.
3153
+ *
2699
3154
  * @example
2700
3155
  * dlc*************
2701
3156
  */
2702
3157
  jobId?: string;
2703
3158
  /**
3159
+ * @remarks
3160
+ * The request ID. You can troubleshoot issues based on the request ID.
3161
+ *
2704
3162
  * @example
2705
3163
  * 473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
2706
3164
  */
@@ -2735,6 +3193,10 @@ export declare class DeleteJobResponse extends $dara.Model {
2735
3193
  }
2736
3194
  export declare class DeleteTensorboardRequest extends $dara.Model {
2737
3195
  /**
3196
+ * @remarks
3197
+ * The workspace ID.
3198
+ * <props="china">For more information about how to obtain the workspace ID, see [ListWorkspaces](https://help.aliyun.com/document_detail/449124.html).
3199
+ *
2738
3200
  * @example
2739
3201
  * 46099
2740
3202
  */
@@ -2752,11 +3214,17 @@ export declare class DeleteTensorboardRequest extends $dara.Model {
2752
3214
  }
2753
3215
  export declare class DeleteTensorboardResponseBody extends $dara.Model {
2754
3216
  /**
3217
+ * @remarks
3218
+ * The request ID.
3219
+ *
2755
3220
  * @example
2756
3221
  * 473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
2757
3222
  */
2758
3223
  requestId?: string;
2759
3224
  /**
3225
+ * @remarks
3226
+ * The TensorBoard ID.
3227
+ *
2760
3228
  * @example
2761
3229
  * tensorboard-20210114104214-vf9lowjt3pso
2762
3230
  */
@@ -2791,6 +3259,9 @@ export declare class DeleteTensorboardResponse extends $dara.Model {
2791
3259
  }
2792
3260
  export declare class GetJobRequest extends $dara.Model {
2793
3261
  /**
3262
+ * @remarks
3263
+ * Specifies whether to return the job details. Default value: true.
3264
+ *
2794
3265
  * @example
2795
3266
  * true
2796
3267
  */
@@ -2807,157 +3278,316 @@ export declare class GetJobRequest extends $dara.Model {
2807
3278
  });
2808
3279
  }
2809
3280
  export declare class GetJobResponseBody extends $dara.Model {
3281
+ /**
3282
+ * @remarks
3283
+ * The visibility of the job. Valid values:
3284
+ *
3285
+ * * PUBLIC: The code is public in the workspace.
3286
+ * * PRIVATE: The workspace is visible only to you and the administrator of the workspace. This is the default value.
3287
+ *
3288
+ * @example
3289
+ * PRIVATE
3290
+ */
2810
3291
  accessibility?: string;
2811
3292
  /**
3293
+ * @remarks
3294
+ * The cluster ID.
3295
+ *
2812
3296
  * @example
2813
3297
  * a*****
2814
3298
  */
2815
3299
  clusterId?: string;
3300
+ /**
3301
+ * @remarks
3302
+ * The code source.
3303
+ */
2816
3304
  codeSource?: GetJobResponseBodyCodeSource;
3305
+ /**
3306
+ * @remarks
3307
+ * The access credential configurations.
3308
+ */
2817
3309
  credentialConfig?: CredentialConfig;
3310
+ /**
3311
+ * @remarks
3312
+ * The data sources.
3313
+ */
2818
3314
  dataSources?: GetJobResponseBodyDataSources[];
2819
3315
  /**
3316
+ * @remarks
3317
+ * The job name.
3318
+ *
2820
3319
  * @example
2821
3320
  * tf-mnist-test
2822
3321
  */
2823
3322
  displayName?: string;
2824
3323
  /**
3324
+ * @remarks
3325
+ * The duration of the job (seconds).
3326
+ *
2825
3327
  * @example
2826
3328
  * 3602
2827
3329
  */
2828
3330
  duration?: number;
3331
+ /**
3332
+ * @remarks
3333
+ * The elastic job parameters.
3334
+ */
2829
3335
  elasticSpec?: JobElasticSpec;
2830
3336
  /**
3337
+ * @remarks
3338
+ * Specifies whether to enable the debugger job.
3339
+ *
2831
3340
  * @example
2832
3341
  * false
2833
3342
  */
2834
3343
  enabledDebugger?: boolean;
3344
+ /**
3345
+ * @remarks
3346
+ * The configurations of environment variables.
3347
+ */
2835
3348
  envs?: {
2836
3349
  [key: string]: string;
2837
3350
  };
2838
3351
  /**
3352
+ * @remarks
3353
+ * The time when the job was created (UTC).
3354
+ *
2839
3355
  * @example
2840
3356
  * 2021-01-12T14:35:01Z
2841
3357
  */
2842
3358
  gmtCreateTime?: string;
2843
3359
  /**
3360
+ * @remarks
3361
+ * The time of the job failed (UTC).
3362
+ *
2844
3363
  * @example
2845
3364
  * 2021-01-12T15:36:08Z
2846
3365
  */
2847
3366
  gmtFailedTime?: string;
2848
3367
  /**
3368
+ * @remarks
3369
+ * The time when the job ended (UTC).
3370
+ *
2849
3371
  * @example
2850
3372
  * 2021-01-12T15:36:08Z
2851
3373
  */
2852
3374
  gmtFinishTime?: string;
2853
3375
  /**
3376
+ * @remarks
3377
+ * The start time of the job (UTC).
3378
+ *
2854
3379
  * @example
2855
3380
  * 2021-01-12T14:36:21Z
2856
3381
  */
2857
3382
  gmtRunningTime?: string;
2858
3383
  /**
3384
+ * @remarks
3385
+ * The time when the job stopped (UTC).
3386
+ *
2859
3387
  * @example
2860
3388
  * 2021-01-12T15:36:08Z
2861
3389
  */
2862
3390
  gmtStoppedTime?: string;
2863
3391
  /**
3392
+ * @remarks
3393
+ * The time when the job was submitted to the cluster (UTC).
3394
+ *
2864
3395
  * @example
2865
3396
  * 2021-01-12T14:36:01Z
2866
3397
  */
2867
3398
  gmtSubmittedTime?: string;
2868
3399
  /**
3400
+ * @remarks
3401
+ * The time when the job succeeded (UTC).
3402
+ *
2869
3403
  * @example
2870
3404
  * 2021-01-12T15:36:08Z
2871
3405
  */
2872
3406
  gmtSuccessedTime?: string;
2873
3407
  /**
3408
+ * @remarks
3409
+ * The job ID.
3410
+ *
2874
3411
  * @example
2875
3412
  * dlc*******
2876
3413
  */
2877
3414
  jobId?: string;
3415
+ /**
3416
+ * @remarks
3417
+ * The node configurations of the job, which is **JobSpecs** in the CreateJob operation.
3418
+ */
2878
3419
  jobSpecs?: JobSpec[];
2879
3420
  /**
3421
+ * @remarks
3422
+ * The job type. Specified by the JobType parameter of the [CreateJob](https://help.aliyun.com/document_detail/459672.html) operation.
3423
+ *
2880
3424
  * @example
2881
3425
  * TFJob
2882
3426
  */
2883
3427
  jobType?: string;
3428
+ /**
3429
+ * @remarks
3430
+ * All running nodes of the job.
3431
+ */
2884
3432
  pods?: GetJobResponseBodyPods[];
2885
3433
  /**
3434
+ * @remarks
3435
+ * The priority of the job. Valid values: 1 to 9.
3436
+ *
2886
3437
  * @example
2887
3438
  * 1
2888
3439
  */
2889
3440
  priority?: number;
2890
3441
  /**
3442
+ * @remarks
3443
+ * The status detail code, which is a sub-status under the current status.
3444
+ *
2891
3445
  * @example
2892
3446
  * JobStoppedByUser
2893
3447
  */
2894
3448
  reasonCode?: string;
2895
3449
  /**
3450
+ * @remarks
3451
+ * The description of the status detail code.
3452
+ *
2896
3453
  * @example
2897
3454
  * Job is stopped by user.
2898
3455
  */
2899
3456
  reasonMessage?: string;
2900
3457
  /**
3458
+ * @remarks
3459
+ * The request ID, which can be used for troubleshooting.
3460
+ *
2901
3461
  * @example
2902
3462
  * 473469C7-AA6F-4DC5-B3DB-xxxxxxxx
2903
3463
  */
2904
3464
  requestId?: string;
2905
3465
  /**
3466
+ * @remarks
3467
+ * The ID of the resource group to which the job belongs.
3468
+ *
2906
3469
  * @example
2907
3470
  * r******
2908
3471
  */
2909
3472
  resourceId?: string;
2910
3473
  /**
3474
+ * @remarks
3475
+ * The resource level that the job uses.
3476
+ *
2911
3477
  * @example
2912
3478
  * L0
2913
3479
  */
2914
3480
  resourceLevel?: string;
2915
3481
  /**
3482
+ * @remarks
3483
+ * The resource type. Valid values: ECS, Lingjun, and ACS.
3484
+ *
2916
3485
  * @example
2917
3486
  * ECS
2918
3487
  */
2919
3488
  resourceType?: string;
2920
3489
  /**
3490
+ * @remarks
3491
+ * The number of retries and the maximum number of retries used by the job.
3492
+ *
2921
3493
  * @example
2922
3494
  * 0/10
2923
3495
  */
2924
3496
  restartTimes?: string;
3497
+ /**
3498
+ * @remarks
3499
+ * The settings of the additional parameters of the job.
3500
+ */
2925
3501
  settings?: JobSettings;
2926
3502
  /**
3503
+ * @remarks
3504
+ * The status of the job. Valid values:
3505
+ *
3506
+ * * Creating
3507
+ * * Queuing
3508
+ * * Bidding (Only for Lingjun preemptible jobs)
3509
+ * * EnvPreparing
3510
+ * * SanityChecking
3511
+ * * Running
3512
+ * * Restarting
3513
+ * * Stopping
3514
+ * * SucceededReserving
3515
+ * * FailedReserving
3516
+ * * Succeeded
3517
+ * * Failed
3518
+ * * Stopped
3519
+ *
2927
3520
  * @example
2928
3521
  * Stopped
2929
3522
  */
2930
3523
  status?: string;
3524
+ /**
3525
+ * @remarks
3526
+ * The status history.
3527
+ */
2931
3528
  statusHistory?: StatusTransitionItem[];
2932
3529
  /**
3530
+ * @remarks
3531
+ * The sub-status of the job, such as its preemption status.
3532
+ *
2933
3533
  * @example
2934
3534
  * Restarting
2935
3535
  */
2936
3536
  subStatus?: string;
3537
+ /**
3538
+ * @remarks
3539
+ * The tenant ID.
3540
+ *
3541
+ * @example
3542
+ * GAR***W134
3543
+ */
2937
3544
  tenantId?: string;
2938
3545
  /**
3546
+ * @remarks
3547
+ * The directory that contains requirements.txt.
3548
+ *
2939
3549
  * @example
2940
3550
  * /root/code/
2941
3551
  */
2942
3552
  thirdpartyLibDir?: string;
3553
+ /**
3554
+ * @remarks
3555
+ * The third-party Python libraries to be installed.
3556
+ */
2943
3557
  thirdpartyLibs?: string[];
2944
3558
  /**
3559
+ * @remarks
3560
+ * The command that is run to start each node.
3561
+ *
2945
3562
  * @example
2946
3563
  * python /root/code/mnist.py
2947
3564
  */
2948
3565
  userCommand?: string;
2949
3566
  /**
3567
+ * @remarks
3568
+ * The UID of the Alibaba Cloud account who submitted the job.
3569
+ *
2950
3570
  * @example
2951
3571
  * 12*********
2952
3572
  */
2953
3573
  userId?: string;
3574
+ /**
3575
+ * @remarks
3576
+ * The VPC of the user.
3577
+ */
2954
3578
  userVpc?: GetJobResponseBodyUserVpc;
2955
3579
  /**
3580
+ * @remarks
3581
+ * The ID of the workspace to which the job belongs.
3582
+ *
2956
3583
  * @example
2957
3584
  * 268
2958
3585
  */
2959
3586
  workspaceId?: string;
2960
3587
  /**
3588
+ * @remarks
3589
+ * The name of the workspace to which the job belongs.
3590
+ *
2961
3591
  * @example
2962
3592
  * dlc-workspace
2963
3593
  */
@@ -2992,16 +3622,25 @@ export declare class GetJobResponse extends $dara.Model {
2992
3622
  }
2993
3623
  export declare class GetJobEventsRequest extends $dara.Model {
2994
3624
  /**
3625
+ * @remarks
3626
+ * The end time (UTC) of the time range for querying events. The default value is the current time.
3627
+ *
2995
3628
  * @example
2996
3629
  * 2020-11-08T18:00:00Z
2997
3630
  */
2998
3631
  endTime?: string;
2999
3632
  /**
3633
+ * @remarks
3634
+ * The maximum number of events that can be returned. Default value: 2000.
3635
+ *
3000
3636
  * @example
3001
3637
  * 100
3002
3638
  */
3003
3639
  maxEventsNum?: number;
3004
3640
  /**
3641
+ * @remarks
3642
+ * The start time (UTC) of the time range for querying events. The default value is 7 days ago.
3643
+ *
3005
3644
  * @example
3006
3645
  * 2020-11-08T16:00:00Z
3007
3646
  */
@@ -3018,13 +3657,23 @@ export declare class GetJobEventsRequest extends $dara.Model {
3018
3657
  });
3019
3658
  }
3020
3659
  export declare class GetJobEventsResponseBody extends $dara.Model {
3660
+ /**
3661
+ * @remarks
3662
+ * The events.
3663
+ */
3021
3664
  events?: string[];
3022
3665
  /**
3666
+ * @remarks
3667
+ * The job ID.
3668
+ *
3023
3669
  * @example
3024
3670
  * dlc-20210126170216-******
3025
3671
  */
3026
3672
  jobId?: string;
3027
3673
  /**
3674
+ * @remarks
3675
+ * The request ID, which can be used for troubleshooting.
3676
+ *
3028
3677
  * @example
3029
3678
  * 78F6FCE2-278F-4C4A-A6B7-DD8ECEA9C456
3030
3679
  */
@@ -3059,12 +3708,26 @@ export declare class GetJobEventsResponse extends $dara.Model {
3059
3708
  }
3060
3709
  export declare class GetJobMetricsRequest extends $dara.Model {
3061
3710
  /**
3711
+ * @remarks
3712
+ * The end time of the time range to query monitoring data. The time is displayed in UTC. The default value is the current time.
3713
+ *
3062
3714
  * @example
3063
3715
  * 2020-11-09T16:00:00Z
3064
3716
  */
3065
3717
  endTime?: string;
3066
3718
  /**
3067
3719
  * @remarks
3720
+ * The type of the monitoring metrics. Valid values:
3721
+ *
3722
+ * * GpuCoreUsage: GPU utilization
3723
+ * * GpuMemoryUsage: GPU memory utilization
3724
+ * * CpuCoreUsage: CPU utilization
3725
+ * * MemoryUsage: memory utilization
3726
+ * * NetworkInputRate: the network write in rate.
3727
+ * * NetworkOutputRate: the network write out rate
3728
+ * * DiskReadRate: the disk read rate
3729
+ * * DiskWriteRate: the disk write rate
3730
+ *
3068
3731
  * This parameter is required.
3069
3732
  *
3070
3733
  * @example
@@ -3072,16 +3735,25 @@ export declare class GetJobMetricsRequest extends $dara.Model {
3072
3735
  */
3073
3736
  metricType?: string;
3074
3737
  /**
3738
+ * @remarks
3739
+ * The beginning of the time range to query monitoring data. The time is displayed in UTC. The default value is the time 1 hour before the current time.
3740
+ *
3075
3741
  * @example
3076
3742
  * 2020-11-08T16:00:00Z
3077
3743
  */
3078
3744
  startTime?: string;
3079
3745
  /**
3746
+ * @remarks
3747
+ * The interval at which monitoring data is returned. Default value: 5. Unit: minutes.
3748
+ *
3080
3749
  * @example
3081
3750
  * 5m
3082
3751
  */
3083
3752
  timeStep?: string;
3084
3753
  /**
3754
+ * @remarks
3755
+ * The temporary token used for authentication.
3756
+ *
3085
3757
  * @example
3086
3758
  * eyXXXX-XXXX.XXXXX
3087
3759
  */
@@ -3099,12 +3771,22 @@ export declare class GetJobMetricsRequest extends $dara.Model {
3099
3771
  }
3100
3772
  export declare class GetJobMetricsResponseBody extends $dara.Model {
3101
3773
  /**
3774
+ * @remarks
3775
+ * The job ID.
3776
+ *
3102
3777
  * @example
3103
3778
  * dlc-20210126170216-*******
3104
3779
  */
3105
3780
  jobId?: string;
3781
+ /**
3782
+ * @remarks
3783
+ * The monitoring metrics of the job.
3784
+ */
3106
3785
  podMetrics?: PodMetric[];
3107
3786
  /**
3787
+ * @remarks
3788
+ * The request ID. You can troubleshoot issues based on the request ID.
3789
+ *
3108
3790
  * @example
3109
3791
  * 473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
3110
3792
  */
@@ -3140,6 +3822,8 @@ export declare class GetJobMetricsResponse extends $dara.Model {
3140
3822
  export declare class GetJobSanityCheckResultRequest extends $dara.Model {
3141
3823
  /**
3142
3824
  * @remarks
3825
+ * The nth time for which the job sanity check is performed.
3826
+ *
3143
3827
  * This parameter is required.
3144
3828
  *
3145
3829
  * @example
@@ -3147,10 +3831,26 @@ export declare class GetJobSanityCheckResultRequest extends $dara.Model {
3147
3831
  */
3148
3832
  sanityCheckNumber?: number;
3149
3833
  /**
3834
+ * @remarks
3835
+ * The phase in which the job sanity check is performed.
3836
+ *
3837
+ * * CheckInit
3838
+ * * DeviceCheck
3839
+ * * SingleNodeCommCheck
3840
+ * * TwoNodeCommCheck
3841
+ * * AllNodeCommCheck
3842
+ *
3150
3843
  * @example
3151
3844
  * DeviceCheck
3152
3845
  */
3153
3846
  sanityCheckPhase?: string;
3847
+ /**
3848
+ * @remarks
3849
+ * The token information for job sharing. For more information about how to obtain the token information, see [GetToken](https://help.aliyun.com/document_detail/2557812.html).
3850
+ *
3851
+ * @example
3852
+ * eyJhbG******zI1NiIsInR5cCI6IkpXVCJ9.eyJle****jE3MDk1Mzk0NDIsImlhdCI6MTcwODkzNDY0MiwidXNlcl9pZCI6IjE3NTgwNTQxNjI0Mzg2NTUiLCJ0YXJnZXRfaWQiOiJkbGM1OGh1a2xyYzZwdGMyIiwidGFyZ2V0X3R5cGUiOiJqb2IifQ.GNL7jo6****mgKKv0QeGIYgvBufSU-PH_EQttX****
3853
+ */
3154
3854
  token?: string;
3155
3855
  static names(): {
3156
3856
  [key: string]: string;
@@ -3165,15 +3865,25 @@ export declare class GetJobSanityCheckResultRequest extends $dara.Model {
3165
3865
  }
3166
3866
  export declare class GetJobSanityCheckResultResponseBody extends $dara.Model {
3167
3867
  /**
3868
+ * @remarks
3869
+ * The job ID.
3870
+ *
3168
3871
  * @example
3169
3872
  * dlc-20210126170216-xxxxxx
3170
3873
  */
3171
3874
  jobId?: string;
3172
3875
  /**
3876
+ * @remarks
3877
+ * The request ID.
3878
+ *
3173
3879
  * @example
3174
3880
  * B3789344-F1xxxBE-5xx2-A04D-xxxxx
3175
3881
  */
3176
3882
  requestID?: string;
3883
+ /**
3884
+ * @remarks
3885
+ * The job sanity check result.
3886
+ */
3177
3887
  sanityCheckResult?: SanityCheckResultItem[];
3178
3888
  static names(): {
3179
3889
  [key: string]: string;
@@ -3205,21 +3915,33 @@ export declare class GetJobSanityCheckResultResponse extends $dara.Model {
3205
3915
  }
3206
3916
  export declare class GetPodEventsRequest extends $dara.Model {
3207
3917
  /**
3918
+ * @remarks
3919
+ * The end time (UTC).
3920
+ *
3208
3921
  * @example
3209
3922
  * 2020-11-09T16:00:00Z
3210
3923
  */
3211
3924
  endTime?: string;
3212
3925
  /**
3926
+ * @remarks
3927
+ * The maximum number of events that can be returned.
3928
+ *
3213
3929
  * @example
3214
3930
  * 100
3215
3931
  */
3216
3932
  maxEventsNum?: number;
3217
3933
  /**
3934
+ * @remarks
3935
+ * The node UID. Call [GetJob](https://help.aliyun.com/document_detail/459677.html) to get the node UID.
3936
+ *
3218
3937
  * @example
3219
3938
  * dlc-20210126170216-*****-chief-0
3220
3939
  */
3221
3940
  podUid?: string;
3222
3941
  /**
3942
+ * @remarks
3943
+ * The start time (UTC).
3944
+ *
3223
3945
  * @example
3224
3946
  * 2020-11-08T16:00:00Z
3225
3947
  */
@@ -3236,14 +3958,23 @@ export declare class GetPodEventsRequest extends $dara.Model {
3236
3958
  });
3237
3959
  }
3238
3960
  export declare class GetPodEventsResponseBody extends $dara.Model {
3961
+ /**
3962
+ * @remarks
3963
+ * The events returned.
3964
+ */
3239
3965
  events?: string[];
3240
3966
  /**
3967
+ * @remarks
3968
+ * The job ID.
3969
+ *
3241
3970
  * @example
3242
3971
  * dlc-20210126170216-*****
3243
3972
  */
3244
3973
  jobId?: string;
3245
3974
  /**
3246
3975
  * @remarks
3976
+ * The node ID.
3977
+ *
3247
3978
  * This parameter is required.
3248
3979
  *
3249
3980
  * @example
@@ -3251,11 +3982,17 @@ export declare class GetPodEventsResponseBody extends $dara.Model {
3251
3982
  */
3252
3983
  podId?: string;
3253
3984
  /**
3985
+ * @remarks
3986
+ * The node UID.
3987
+ *
3254
3988
  * @example
3255
3989
  * 94a7cc7c-0033-48b5-85bd-71c63592c268
3256
3990
  */
3257
3991
  podUid?: string;
3258
3992
  /**
3993
+ * @remarks
3994
+ * The request ID, which can be used for troubleshooting.
3995
+ *
3259
3996
  * @example
3260
3997
  * 473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
3261
3998
  */
@@ -3290,26 +4027,44 @@ export declare class GetPodEventsResponse extends $dara.Model {
3290
4027
  }
3291
4028
  export declare class GetPodLogsRequest extends $dara.Model {
3292
4029
  /**
4030
+ * @remarks
4031
+ * Specifies whether to download the log file. Default value: false. Valid values:
4032
+ *
4033
+ * * false
4034
+ * * true
4035
+ *
3293
4036
  * @example
3294
4037
  * true
3295
4038
  */
3296
4039
  downloadToFile?: boolean;
3297
4040
  /**
4041
+ * @remarks
4042
+ * The end time of the query. Default value: current time.
4043
+ *
3298
4044
  * @example
3299
4045
  * 2020-11-08T17:00:00Z
3300
4046
  */
3301
4047
  endTime?: string;
3302
4048
  /**
4049
+ * @remarks
4050
+ * The maximum number of log entries. Default value: 2000.
4051
+ *
3303
4052
  * @example
3304
4053
  * 100
3305
4054
  */
3306
4055
  maxLines?: number;
3307
4056
  /**
4057
+ * @remarks
4058
+ * The node UID. For more information about how to obtain a node UID, see [GetJob](https://help.aliyun.com/document_detail/459677.html).
4059
+ *
3308
4060
  * @example
3309
4061
  * fe846462-af2c-4521-bd6f-96787a57****
3310
4062
  */
3311
4063
  podUid?: string;
3312
4064
  /**
4065
+ * @remarks
4066
+ * The start time of the query. Default value: 7 days ago.
4067
+ *
3313
4068
  * @example
3314
4069
  * 2020-11-08T16:00:00Z
3315
4070
  */
@@ -3327,22 +4082,38 @@ export declare class GetPodLogsRequest extends $dara.Model {
3327
4082
  }
3328
4083
  export declare class GetPodLogsResponseBody extends $dara.Model {
3329
4084
  /**
4085
+ * @remarks
4086
+ * The job ID.
4087
+ *
3330
4088
  * @example
3331
4089
  * dlc-20210126170216-******
3332
4090
  */
3333
4091
  jobId?: string;
4092
+ /**
4093
+ * @remarks
4094
+ * The logs.
4095
+ */
3334
4096
  logs?: string[];
3335
4097
  /**
4098
+ * @remarks
4099
+ * The node ID.
4100
+ *
3336
4101
  * @example
3337
4102
  * dlc-20210126170216-****-chief-0
3338
4103
  */
3339
4104
  podId?: string;
3340
4105
  /**
4106
+ * @remarks
4107
+ * The instance UID.
4108
+ *
3341
4109
  * @example
3342
4110
  * 94a7cc7c-0033-48b5-85bd-71c63592c268
3343
4111
  */
3344
4112
  podUid?: string;
3345
4113
  /**
4114
+ * @remarks
4115
+ * The request ID which is used for diagnostics and Q\\&A.
4116
+ *
3346
4117
  * @example
3347
4118
  * 473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
3348
4119
  */
@@ -3377,12 +4148,29 @@ export declare class GetPodLogsResponse extends $dara.Model {
3377
4148
  }
3378
4149
  export declare class GetTensorboardRequest extends $dara.Model {
3379
4150
  /**
4151
+ * @remarks
4152
+ * The job ID. For more information about how to query the job ID, see [ListJob](https://help.aliyun.com/document_detail/459676.html).
4153
+ *
3380
4154
  * @example
3381
4155
  * dlc-xxxxxxxx
3382
4156
  */
3383
4157
  jodId?: string;
4158
+ /**
4159
+ * @remarks
4160
+ * The information about the shared token. You can specify this parameter to obtain the permission to view a TensorBoard job based on the shared token information. You can execute [GetTensorboardSharedUrl](https://help.aliyun.com/document_detail/2557813.html) and extract the shared token from the obtained information.
4161
+ *
4162
+ * @example
4163
+ * eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.e
4164
+ * yJleHAiOjE2OTUyODA0NTMsImlhdCI6MTY5NTE5NDA1MywidXNlcl9pZCI6IjExN
4165
+ * Tc3MDMyNzA5OTQ5MDEiLCJ0YXJnZXRfaWQiOiJ0YjRrOGxjNXhmdTM2b3B0Iiw
4166
+ * idGFyZ2V0X3R5cGUiOiJ0ZW5zb3Jib2FyZCJ9.6eT68J-KMBwwfN2d7fj7u6vyPcf0erfqYeizd2N****
4167
+ */
3384
4168
  token?: string;
3385
4169
  /**
4170
+ * @remarks
4171
+ * The workspace ID.
4172
+ * <props="china">For more information about how to query the workspace ID, see [ListWorkspaces](https://help.aliyun.com/document_detail/449124.html).
4173
+ *
3386
4174
  * @example
3387
4175
  * 46099
3388
4176
  */
@@ -3417,6 +4205,9 @@ export declare class GetTensorboardResponse extends $dara.Model {
3417
4205
  }
3418
4206
  export declare class GetTensorboardSharedUrlRequest extends $dara.Model {
3419
4207
  /**
4208
+ * @remarks
4209
+ * The validity period of the shareable link. Unit: seconds. Maximum value: 604800.
4210
+ *
3420
4211
  * @example
3421
4212
  * 86400
3422
4213
  */
@@ -3434,11 +4225,17 @@ export declare class GetTensorboardSharedUrlRequest extends $dara.Model {
3434
4225
  }
3435
4226
  export declare class GetTensorboardSharedUrlResponseBody extends $dara.Model {
3436
4227
  /**
4228
+ * @remarks
4229
+ * The request ID which is used for troubleshooting.
4230
+ *
3437
4231
  * @example
3438
4232
  * 473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
3439
4233
  */
3440
4234
  requestId?: string;
3441
4235
  /**
4236
+ * @remarks
4237
+ * The shareable link of the TensorBoard task.
4238
+ *
3442
4239
  * @example
3443
4240
  * http://pai-dlc-proxy-xxx.alicyuncs.com/xxx/xxx/token/
3444
4241
  */
@@ -3473,16 +4270,25 @@ export declare class GetTensorboardSharedUrlResponse extends $dara.Model {
3473
4270
  }
3474
4271
  export declare class GetTokenRequest extends $dara.Model {
3475
4272
  /**
4273
+ * @remarks
4274
+ * The time when the share link expires. Default value: 604800 seconds. Minimum value: 0.
4275
+ *
3476
4276
  * @example
3477
4277
  * 60
3478
4278
  */
3479
4279
  expireTime?: number;
3480
4280
  /**
3481
- * @example
4281
+ * @remarks
4282
+ * The ID of the job that is waiting to be shared.
4283
+ *
4284
+ * @example
3482
4285
  * dlc*******
3483
4286
  */
3484
4287
  targetId?: string;
3485
4288
  /**
4289
+ * @remarks
4290
+ * The type of the job that you want to share. Valid values: job and tensorboard.
4291
+ *
3486
4292
  * @example
3487
4293
  * job
3488
4294
  */
@@ -3500,11 +4306,17 @@ export declare class GetTokenRequest extends $dara.Model {
3500
4306
  }
3501
4307
  export declare class GetTokenResponseBody extends $dara.Model {
3502
4308
  /**
4309
+ * @remarks
4310
+ * The request ID, which is used to troubleshoot issues.
4311
+ *
3503
4312
  * @example
3504
4313
  * 473469C7-AA6F-4DC5-B3DB-xxxxxxxx
3505
4314
  */
3506
4315
  requestId?: string;
3507
4316
  /**
4317
+ * @remarks
4318
+ * The token of the shared job, which can be used as the value of the Token parameter in the GetJob API operation to view information about the shared job.
4319
+ *
3508
4320
  * @example
3509
4321
  * eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9*****
3510
4322
  */
@@ -3538,10 +4350,20 @@ export declare class GetTokenResponse extends $dara.Model {
3538
4350
  });
3539
4351
  }
3540
4352
  export declare class GetWebTerminalRequest extends $dara.Model {
4353
+ /**
4354
+ * @remarks
4355
+ * Specifies whether to create a shareable link to access the container. Valid values:
4356
+ *
4357
+ * * true: returns a shareable link to access the container. The link will expire after 30 seconds and can only be used once. After you access the container by using the link, other requests that use this link to access the container become invalid.
4358
+ * * false: returns a common shareable link to access the container. If you use a common shareable link to access a container, Alibaba Cloud identity authentication is required. The link will expire after 30 seconds.
4359
+ *
4360
+ * @example
4361
+ * true
4362
+ */
3541
4363
  isShared?: boolean;
3542
4364
  /**
3543
4365
  * @remarks
3544
- * Pod UID
4366
+ * The pod UID.
3545
4367
  *
3546
4368
  * @example
3547
4369
  * 94a7cc7c-0033-48b5-85bd-71c63592c268
@@ -3559,7 +4381,59 @@ export declare class GetWebTerminalRequest extends $dara.Model {
3559
4381
  });
3560
4382
  }
3561
4383
  export declare class GetWebTerminalResponseBody extends $dara.Model {
4384
+ /**
4385
+ * @remarks
4386
+ * The request ID which is used for diagnostics and Q\\&A.
4387
+ *
4388
+ * @example
4389
+ * 473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
4390
+ */
3562
4391
  requestId?: string;
4392
+ /**
4393
+ * @remarks
4394
+ * The WebSocket URI for accessing the container. You must build a WebSocket client. For more information about the communication format, see the following code:
4395
+ *
4396
+ * ws = new WebSocket(
4397
+ * `wss://xxxxx`,
4398
+ * );
4399
+ * ws.onopen = function open() {
4400
+ * console.warn(\\"connected\\");
4401
+ * term.write(\\"\\r\\");
4402
+ * };
4403
+ *
4404
+ * ws.onclose = function close() {
4405
+ * console.warn(\\"disconnected\\");
4406
+ * term.write(\\"Connection closed\\");
4407
+ * };
4408
+ *
4409
+ * // Return the following information in the backend.
4410
+ * ws.onmessage = function incoming(event) {
4411
+ * const msg = JSON.parse(event.data);
4412
+ * console.warn(msg);
4413
+ * if (msg.operation === \\"stdout\\") {
4414
+ * term.write(msg.data);
4415
+ * } else {
4416
+ * console.warn(\\"invalid msg operation: \\" + msg);
4417
+ * }
4418
+ * };
4419
+ *
4420
+ * // Enter the following code in the console.
4421
+ * term.onData(data => {
4422
+ * const msg = { operation: \\"stdin\\", data: data };
4423
+ * ws.send(JSON.stringify(msg));
4424
+ * });
4425
+ *
4426
+ * term.onResize(size => {
4427
+ * const msg = { operation: \\"resize\\", cols: size.cols, rows: size.rows };
4428
+ * ws.send(JSON.stringify(msg));
4429
+ * });
4430
+ *
4431
+ * fitAddon.fit();
4432
+ * };
4433
+ *
4434
+ * @example
4435
+ * wss://*****
4436
+ */
3563
4437
  webTerminalUrl?: string;
3564
4438
  static names(): {
3565
4439
  [key: string]: string;
@@ -3591,36 +4465,71 @@ export declare class GetWebTerminalResponse extends $dara.Model {
3591
4465
  }
3592
4466
  export declare class ListEcsSpecsRequest extends $dara.Model {
3593
4467
  /**
4468
+ * @remarks
4469
+ * Filter by accelerator type. Valid values:
4470
+ *
4471
+ * * CPU
4472
+ * * GPU
4473
+ *
3594
4474
  * @example
3595
4475
  * GPU
3596
4476
  */
3597
4477
  acceleratorType?: string;
3598
4478
  /**
4479
+ * @remarks
4480
+ * The instance types to query. Separate the types with commas (,).
4481
+ *
3599
4482
  * @example
3600
4483
  * ecs.g6.large,ecs.g6.xlarge
3601
4484
  */
3602
4485
  instanceTypes?: string;
3603
4486
  /**
4487
+ * @remarks
4488
+ * The sorting order. Valid values:
4489
+ *
4490
+ * * desc: descending order.
4491
+ * * asc: ascending order.
4492
+ *
3604
4493
  * @example
3605
4494
  * desc
3606
4495
  */
3607
4496
  order?: string;
3608
4497
  /**
4498
+ * @remarks
4499
+ * The number of the page to query. The start value is 1.
4500
+ *
3609
4501
  * @example
3610
4502
  * 1
3611
4503
  */
3612
4504
  pageNumber?: number;
3613
4505
  /**
4506
+ * @remarks
4507
+ * The number of entries returned per page.
4508
+ *
3614
4509
  * @example
3615
4510
  * 10
3616
4511
  */
3617
4512
  pageSize?: number;
3618
4513
  /**
4514
+ * @remarks
4515
+ * The type of the resource. Valid values:
4516
+ *
4517
+ * * ECS
4518
+ * * Lingjun
4519
+ *
3619
4520
  * @example
3620
4521
  * ECS
3621
4522
  */
3622
4523
  resourceType?: string;
3623
4524
  /**
4525
+ * @remarks
4526
+ * The field based on which the results are sorted. Valid values:
4527
+ *
4528
+ * * CPU
4529
+ * * GPU
4530
+ * * Memory
4531
+ * * GmtCreateTime
4532
+ *
3624
4533
  * @example
3625
4534
  * Gpu
3626
4535
  */
@@ -3637,13 +4546,23 @@ export declare class ListEcsSpecsRequest extends $dara.Model {
3637
4546
  });
3638
4547
  }
3639
4548
  export declare class ListEcsSpecsResponseBody extends $dara.Model {
4549
+ /**
4550
+ * @remarks
4551
+ * The list of ECS specifications.
4552
+ */
3640
4553
  ecsSpecs?: EcsSpec[];
3641
4554
  /**
4555
+ * @remarks
4556
+ * The request ID.
4557
+ *
3642
4558
  * @example
3643
4559
  * 473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
3644
4560
  */
3645
4561
  requestId?: string;
3646
4562
  /**
4563
+ * @remarks
4564
+ * The number of types that meet the filter conditions.
4565
+ *
3647
4566
  * @example
3648
4567
  * 10
3649
4568
  */
@@ -3678,6 +4597,12 @@ export declare class ListEcsSpecsResponse extends $dara.Model {
3678
4597
  }
3679
4598
  export declare class ListJobSanityCheckResultsRequest extends $dara.Model {
3680
4599
  /**
4600
+ * @remarks
4601
+ * The sorting order:
4602
+ *
4603
+ * * desc: descending order
4604
+ * * asc: ascending order
4605
+ *
3681
4606
  * @example
3682
4607
  * desc
3683
4608
  */
@@ -3695,12 +4620,22 @@ export declare class ListJobSanityCheckResultsRequest extends $dara.Model {
3695
4620
  }
3696
4621
  export declare class ListJobSanityCheckResultsResponseBody extends $dara.Model {
3697
4622
  /**
4623
+ * @remarks
4624
+ * The request ID.
4625
+ *
3698
4626
  * @example
3699
4627
  * 1AC9xxx-3xxx-5xxx2-xxxx-FA5
3700
4628
  */
3701
4629
  requestID?: string;
4630
+ /**
4631
+ * @remarks
4632
+ * The sanity check results.
4633
+ */
3702
4634
  sanityCheckResults?: SanityCheckResultItem[][];
3703
4635
  /**
4636
+ * @remarks
4637
+ * The total number of results that meet the filter conditions.
4638
+ *
3704
4639
  * @example
3705
4640
  * 10
3706
4641
  */
@@ -3734,96 +4669,223 @@ export declare class ListJobSanityCheckResultsResponse extends $dara.Model {
3734
4669
  });
3735
4670
  }
3736
4671
  export declare class ListJobsRequest extends $dara.Model {
4672
+ /**
4673
+ * @remarks
4674
+ * The job visibility. Valid values:
4675
+ *
4676
+ * * PUBLIC: The job is visible to all members in the workspace.
4677
+ * * PRIVATE: The job is visible only to you and the administrator of the workspace.
4678
+ *
4679
+ * @example
4680
+ * PRIVATE
4681
+ */
3737
4682
  accessibility?: string;
3738
4683
  /**
4684
+ * @remarks
4685
+ * The ID of the user associated with the job.
4686
+ *
3739
4687
  * @example
3740
4688
  * 16****
3741
4689
  */
3742
4690
  businessUserId?: string;
3743
4691
  /**
4692
+ * @remarks
4693
+ * The caller.
4694
+ *
3744
4695
  * @example
3745
4696
  * local
3746
4697
  */
3747
4698
  caller?: string;
3748
4699
  /**
4700
+ * @remarks
4701
+ * The job name. Fuzzy query is supported. The name is case-insensitive. Wildcards are not supported. For example, if you enter test, test-job1, job-test, job-test2, or job-test can be matched, and job-t1 cannot be matched. The default value null indicates any job name.
4702
+ *
3749
4703
  * @example
3750
4704
  * tf-mnist-test
3751
4705
  */
3752
4706
  displayName?: string;
3753
4707
  /**
4708
+ * @remarks
4709
+ * The end time of the query. Use the job creation time to filter data. The default value is the current time.
4710
+ *
3754
4711
  * @example
3755
4712
  * 2020-11-09T14:45:00Z
3756
4713
  */
3757
4714
  endTime?: string;
3758
4715
  /**
4716
+ * @remarks
4717
+ * Specifies whether to query a list of jobs across workspaces. This parameter must be used together with `ShowOwn=true`. You can use this parameter to query a list of jobs recently submitted by the current user.
4718
+ *
3759
4719
  * @example
3760
4720
  * false
3761
4721
  */
3762
4722
  fromAllWorkspaces?: boolean;
3763
4723
  /**
4724
+ * @remarks
4725
+ * The job ID. Fuzzy query is supported. The name is case-insensitive. Wildcards are not supported. The default value null indicates any job ID.
4726
+ *
3764
4727
  * @example
3765
4728
  * dlc********
3766
4729
  */
3767
4730
  jobId?: string;
3768
4731
  /**
4732
+ * @remarks
4733
+ * The job type. You can query any job type. The default value null indicates any job type. Valid values:
4734
+ *
4735
+ * * TFJob
4736
+ * * PyTorchJob
4737
+ * * XGBoostJob
4738
+ * * OneFlowJob
4739
+ * * ElasticBatchJob
4740
+ *
3769
4741
  * @example
3770
4742
  * TFJob
3771
4743
  */
3772
4744
  jobType?: string;
3773
4745
  /**
4746
+ * @remarks
4747
+ * The sorting order. Valid values:
4748
+ *
4749
+ * * desc (default)
4750
+ * * asc
4751
+ *
3774
4752
  * @example
3775
4753
  * desc
3776
4754
  */
3777
4755
  order?: string;
4756
+ /**
4757
+ * @remarks
4758
+ * The Idle resource information. Valid values:
4759
+ *
4760
+ * * ForbiddenQuotaOverSold
4761
+ * * ForceQuotaOverSold
4762
+ * * AcceptQuotaOverSold-true (true indicates that the job uses idle resources.)
4763
+ * * AcceptQuotaOverSold-false (false indicates that the job uses guaranteed resources.)
4764
+ *
4765
+ * @example
4766
+ * ForbiddenQuotaOverSold
4767
+ */
3778
4768
  oversoldInfo?: string;
3779
4769
  /**
4770
+ * @remarks
4771
+ * The number of the page to return for the current query. Minimum value: 1. Default value: 1.
4772
+ *
3780
4773
  * @example
3781
4774
  * 1
3782
4775
  */
3783
4776
  pageNumber?: number;
3784
4777
  /**
4778
+ * @remarks
4779
+ * The number of entries per page.
4780
+ *
3785
4781
  * @example
3786
4782
  * 50
3787
4783
  */
3788
4784
  pageSize?: number;
3789
4785
  paymentType?: string;
3790
4786
  /**
4787
+ * @remarks
4788
+ * The specific pipeline ID used to filter jobs.
4789
+ *
3791
4790
  * @example
3792
4791
  * flow-*******
3793
4792
  */
3794
4793
  pipelineId?: string;
3795
4794
  /**
4795
+ * @remarks
4796
+ * The resource group ID. For information about how to obtain the ID of a dedicated resource group, see [Manage resource quota](https://help.aliyun.com/document_detail/2651299.html).
4797
+ *
3796
4798
  * @example
3797
4799
  * r*****
3798
4800
  */
3799
4801
  resourceId?: string;
4802
+ /**
4803
+ * @remarks
4804
+ * The resource quota name used to filter jobs. Fuzzy search is supported. Wildcards are not supported. The default value null indicates that jobs are not filtered by resource quota name.
4805
+ *
4806
+ * @example
4807
+ * quota***
4808
+ */
3800
4809
  resourceQuotaName?: string;
3801
4810
  /**
4811
+ * @remarks
4812
+ * Specifies whether to query only the jobs submitted by the current user.
4813
+ *
3802
4814
  * @example
3803
4815
  * true
3804
4816
  */
3805
4817
  showOwn?: boolean;
3806
4818
  /**
4819
+ * @remarks
4820
+ * The sorting field in the returned job list. Valid values:
4821
+ *
4822
+ * * DisplayName
4823
+ * * JobType
4824
+ * * Status
4825
+ * * GmtCreateTime
4826
+ * * GmtFinishTime
4827
+ *
3807
4828
  * @example
3808
4829
  * GmtCreateTime
3809
4830
  */
3810
4831
  sortBy?: string;
3811
4832
  /**
4833
+ * @remarks
4834
+ * The start time of the query. Use the job creation time to filter data. The default value is the current time minus seven days. In other words, if you do not configure the StartTime and EndTime parameters, the system queries the job list in the last seven days.
4835
+ *
3812
4836
  * @example
3813
4837
  * 2020-11-08T16:00:00Z
3814
4838
  */
3815
4839
  startTime?: string;
3816
4840
  /**
4841
+ * @remarks
4842
+ * The job status. Valid values:
4843
+ *
4844
+ * * Creating
4845
+ * * Queuing
4846
+ * * Bidding (only available for spot jobs that use Lingjun resources)
4847
+ * * EnvPreparing
4848
+ * * SanityChecking
4849
+ * * Running
4850
+ * * Restarting
4851
+ * * Stopping
4852
+ * * SucceededReserving
4853
+ * * FailedReserving
4854
+ * * Succeeded
4855
+ * * Failed
4856
+ * * Stopped
4857
+ *
3817
4858
  * @example
3818
4859
  * Running
3819
4860
  */
3820
4861
  status?: string;
4862
+ /**
4863
+ * @remarks
4864
+ * The tags.
4865
+ */
3821
4866
  tags?: {
3822
4867
  [key: string]: string;
3823
4868
  };
4869
+ /**
4870
+ * @remarks
4871
+ * The user ID used to filter jobs.
4872
+ *
4873
+ * @example
4874
+ * 20**************
4875
+ */
3824
4876
  userIdForFilter?: string;
4877
+ /**
4878
+ * @remarks
4879
+ * The username used to filter jobs. Fuzzy search is supported. Wildcards are not supported. The default value null indicates that jobs are not filtered by username.
4880
+ *
4881
+ * @example
4882
+ * test***
4883
+ */
3825
4884
  username?: string;
3826
4885
  /**
4886
+ * @remarks
4887
+ * The workspace ID.
4888
+ *
3827
4889
  * @example
3828
4890
  * 1****
3829
4891
  */
@@ -3840,94 +4902,221 @@ export declare class ListJobsRequest extends $dara.Model {
3840
4902
  });
3841
4903
  }
3842
4904
  export declare class ListJobsShrinkRequest extends $dara.Model {
4905
+ /**
4906
+ * @remarks
4907
+ * The job visibility. Valid values:
4908
+ *
4909
+ * * PUBLIC: The job is visible to all members in the workspace.
4910
+ * * PRIVATE: The job is visible only to you and the administrator of the workspace.
4911
+ *
4912
+ * @example
4913
+ * PRIVATE
4914
+ */
3843
4915
  accessibility?: string;
3844
4916
  /**
4917
+ * @remarks
4918
+ * The ID of the user associated with the job.
4919
+ *
3845
4920
  * @example
3846
4921
  * 16****
3847
4922
  */
3848
4923
  businessUserId?: string;
3849
4924
  /**
4925
+ * @remarks
4926
+ * The caller.
4927
+ *
3850
4928
  * @example
3851
4929
  * local
3852
4930
  */
3853
4931
  caller?: string;
3854
4932
  /**
4933
+ * @remarks
4934
+ * The job name. Fuzzy query is supported. The name is case-insensitive. Wildcards are not supported. For example, if you enter test, test-job1, job-test, job-test2, or job-test can be matched, and job-t1 cannot be matched. The default value null indicates any job name.
4935
+ *
3855
4936
  * @example
3856
4937
  * tf-mnist-test
3857
4938
  */
3858
4939
  displayName?: string;
3859
4940
  /**
4941
+ * @remarks
4942
+ * The end time of the query. Use the job creation time to filter data. The default value is the current time.
4943
+ *
3860
4944
  * @example
3861
4945
  * 2020-11-09T14:45:00Z
3862
4946
  */
3863
4947
  endTime?: string;
3864
4948
  /**
4949
+ * @remarks
4950
+ * Specifies whether to query a list of jobs across workspaces. This parameter must be used together with `ShowOwn=true`. You can use this parameter to query a list of jobs recently submitted by the current user.
4951
+ *
3865
4952
  * @example
3866
4953
  * false
3867
4954
  */
3868
4955
  fromAllWorkspaces?: boolean;
3869
4956
  /**
4957
+ * @remarks
4958
+ * The job ID. Fuzzy query is supported. The name is case-insensitive. Wildcards are not supported. The default value null indicates any job ID.
4959
+ *
3870
4960
  * @example
3871
4961
  * dlc********
3872
4962
  */
3873
4963
  jobId?: string;
3874
4964
  /**
4965
+ * @remarks
4966
+ * The job type. You can query any job type. The default value null indicates any job type. Valid values:
4967
+ *
4968
+ * * TFJob
4969
+ * * PyTorchJob
4970
+ * * XGBoostJob
4971
+ * * OneFlowJob
4972
+ * * ElasticBatchJob
4973
+ *
3875
4974
  * @example
3876
4975
  * TFJob
3877
4976
  */
3878
4977
  jobType?: string;
3879
4978
  /**
4979
+ * @remarks
4980
+ * The sorting order. Valid values:
4981
+ *
4982
+ * * desc (default)
4983
+ * * asc
4984
+ *
3880
4985
  * @example
3881
4986
  * desc
3882
4987
  */
3883
4988
  order?: string;
4989
+ /**
4990
+ * @remarks
4991
+ * The Idle resource information. Valid values:
4992
+ *
4993
+ * * ForbiddenQuotaOverSold
4994
+ * * ForceQuotaOverSold
4995
+ * * AcceptQuotaOverSold-true (true indicates that the job uses idle resources.)
4996
+ * * AcceptQuotaOverSold-false (false indicates that the job uses guaranteed resources.)
4997
+ *
4998
+ * @example
4999
+ * ForbiddenQuotaOverSold
5000
+ */
3884
5001
  oversoldInfo?: string;
3885
5002
  /**
5003
+ * @remarks
5004
+ * The number of the page to return for the current query. Minimum value: 1. Default value: 1.
5005
+ *
3886
5006
  * @example
3887
5007
  * 1
3888
5008
  */
3889
5009
  pageNumber?: number;
3890
5010
  /**
5011
+ * @remarks
5012
+ * The number of entries per page.
5013
+ *
3891
5014
  * @example
3892
5015
  * 50
3893
5016
  */
3894
5017
  pageSize?: number;
3895
5018
  paymentType?: string;
3896
5019
  /**
5020
+ * @remarks
5021
+ * The specific pipeline ID used to filter jobs.
5022
+ *
3897
5023
  * @example
3898
5024
  * flow-*******
3899
5025
  */
3900
5026
  pipelineId?: string;
3901
5027
  /**
5028
+ * @remarks
5029
+ * The resource group ID. For information about how to obtain the ID of a dedicated resource group, see [Manage resource quota](https://help.aliyun.com/document_detail/2651299.html).
5030
+ *
3902
5031
  * @example
3903
5032
  * r*****
3904
5033
  */
3905
5034
  resourceId?: string;
5035
+ /**
5036
+ * @remarks
5037
+ * The resource quota name used to filter jobs. Fuzzy search is supported. Wildcards are not supported. The default value null indicates that jobs are not filtered by resource quota name.
5038
+ *
5039
+ * @example
5040
+ * quota***
5041
+ */
3906
5042
  resourceQuotaName?: string;
3907
5043
  /**
5044
+ * @remarks
5045
+ * Specifies whether to query only the jobs submitted by the current user.
5046
+ *
3908
5047
  * @example
3909
5048
  * true
3910
5049
  */
3911
5050
  showOwn?: boolean;
3912
5051
  /**
5052
+ * @remarks
5053
+ * The sorting field in the returned job list. Valid values:
5054
+ *
5055
+ * * DisplayName
5056
+ * * JobType
5057
+ * * Status
5058
+ * * GmtCreateTime
5059
+ * * GmtFinishTime
5060
+ *
3913
5061
  * @example
3914
5062
  * GmtCreateTime
3915
5063
  */
3916
5064
  sortBy?: string;
3917
5065
  /**
5066
+ * @remarks
5067
+ * The start time of the query. Use the job creation time to filter data. The default value is the current time minus seven days. In other words, if you do not configure the StartTime and EndTime parameters, the system queries the job list in the last seven days.
5068
+ *
3918
5069
  * @example
3919
5070
  * 2020-11-08T16:00:00Z
3920
5071
  */
3921
5072
  startTime?: string;
3922
5073
  /**
5074
+ * @remarks
5075
+ * The job status. Valid values:
5076
+ *
5077
+ * * Creating
5078
+ * * Queuing
5079
+ * * Bidding (only available for spot jobs that use Lingjun resources)
5080
+ * * EnvPreparing
5081
+ * * SanityChecking
5082
+ * * Running
5083
+ * * Restarting
5084
+ * * Stopping
5085
+ * * SucceededReserving
5086
+ * * FailedReserving
5087
+ * * Succeeded
5088
+ * * Failed
5089
+ * * Stopped
5090
+ *
3923
5091
  * @example
3924
5092
  * Running
3925
5093
  */
3926
5094
  status?: string;
5095
+ /**
5096
+ * @remarks
5097
+ * The tags.
5098
+ */
3927
5099
  tagsShrink?: string;
5100
+ /**
5101
+ * @remarks
5102
+ * The user ID used to filter jobs.
5103
+ *
5104
+ * @example
5105
+ * 20**************
5106
+ */
3928
5107
  userIdForFilter?: string;
5108
+ /**
5109
+ * @remarks
5110
+ * The username used to filter jobs. Fuzzy search is supported. Wildcards are not supported. The default value null indicates that jobs are not filtered by username.
5111
+ *
5112
+ * @example
5113
+ * test***
5114
+ */
3929
5115
  username?: string;
3930
5116
  /**
5117
+ * @remarks
5118
+ * The workspace ID.
5119
+ *
3931
5120
  * @example
3932
5121
  * 1****
3933
5122
  */
@@ -3944,13 +5133,23 @@ export declare class ListJobsShrinkRequest extends $dara.Model {
3944
5133
  });
3945
5134
  }
3946
5135
  export declare class ListJobsResponseBody extends $dara.Model {
5136
+ /**
5137
+ * @remarks
5138
+ * The jobs.
5139
+ */
3947
5140
  jobs?: JobItem[];
3948
5141
  /**
5142
+ * @remarks
5143
+ * The request ID used to troubleshoot issues.
5144
+ *
3949
5145
  * @example
3950
5146
  * 473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
3951
5147
  */
3952
5148
  requestId?: string;
3953
5149
  /**
5150
+ * @remarks
5151
+ * The total number of jobs that meet the filter conditions.
5152
+ *
3954
5153
  * @example
3955
5154
  * 2
3956
5155
  */
@@ -3984,78 +5183,190 @@ export declare class ListJobsResponse extends $dara.Model {
3984
5183
  });
3985
5184
  }
3986
5185
  export declare class ListTensorboardsRequest extends $dara.Model {
5186
+ /**
5187
+ * @remarks
5188
+ * The instance visibility.
5189
+ *
5190
+ * * PUBLIC: TensorBoard instances are visible to all members in the workspace.
5191
+ * * PRIVATE: TensorBoard instances are visible only to you and the administrator of the workspace.
5192
+ *
5193
+ * @example
5194
+ * PRIVATE
5195
+ */
3987
5196
  accessibility?: string;
3988
5197
  /**
5198
+ * @remarks
5199
+ * The TensorBoard instance name.
5200
+ *
3989
5201
  * @example
3990
5202
  * TestTensorboard
3991
5203
  */
3992
5204
  displayName?: string;
3993
5205
  /**
5206
+ * @remarks
5207
+ * The end time of the query. Use the UTC time when the TensorBoard instance is created to filter data. If you leave this parameter empty, the default value is the current time.
5208
+ *
3994
5209
  * @example
3995
5210
  * 2020-11-09T14:45:00Z
3996
5211
  */
3997
5212
  endTime?: string;
3998
5213
  /**
5214
+ * @remarks
5215
+ * The job ID used to filter TensorBoard instances. For more information about how to obtain the ID of a job, see [ListJobs](https://help.aliyun.com/document_detail/459676.html).
5216
+ *
3999
5217
  * @example
4000
5218
  * dlc-xxx
4001
5219
  */
4002
5220
  jobId?: string;
4003
5221
  /**
5222
+ * @remarks
5223
+ * The sorting order.
5224
+ *
5225
+ * * desc
5226
+ * * asc
5227
+ *
4004
5228
  * @example
4005
5229
  * desc
4006
5230
  */
4007
5231
  order?: string;
4008
5232
  /**
5233
+ * @remarks
5234
+ * The page number. Minimum value: 1.
5235
+ *
4009
5236
  * @example
4010
5237
  * 1
4011
5238
  */
4012
5239
  pageNumber?: number;
4013
5240
  /**
5241
+ * @remarks
5242
+ * The number of TensorBoard instances per page.
5243
+ *
4014
5244
  * @example
4015
5245
  * 50
4016
5246
  */
4017
5247
  pageSize?: number;
5248
+ /**
5249
+ * @remarks
5250
+ * The billing method of TensorBoard instances.
5251
+ *
5252
+ * * Free: the TensorBoard instance that uses free resources.
5253
+ * * Postpaid: the TensorBoard instance that uses pay-as-you-go resources.
5254
+ *
5255
+ * @example
5256
+ * Postpaid
5257
+ */
4018
5258
  paymentType?: string;
5259
+ /**
5260
+ * @remarks
5261
+ * The resource quota ID.
5262
+ *
5263
+ * >
5264
+ *
5265
+ * * Only whitelisted users can use resource quotas to create TensorBoard instances. If you want to use this feature, contact us.
5266
+ *
5267
+ * * This parameter takes effect only when TensorBoard instances use resource quotas.
5268
+ *
5269
+ * @example
5270
+ * quota12***
5271
+ */
4019
5272
  quotaId?: string;
5273
+ /**
5274
+ * @remarks
5275
+ * Specifies whether to return only the TensorBoard instances created by the current logon account.
5276
+ *
5277
+ * @example
5278
+ * false
5279
+ */
4020
5280
  showOwn?: boolean;
4021
5281
  /**
5282
+ * @remarks
5283
+ * The returned field used to sort TensorBoard instances.
5284
+ *
5285
+ * * DisplayName: the name of the TensorBoard instance.
5286
+ * * GmtCreateTime: the time when the TensorBoard instance is created.
5287
+ *
4022
5288
  * @example
4023
5289
  * GmtCreateTime
4024
5290
  */
4025
5291
  sortBy?: string;
4026
5292
  /**
5293
+ * @remarks
5294
+ * The data source ID. For more information about how to obtain the ID of a job, see [ListJobs](https://help.aliyun.com/document_detail/459676.html).
5295
+ *
4027
5296
  * @example
4028
5297
  * dlc-xxxxxx
4029
5298
  */
4030
5299
  sourceId?: string;
4031
5300
  /**
5301
+ * @remarks
5302
+ * The data source associated with the TensorBoard instance. This parameter is no longer used. Only Deep Learning Containers (DLC) training jobs are supported.
5303
+ *
4032
5304
  * @example
4033
5305
  * job
4034
5306
  */
4035
5307
  sourceType?: string;
4036
5308
  /**
5309
+ * @remarks
5310
+ * The start time of the query. Use the UTC time when the TensorBoard instance is created to filter data. If you leave this parameter empty, the default value is seven days before the current time.
5311
+ *
4037
5312
  * @example
4038
5313
  * 2020-11-08T16:00:00Z
4039
5314
  */
4040
5315
  startTime?: string;
4041
5316
  /**
5317
+ * @remarks
5318
+ * The TensorBoard instance status. Valid values:
5319
+ *
5320
+ * * Creating
5321
+ * * Running
5322
+ * * Stopped
5323
+ * * Succeeded
5324
+ * * Failed
5325
+ *
4042
5326
  * @example
4043
5327
  * Running
4044
5328
  */
4045
5329
  status?: string;
4046
5330
  /**
5331
+ * @remarks
5332
+ * The TensorBoard instance ID used to filter TensorBoard instances.
5333
+ *
4047
5334
  * @example
4048
5335
  * tensorboard-xxx
4049
5336
  */
4050
5337
  tensorboardId?: string;
5338
+ /**
5339
+ * @remarks
5340
+ * The user ID.
5341
+ *
5342
+ * @example
5343
+ * 161****3000
5344
+ */
4051
5345
  userId?: string;
5346
+ /**
5347
+ * @remarks
5348
+ * The username.
5349
+ *
5350
+ * @example
5351
+ * she****mo
5352
+ */
4052
5353
  username?: string;
4053
5354
  /**
5355
+ * @remarks
5356
+ * Specifies whether to return the information about the TensorBoard instance.
5357
+ *
5358
+ * * true
5359
+ * * false
5360
+ *
4054
5361
  * @example
4055
5362
  * true
4056
5363
  */
4057
5364
  verbose?: boolean;
4058
5365
  /**
5366
+ * @remarks
5367
+ * The workspace ID. Obtain a list of TensorBoard instances based on the workspace ID.
5368
+ * <props="china">For more information, see [ListWorkspaces](https://help.aliyun.com/document_detail/449124.html).
5369
+ *
4059
5370
  * @example
4060
5371
  * 380
4061
5372
  */
@@ -4073,12 +5384,22 @@ export declare class ListTensorboardsRequest extends $dara.Model {
4073
5384
  }
4074
5385
  export declare class ListTensorboardsResponseBody extends $dara.Model {
4075
5386
  /**
5387
+ * @remarks
5388
+ * The request ID.
5389
+ *
4076
5390
  * @example
4077
5391
  * 473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
4078
5392
  */
4079
5393
  requestId?: string;
5394
+ /**
5395
+ * @remarks
5396
+ * The TensorBoard instances.
5397
+ */
4080
5398
  tensorboards?: Tensorboard[];
4081
5399
  /**
5400
+ * @remarks
5401
+ * The total number of data sources that meet the conditions.
5402
+ *
4082
5403
  * @example
4083
5404
  * 100
4084
5405
  */
@@ -4113,6 +5434,10 @@ export declare class ListTensorboardsResponse extends $dara.Model {
4113
5434
  }
4114
5435
  export declare class StartTensorboardRequest extends $dara.Model {
4115
5436
  /**
5437
+ * @remarks
5438
+ * The workspace ID.
5439
+ * <props="china">For more information about how to obtain the workspace ID, see [ListWorkspaces](https://help.aliyun.com/document_detail/449124.html).
5440
+ *
4116
5441
  * @example
4117
5442
  * 380
4118
5443
  */
@@ -4130,11 +5455,17 @@ export declare class StartTensorboardRequest extends $dara.Model {
4130
5455
  }
4131
5456
  export declare class StartTensorboardResponseBody extends $dara.Model {
4132
5457
  /**
5458
+ * @remarks
5459
+ * The request ID.
5460
+ *
4133
5461
  * @example
4134
5462
  * 473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
4135
5463
  */
4136
5464
  requestId?: string;
4137
5465
  /**
5466
+ * @remarks
5467
+ * The TensorBoard instance ID.
5468
+ *
4138
5469
  * @example
4139
5470
  * tensorboard-20210114104214-vf9lowjt3pso
4140
5471
  */
@@ -4169,11 +5500,17 @@ export declare class StartTensorboardResponse extends $dara.Model {
4169
5500
  }
4170
5501
  export declare class StopJobResponseBody extends $dara.Model {
4171
5502
  /**
5503
+ * @remarks
5504
+ * The job ID.
5505
+ *
4172
5506
  * @example
4173
5507
  * dlc-20210126170216-xxxxxxx
4174
5508
  */
4175
5509
  jobId?: string;
4176
5510
  /**
5511
+ * @remarks
5512
+ * The request ID. You can troubleshoot issues based on the request ID.
5513
+ *
4177
5514
  * @example
4178
5515
  * 473469C7-AA6F-4DC5-B3DB-xxxxxx
4179
5516
  */
@@ -4208,6 +5545,10 @@ export declare class StopJobResponse extends $dara.Model {
4208
5545
  }
4209
5546
  export declare class StopTensorboardRequest extends $dara.Model {
4210
5547
  /**
5548
+ * @remarks
5549
+ * The workspace ID.
5550
+ * <props="china">For more information about how to query the workspace ID, see [ListWorkspaces](https://help.aliyun.com/document_detail/449124.html).
5551
+ *
4211
5552
  * @example
4212
5553
  * 380
4213
5554
  */
@@ -4225,11 +5566,17 @@ export declare class StopTensorboardRequest extends $dara.Model {
4225
5566
  }
4226
5567
  export declare class StopTensorboardResponseBody extends $dara.Model {
4227
5568
  /**
5569
+ * @remarks
5570
+ * The ID of the request.
5571
+ *
4228
5572
  * @example
4229
5573
  * 473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
4230
5574
  */
4231
5575
  requestId?: string;
4232
5576
  /**
5577
+ * @remarks
5578
+ * The ID of the TensorBoard instance.
5579
+ *
4233
5580
  * @example
4234
5581
  * tensorboard-20210114104214-xxxxxxxx
4235
5582
  */
@@ -4263,8 +5610,24 @@ export declare class StopTensorboardResponse extends $dara.Model {
4263
5610
  });
4264
5611
  }
4265
5612
  export declare class UpdateJobRequest extends $dara.Model {
5613
+ /**
5614
+ * @remarks
5615
+ * The job visibility. Valid values:
5616
+ *
5617
+ * * PUBLIC: The job is visible to all members in the workspace.
5618
+ * * PRIVATE: The job is visible only to you and the administrator of the workspace.
5619
+ *
5620
+ * @example
5621
+ * PRIVATE
5622
+ */
4266
5623
  accessibility?: string;
4267
5624
  /**
5625
+ * @remarks
5626
+ * The job priority. Valid values: 1 to 9.
5627
+ *
5628
+ * * 1: the lowest priority.
5629
+ * * 9: the highest priority.
5630
+ *
4268
5631
  * @example
4269
5632
  * 5
4270
5633
  */
@@ -4282,11 +5645,17 @@ export declare class UpdateJobRequest extends $dara.Model {
4282
5645
  }
4283
5646
  export declare class UpdateJobResponseBody extends $dara.Model {
4284
5647
  /**
5648
+ * @remarks
5649
+ * The job ID.
5650
+ *
4285
5651
  * @example
4286
5652
  * dlc*************
4287
5653
  */
4288
5654
  jobId?: string;
4289
5655
  /**
5656
+ * @remarks
5657
+ * The request ID, which is used for diagnostics and Q\\&A.
5658
+ *
4290
5659
  * @example
4291
5660
  * 473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
4292
5661
  */
@@ -4320,14 +5689,31 @@ export declare class UpdateJobResponse extends $dara.Model {
4320
5689
  });
4321
5690
  }
4322
5691
  export declare class UpdateTensorboardRequest extends $dara.Model {
5692
+ /**
5693
+ * @remarks
5694
+ * The visibility of the jobs. Valid values:
5695
+ *
5696
+ * * PUBLIC: The jobs are public in the workspace.
5697
+ * * PRIVATE: The jobs are visible only to you and the administrator of the workspace.
5698
+ *
5699
+ * @example
5700
+ * PRIVATE
5701
+ */
4323
5702
  accessibility?: string;
4324
5703
  /**
5704
+ * @remarks
5705
+ * The maximum running time. Unit: minutes.
5706
+ *
4325
5707
  * @example
4326
- * MaxRunningTimeMinutes
5708
+ * 300
4327
5709
  */
4328
5710
  maxRunningTimeMinutes?: number;
4329
5711
  priority?: string;
4330
5712
  /**
5713
+ * @remarks
5714
+ * The workspace ID.
5715
+ * <props="china">For more information about how to query the workspace ID, see [ListWorkspaces](https://help.aliyun.com/document_detail/449124.html).
5716
+ *
4331
5717
  * @example
4332
5718
  * 380
4333
5719
  */
@@ -4345,11 +5731,17 @@ export declare class UpdateTensorboardRequest extends $dara.Model {
4345
5731
  }
4346
5732
  export declare class UpdateTensorboardResponseBody extends $dara.Model {
4347
5733
  /**
5734
+ * @remarks
5735
+ * The ID of the request.
5736
+ *
4348
5737
  * @example
4349
5738
  * 473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
4350
5739
  */
4351
5740
  requestId?: string;
4352
5741
  /**
5742
+ * @remarks
5743
+ * The ID of the TensorBoard instance.
5744
+ *
4353
5745
  * @example
4354
5746
  * tensorboard-20210114104214-xxxxxxxx
4355
5747
  */
@@ -4388,7 +5780,10 @@ export default class Client extends OpenApi {
4388
5780
  [key: string]: string;
4389
5781
  }, endpoint: string): string;
4390
5782
  /**
4391
- * 创建一个DLC作业
5783
+ * Creates a job that runs in a cluster. You can configure the data source, code source, startup command, and computing resources of each node on which a job runs.
5784
+ *
5785
+ * @remarks
5786
+ * Before you call this operation, make sure that you understand the billing methods and [pricing](https://help.aliyun.com/document_detail/171758.html) of Deep Learning Containers (DLC) of Platform for AI (PAI).
4392
5787
  *
4393
5788
  * @param request - CreateJobRequest
4394
5789
  * @param headers - map
@@ -4399,14 +5794,17 @@ export default class Client extends OpenApi {
4399
5794
  [key: string]: string;
4400
5795
  }, runtime: $dara.RuntimeOptions): Promise<CreateJobResponse>;
4401
5796
  /**
4402
- * 创建一个DLC作业
5797
+ * Creates a job that runs in a cluster. You can configure the data source, code source, startup command, and computing resources of each node on which a job runs.
5798
+ *
5799
+ * @remarks
5800
+ * Before you call this operation, make sure that you understand the billing methods and [pricing](https://help.aliyun.com/document_detail/171758.html) of Deep Learning Containers (DLC) of Platform for AI (PAI).
4403
5801
  *
4404
5802
  * @param request - CreateJobRequest
4405
5803
  * @returns CreateJobResponse
4406
5804
  */
4407
5805
  createJob(request: CreateJobRequest): Promise<CreateJobResponse>;
4408
5806
  /**
4409
- * 创建一个Tensorboard
5807
+ * Creates a TensorBoard by using a job or specifying a data source configuration.
4410
5808
  *
4411
5809
  * @param request - CreateTensorboardRequest
4412
5810
  * @param headers - map
@@ -4417,14 +5815,14 @@ export default class Client extends OpenApi {
4417
5815
  [key: string]: string;
4418
5816
  }, runtime: $dara.RuntimeOptions): Promise<CreateTensorboardResponse>;
4419
5817
  /**
4420
- * 创建一个Tensorboard
5818
+ * Creates a TensorBoard by using a job or specifying a data source configuration.
4421
5819
  *
4422
5820
  * @param request - CreateTensorboardRequest
4423
5821
  * @returns CreateTensorboardResponse
4424
5822
  */
4425
5823
  createTensorboard(request: CreateTensorboardRequest): Promise<CreateTensorboardResponse>;
4426
5824
  /**
4427
- * 删除一个DLC作业
5825
+ * Deletes a completed or stopped job.
4428
5826
  *
4429
5827
  * @param headers - map
4430
5828
  * @param runtime - runtime options for this request RuntimeOptions
@@ -4434,12 +5832,12 @@ export default class Client extends OpenApi {
4434
5832
  [key: string]: string;
4435
5833
  }, runtime: $dara.RuntimeOptions): Promise<DeleteJobResponse>;
4436
5834
  /**
4437
- * 删除一个DLC作业
5835
+ * Deletes a completed or stopped job.
4438
5836
  * @returns DeleteJobResponse
4439
5837
  */
4440
5838
  deleteJob(JobId: string): Promise<DeleteJobResponse>;
4441
5839
  /**
4442
- * 删除一个数据源配置
5840
+ * Deletes a stopped TensorBoard.
4443
5841
  *
4444
5842
  * @param request - DeleteTensorboardRequest
4445
5843
  * @param headers - map
@@ -4450,14 +5848,14 @@ export default class Client extends OpenApi {
4450
5848
  [key: string]: string;
4451
5849
  }, runtime: $dara.RuntimeOptions): Promise<DeleteTensorboardResponse>;
4452
5850
  /**
4453
- * 删除一个数据源配置
5851
+ * Deletes a stopped TensorBoard.
4454
5852
  *
4455
5853
  * @param request - DeleteTensorboardRequest
4456
5854
  * @returns DeleteTensorboardResponse
4457
5855
  */
4458
5856
  deleteTensorboard(TensorboardId: string, request: DeleteTensorboardRequest): Promise<DeleteTensorboardResponse>;
4459
5857
  /**
4460
- * 获取一个DLC作业详情
5858
+ * Obtains the configuration and runtime information of a job.
4461
5859
  *
4462
5860
  * @param request - GetJobRequest
4463
5861
  * @param headers - map
@@ -4468,14 +5866,14 @@ export default class Client extends OpenApi {
4468
5866
  [key: string]: string;
4469
5867
  }, runtime: $dara.RuntimeOptions): Promise<GetJobResponse>;
4470
5868
  /**
4471
- * 获取一个DLC作业详情
5869
+ * Obtains the configuration and runtime information of a job.
4472
5870
  *
4473
5871
  * @param request - GetJobRequest
4474
5872
  * @returns GetJobResponse
4475
5873
  */
4476
5874
  getJob(JobId: string, request: GetJobRequest): Promise<GetJobResponse>;
4477
5875
  /**
4478
- * 获取作业的事件
5876
+ * Obtains the system events of a job.
4479
5877
  *
4480
5878
  * @param request - GetJobEventsRequest
4481
5879
  * @param headers - map
@@ -4486,14 +5884,14 @@ export default class Client extends OpenApi {
4486
5884
  [key: string]: string;
4487
5885
  }, runtime: $dara.RuntimeOptions): Promise<GetJobEventsResponse>;
4488
5886
  /**
4489
- * 获取作业的事件
5887
+ * Obtains the system events of a job.
4490
5888
  *
4491
5889
  * @param request - GetJobEventsRequest
4492
5890
  * @returns GetJobEventsResponse
4493
5891
  */
4494
5892
  getJobEvents(JobId: string, request: GetJobEventsRequest): Promise<GetJobEventsResponse>;
4495
5893
  /**
4496
- * 获取一个作业的资源监控指标
5894
+ * Obtains the monitoring data of a job, including the CPU, GPU, and memory utilization, network, and disk read/write rate.
4497
5895
  *
4498
5896
  * @param request - GetJobMetricsRequest
4499
5897
  * @param headers - map
@@ -4504,14 +5902,14 @@ export default class Client extends OpenApi {
4504
5902
  [key: string]: string;
4505
5903
  }, runtime: $dara.RuntimeOptions): Promise<GetJobMetricsResponse>;
4506
5904
  /**
4507
- * 获取一个作业的资源监控指标
5905
+ * Obtains the monitoring data of a job, including the CPU, GPU, and memory utilization, network, and disk read/write rate.
4508
5906
  *
4509
5907
  * @param request - GetJobMetricsRequest
4510
5908
  * @returns GetJobMetricsResponse
4511
5909
  */
4512
5910
  getJobMetrics(JobId: string, request: GetJobMetricsRequest): Promise<GetJobMetricsResponse>;
4513
5911
  /**
4514
- * 获取DLC作业某次算力健康检测结果
5912
+ * Obtains specified job sanity check result in a Deep Learning Containers (DLC) job.
4515
5913
  *
4516
5914
  * @param request - GetJobSanityCheckResultRequest
4517
5915
  * @param headers - map
@@ -4522,14 +5920,14 @@ export default class Client extends OpenApi {
4522
5920
  [key: string]: string;
4523
5921
  }, runtime: $dara.RuntimeOptions): Promise<GetJobSanityCheckResultResponse>;
4524
5922
  /**
4525
- * 获取DLC作业某次算力健康检测结果
5923
+ * Obtains specified job sanity check result in a Deep Learning Containers (DLC) job.
4526
5924
  *
4527
5925
  * @param request - GetJobSanityCheckResultRequest
4528
5926
  * @returns GetJobSanityCheckResultResponse
4529
5927
  */
4530
5928
  getJobSanityCheckResult(JobId: string, request: GetJobSanityCheckResultRequest): Promise<GetJobSanityCheckResultResponse>;
4531
5929
  /**
4532
- * 获取作业中一个运行实例的系统事件
5930
+ * Obtains the system events of a specific node in a job to locate and troubleshoot issues.
4533
5931
  *
4534
5932
  * @param request - GetPodEventsRequest
4535
5933
  * @param headers - map
@@ -4540,14 +5938,14 @@ export default class Client extends OpenApi {
4540
5938
  [key: string]: string;
4541
5939
  }, runtime: $dara.RuntimeOptions): Promise<GetPodEventsResponse>;
4542
5940
  /**
4543
- * 获取作业中一个运行实例的系统事件
5941
+ * Obtains the system events of a specific node in a job to locate and troubleshoot issues.
4544
5942
  *
4545
5943
  * @param request - GetPodEventsRequest
4546
5944
  * @returns GetPodEventsResponse
4547
5945
  */
4548
5946
  getPodEvents(JobId: string, PodId: string, request: GetPodEventsRequest): Promise<GetPodEventsResponse>;
4549
5947
  /**
4550
- * 获取作业中一个运行实例的日志
5948
+ * Obtains or downloads the logs of a node for a task. The logs are from the stdout and stderr of the system and user scripts.
4551
5949
  *
4552
5950
  * @param request - GetPodLogsRequest
4553
5951
  * @param headers - map
@@ -4558,14 +5956,14 @@ export default class Client extends OpenApi {
4558
5956
  [key: string]: string;
4559
5957
  }, runtime: $dara.RuntimeOptions): Promise<GetPodLogsResponse>;
4560
5958
  /**
4561
- * 获取作业中一个运行实例的日志
5959
+ * Obtains or downloads the logs of a node for a task. The logs are from the stdout and stderr of the system and user scripts.
4562
5960
  *
4563
5961
  * @param request - GetPodLogsRequest
4564
5962
  * @returns GetPodLogsResponse
4565
5963
  */
4566
5964
  getPodLogs(JobId: string, PodId: string, request: GetPodLogsRequest): Promise<GetPodLogsResponse>;
4567
5965
  /**
4568
- * 获取一个Tensorboard
5966
+ * Queries the information of a TensorBoard instance.
4569
5967
  *
4570
5968
  * @param request - GetTensorboardRequest
4571
5969
  * @param headers - map
@@ -4576,14 +5974,14 @@ export default class Client extends OpenApi {
4576
5974
  [key: string]: string;
4577
5975
  }, runtime: $dara.RuntimeOptions): Promise<GetTensorboardResponse>;
4578
5976
  /**
4579
- * 获取一个Tensorboard
5977
+ * Queries the information of a TensorBoard instance.
4580
5978
  *
4581
5979
  * @param request - GetTensorboardRequest
4582
5980
  * @returns GetTensorboardResponse
4583
5981
  */
4584
5982
  getTensorboard(TensorboardId: string, request: GetTensorboardRequest): Promise<GetTensorboardResponse>;
4585
5983
  /**
4586
- * Get the shared url for tensorboard
5984
+ * Obtains the shareable link of a TensorBoard task. The link contains digital tokens. You can use a shareable link to access a TensorBoard task.
4587
5985
  *
4588
5986
  * @param request - GetTensorboardSharedUrlRequest
4589
5987
  * @param headers - map
@@ -4594,14 +5992,14 @@ export default class Client extends OpenApi {
4594
5992
  [key: string]: string;
4595
5993
  }, runtime: $dara.RuntimeOptions): Promise<GetTensorboardSharedUrlResponse>;
4596
5994
  /**
4597
- * Get the shared url for tensorboard
5995
+ * Obtains the shareable link of a TensorBoard task. The link contains digital tokens. You can use a shareable link to access a TensorBoard task.
4598
5996
  *
4599
5997
  * @param request - GetTensorboardSharedUrlRequest
4600
5998
  * @returns GetTensorboardSharedUrlResponse
4601
5999
  */
4602
6000
  getTensorboardSharedUrl(TensorboardId: string, request: GetTensorboardSharedUrlRequest): Promise<GetTensorboardSharedUrlResponse>;
4603
6001
  /**
4604
- * 获取用户Token
6002
+ * Queries a user token.
4605
6003
  *
4606
6004
  * @param request - GetTokenRequest
4607
6005
  * @param headers - map
@@ -4612,14 +6010,14 @@ export default class Client extends OpenApi {
4612
6010
  [key: string]: string;
4613
6011
  }, runtime: $dara.RuntimeOptions): Promise<GetTokenResponse>;
4614
6012
  /**
4615
- * 获取用户Token
6013
+ * Queries a user token.
4616
6014
  *
4617
6015
  * @param request - GetTokenRequest
4618
6016
  * @returns GetTokenResponse
4619
6017
  */
4620
6018
  getToken(request: GetTokenRequest): Promise<GetTokenResponse>;
4621
6019
  /**
4622
- * Get the url for accessing pod's terminal in k8s
6020
+ * Provides methods and steps to obtain a HTTP link for accessing a container.
4623
6021
  *
4624
6022
  * @param request - GetWebTerminalRequest
4625
6023
  * @param headers - map
@@ -4630,14 +6028,14 @@ export default class Client extends OpenApi {
4630
6028
  [key: string]: string;
4631
6029
  }, runtime: $dara.RuntimeOptions): Promise<GetWebTerminalResponse>;
4632
6030
  /**
4633
- * Get the url for accessing pod's terminal in k8s
6031
+ * Provides methods and steps to obtain a HTTP link for accessing a container.
4634
6032
  *
4635
6033
  * @param request - GetWebTerminalRequest
4636
6034
  * @returns GetWebTerminalResponse
4637
6035
  */
4638
6036
  getWebTerminal(JobId: string, PodId: string, request: GetWebTerminalRequest): Promise<GetWebTerminalResponse>;
4639
6037
  /**
4640
- * ListEcsSpecs
6038
+ * Queries the list of supported instance types.
4641
6039
  *
4642
6040
  * @param request - ListEcsSpecsRequest
4643
6041
  * @param headers - map
@@ -4648,14 +6046,14 @@ export default class Client extends OpenApi {
4648
6046
  [key: string]: string;
4649
6047
  }, runtime: $dara.RuntimeOptions): Promise<ListEcsSpecsResponse>;
4650
6048
  /**
4651
- * ListEcsSpecs
6049
+ * Queries the list of supported instance types.
4652
6050
  *
4653
6051
  * @param request - ListEcsSpecsRequest
4654
6052
  * @returns ListEcsSpecsResponse
4655
6053
  */
4656
6054
  listEcsSpecs(request: ListEcsSpecsRequest): Promise<ListEcsSpecsResponse>;
4657
6055
  /**
4658
- * 获取某个DLC作业的多次算力健康检测结果
6056
+ * Obtains the results of all sanity checks for a DLC job.
4659
6057
  *
4660
6058
  * @param request - ListJobSanityCheckResultsRequest
4661
6059
  * @param headers - map
@@ -4666,14 +6064,14 @@ export default class Client extends OpenApi {
4666
6064
  [key: string]: string;
4667
6065
  }, runtime: $dara.RuntimeOptions): Promise<ListJobSanityCheckResultsResponse>;
4668
6066
  /**
4669
- * 获取某个DLC作业的多次算力健康检测结果
6067
+ * Obtains the results of all sanity checks for a DLC job.
4670
6068
  *
4671
6069
  * @param request - ListJobSanityCheckResultsRequest
4672
6070
  * @returns ListJobSanityCheckResultsResponse
4673
6071
  */
4674
6072
  listJobSanityCheckResults(JobId: string, request: ListJobSanityCheckResultsRequest): Promise<ListJobSanityCheckResultsResponse>;
4675
6073
  /**
4676
- * 根据过滤条件获取DLC作业列表
6074
+ * Queries a list of jobs and supports pagination, sorting, and filtering by conditions.
4677
6075
  *
4678
6076
  * @param tmpReq - ListJobsRequest
4679
6077
  * @param headers - map
@@ -4684,14 +6082,14 @@ export default class Client extends OpenApi {
4684
6082
  [key: string]: string;
4685
6083
  }, runtime: $dara.RuntimeOptions): Promise<ListJobsResponse>;
4686
6084
  /**
4687
- * 根据过滤条件获取DLC作业列表
6085
+ * Queries a list of jobs and supports pagination, sorting, and filtering by conditions.
4688
6086
  *
4689
6087
  * @param request - ListJobsRequest
4690
6088
  * @returns ListJobsResponse
4691
6089
  */
4692
6090
  listJobs(request: ListJobsRequest): Promise<ListJobsResponse>;
4693
6091
  /**
4694
- * 获取Tensorboard
6092
+ * Queries a list of TensorBoard instances.
4695
6093
  *
4696
6094
  * @param request - ListTensorboardsRequest
4697
6095
  * @param headers - map
@@ -4702,14 +6100,14 @@ export default class Client extends OpenApi {
4702
6100
  [key: string]: string;
4703
6101
  }, runtime: $dara.RuntimeOptions): Promise<ListTensorboardsResponse>;
4704
6102
  /**
4705
- * 获取Tensorboard
6103
+ * Queries a list of TensorBoard instances.
4706
6104
  *
4707
6105
  * @param request - ListTensorboardsRequest
4708
6106
  * @returns ListTensorboardsResponse
4709
6107
  */
4710
6108
  listTensorboards(request: ListTensorboardsRequest): Promise<ListTensorboardsResponse>;
4711
6109
  /**
4712
- * 开始运行tensorboard
6110
+ * Starts a TensorBoard instance.
4713
6111
  *
4714
6112
  * @param request - StartTensorboardRequest
4715
6113
  * @param headers - map
@@ -4720,14 +6118,14 @@ export default class Client extends OpenApi {
4720
6118
  [key: string]: string;
4721
6119
  }, runtime: $dara.RuntimeOptions): Promise<StartTensorboardResponse>;
4722
6120
  /**
4723
- * 开始运行tensorboard
6121
+ * Starts a TensorBoard instance.
4724
6122
  *
4725
6123
  * @param request - StartTensorboardRequest
4726
6124
  * @returns StartTensorboardResponse
4727
6125
  */
4728
6126
  startTensorboard(TensorboardId: string, request: StartTensorboardRequest): Promise<StartTensorboardResponse>;
4729
6127
  /**
4730
- * 停止一个DLC作业
6128
+ * Stops a running job.
4731
6129
  *
4732
6130
  * @param headers - map
4733
6131
  * @param runtime - runtime options for this request RuntimeOptions
@@ -4737,12 +6135,12 @@ export default class Client extends OpenApi {
4737
6135
  [key: string]: string;
4738
6136
  }, runtime: $dara.RuntimeOptions): Promise<StopJobResponse>;
4739
6137
  /**
4740
- * 停止一个DLC作业
6138
+ * Stops a running job.
4741
6139
  * @returns StopJobResponse
4742
6140
  */
4743
6141
  stopJob(JobId: string): Promise<StopJobResponse>;
4744
6142
  /**
4745
- * 停止运行tensorboard
6143
+ * Stops a TensorBoard instance.
4746
6144
  *
4747
6145
  * @param request - StopTensorboardRequest
4748
6146
  * @param headers - map
@@ -4753,14 +6151,14 @@ export default class Client extends OpenApi {
4753
6151
  [key: string]: string;
4754
6152
  }, runtime: $dara.RuntimeOptions): Promise<StopTensorboardResponse>;
4755
6153
  /**
4756
- * 停止运行tensorboard
6154
+ * Stops a TensorBoard instance.
4757
6155
  *
4758
6156
  * @param request - StopTensorboardRequest
4759
6157
  * @returns StopTensorboardResponse
4760
6158
  */
4761
6159
  stopTensorboard(TensorboardId: string, request: StopTensorboardRequest): Promise<StopTensorboardResponse>;
4762
6160
  /**
4763
- * 更新一个Job
6161
+ * Updates the configuration information of a job. For example, you can modify the priority of a job in a queue.
4764
6162
  *
4765
6163
  * @param request - UpdateJobRequest
4766
6164
  * @param headers - map
@@ -4771,14 +6169,14 @@ export default class Client extends OpenApi {
4771
6169
  [key: string]: string;
4772
6170
  }, runtime: $dara.RuntimeOptions): Promise<UpdateJobResponse>;
4773
6171
  /**
4774
- * 更新一个Job
6172
+ * Updates the configuration information of a job. For example, you can modify the priority of a job in a queue.
4775
6173
  *
4776
6174
  * @param request - UpdateJobRequest
4777
6175
  * @returns UpdateJobResponse
4778
6176
  */
4779
6177
  updateJob(JobId: string, request: UpdateJobRequest): Promise<UpdateJobResponse>;
4780
6178
  /**
4781
- * 更新tensorboard
6179
+ * Updates a TensorBoard instance.
4782
6180
  *
4783
6181
  * @param request - UpdateTensorboardRequest
4784
6182
  * @param headers - map
@@ -4789,7 +6187,7 @@ export default class Client extends OpenApi {
4789
6187
  [key: string]: string;
4790
6188
  }, runtime: $dara.RuntimeOptions): Promise<UpdateTensorboardResponse>;
4791
6189
  /**
4792
- * 更新tensorboard
6190
+ * Updates a TensorBoard instance.
4793
6191
  *
4794
6192
  * @param request - UpdateTensorboardRequest
4795
6193
  * @returns UpdateTensorboardResponse