@alicloud/pai-dlc20201203 1.11.6 → 1.11.7

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.
Files changed (47) hide show
  1. package/dist/client.d.ts +20 -20
  2. package/dist/client.js +27 -20
  3. package/dist/client.js.map +1 -1
  4. package/dist/models/CreateJobRequest.d.ts +32 -32
  5. package/dist/models/CreateJobResponseBody.d.ts +1 -1
  6. package/dist/models/CreateTensorboardRequest.d.ts +5 -5
  7. package/dist/models/CreateTensorboardResponseBody.d.ts +1 -1
  8. package/dist/models/GetJobRequest.d.ts +1 -1
  9. package/dist/models/GetJobResponseBody.d.ts +45 -45
  10. package/dist/models/GetJobSanityCheckResultRequest.d.ts +5 -5
  11. package/dist/models/GetJobSanityCheckResultResponseBody.d.ts +1 -1
  12. package/dist/models/GetTensorboardRequest.d.ts +1 -1
  13. package/dist/models/GetWebTerminalRequest.d.ts +12 -4
  14. package/dist/models/GetWebTerminalRequest.js +2 -0
  15. package/dist/models/GetWebTerminalRequest.js.map +1 -1
  16. package/dist/models/GetWebTerminalResponseBody.d.ts +3 -3
  17. package/dist/models/JobSettings.d.ts +21 -11
  18. package/dist/models/JobSettings.js +2 -0
  19. package/dist/models/JobSettings.js.map +1 -1
  20. package/dist/models/ListJobsRequest.d.ts +17 -17
  21. package/dist/models/ListJobsShrinkRequest.d.ts +17 -17
  22. package/dist/models/SanityCheckResultItem.d.ts +6 -6
  23. package/dist/models/StartTensorboardResponseBody.d.ts +1 -1
  24. package/dist/models/Tensorboard.d.ts +2 -2
  25. package/dist/models/UpdateJobTemplateRequest.d.ts +6 -6
  26. package/dist/models/UpdateJobTemplateResponseBody.d.ts +2 -2
  27. package/package.json +2 -1
  28. package/src/client.ts +28 -20
  29. package/src/models/CreateJobRequest.ts +32 -32
  30. package/src/models/CreateJobResponseBody.ts +1 -1
  31. package/src/models/CreateTensorboardRequest.ts +5 -5
  32. package/src/models/CreateTensorboardResponseBody.ts +1 -1
  33. package/src/models/GetJobRequest.ts +1 -1
  34. package/src/models/GetJobResponseBody.ts +45 -45
  35. package/src/models/GetJobSanityCheckResultRequest.ts +5 -5
  36. package/src/models/GetJobSanityCheckResultResponseBody.ts +1 -1
  37. package/src/models/GetTensorboardRequest.ts +1 -1
  38. package/src/models/GetWebTerminalRequest.ts +14 -4
  39. package/src/models/GetWebTerminalResponseBody.ts +3 -3
  40. package/src/models/JobSettings.ts +23 -11
  41. package/src/models/ListJobsRequest.ts +17 -17
  42. package/src/models/ListJobsShrinkRequest.ts +17 -17
  43. package/src/models/SanityCheckResultItem.ts +6 -6
  44. package/src/models/StartTensorboardResponseBody.ts +1 -1
  45. package/src/models/Tensorboard.ts +2 -2
  46. package/src/models/UpdateJobTemplateRequest.ts +6 -6
  47. package/src/models/UpdateJobTemplateResponseBody.ts +2 -2
package/dist/client.d.ts CHANGED
@@ -9,11 +9,11 @@ export default class Client extends OpenApi {
9
9
  [key: string]: string;
10
10
  }, endpoint: string): string;
11
11
  /**
12
- * Creates a job to run in a cluster. You can specify configurations such as datasource config, code sources, startup commands, and compute resources for each node where the job runs.
12
+ * Creates a job to run in a cluster. You can specify the data source configuration, code source configuration, startup command, and compute resource configuration for each node where the job runs.
13
13
  *
14
14
  * @remarks
15
- * Before you call this operation, make sure that you fully understand the billing methods and [pricing](https://help.aliyun.com/document_detail/171758.html) of PAI-DLC.
16
- * >Notice: The total length of the CreateJob operation parameters, including system-generated parameters, cannot exceed 65,536 bytes.
15
+ * Make sure that you fully understand the billing methods and [pricing](https://help.aliyun.com/document_detail/171758.html) of PAI-DLC before you call this operation.
16
+ * >Notice: The total length of the parameters for the CreateJob operation, including system-generated parameters, cannot exceed 65,536 bytes.
17
17
  *
18
18
  * @param request - CreateJobRequest
19
19
  * @param headers - map
@@ -24,11 +24,11 @@ export default class Client extends OpenApi {
24
24
  [key: string]: string;
25
25
  }, runtime: $dara.RuntimeOptions): Promise<$_model.CreateJobResponse>;
26
26
  /**
27
- * Creates a job to run in a cluster. You can specify configurations such as datasource config, code sources, startup commands, and compute resources for each node where the job runs.
27
+ * Creates a job to run in a cluster. You can specify the data source configuration, code source configuration, startup command, and compute resource configuration for each node where the job runs.
28
28
  *
29
29
  * @remarks
30
- * Before you call this operation, make sure that you fully understand the billing methods and [pricing](https://help.aliyun.com/document_detail/171758.html) of PAI-DLC.
31
- * >Notice: The total length of the CreateJob operation parameters, including system-generated parameters, cannot exceed 65,536 bytes.
30
+ * Make sure that you fully understand the billing methods and [pricing](https://help.aliyun.com/document_detail/171758.html) of PAI-DLC before you call this operation.
31
+ * >Notice: The total length of the parameters for the CreateJob operation, including system-generated parameters, cannot exceed 65,536 bytes.
32
32
  *
33
33
  * @param request - CreateJobRequest
34
34
  * @returns CreateJobResponse
@@ -109,7 +109,7 @@ export default class Client extends OpenApi {
109
109
  */
110
110
  createSignal(JobId: string, request: $_model.CreateSignalRequest): Promise<$_model.CreateSignalResponse>;
111
111
  /**
112
- * Creates a TensorBoard instance by using a node or a specified datasource config.
112
+ * Creates a TensorBoard instance by using a node or specifying a datasource config.
113
113
  *
114
114
  * @param request - CreateTensorboardRequest
115
115
  * @param headers - map
@@ -120,7 +120,7 @@ export default class Client extends OpenApi {
120
120
  [key: string]: string;
121
121
  }, runtime: $dara.RuntimeOptions): Promise<$_model.CreateTensorboardResponse>;
122
122
  /**
123
- * Creates a TensorBoard instance by using a node or a specified datasource config.
123
+ * Creates a TensorBoard instance by using a node or specifying a datasource config.
124
124
  *
125
125
  * @param request - CreateTensorboardRequest
126
126
  * @returns CreateTensorboardResponse
@@ -184,7 +184,7 @@ export default class Client extends OpenApi {
184
184
  */
185
185
  deleteRayHistoryServer(RayHistoryServerId: string, request: $_model.DeleteRayHistoryServerRequest): Promise<$_model.DeleteRayHistoryServerResponse>;
186
186
  /**
187
- * Deletes a stopped TensorBoard.
187
+ * Deletes a stopped Tensorboard.
188
188
  *
189
189
  * @param request - DeleteTensorboardRequest
190
190
  * @param headers - map
@@ -195,7 +195,7 @@ export default class Client extends OpenApi {
195
195
  [key: string]: string;
196
196
  }, runtime: $dara.RuntimeOptions): Promise<$_model.DeleteTensorboardResponse>;
197
197
  /**
198
- * Deletes a stopped TensorBoard.
198
+ * Deletes a stopped Tensorboard.
199
199
  *
200
200
  * @param request - DeleteTensorboardRequest
201
201
  * @returns DeleteTensorboardResponse
@@ -282,7 +282,7 @@ export default class Client extends OpenApi {
282
282
  */
283
283
  getJobMetrics(JobId: string, request: $_model.GetJobMetricsRequest): Promise<$_model.GetJobMetricsResponse>;
284
284
  /**
285
- * Retrieves a specific computing power health check result for a DLC job.
285
+ * Retrieves the results of a specific computing power health check for a DLC job.
286
286
  *
287
287
  * @param request - GetJobSanityCheckResultRequest
288
288
  * @param headers - map
@@ -293,7 +293,7 @@ export default class Client extends OpenApi {
293
293
  [key: string]: string;
294
294
  }, runtime: $dara.RuntimeOptions): Promise<$_model.GetJobSanityCheckResultResponse>;
295
295
  /**
296
- * Retrieves a specific computing power health check result for a DLC job.
296
+ * Retrieves the results of a specific computing power health check for a DLC job.
297
297
  *
298
298
  * @param request - GetJobSanityCheckResultRequest
299
299
  * @returns GetJobSanityCheckResultResponse
@@ -466,7 +466,7 @@ export default class Client extends OpenApi {
466
466
  */
467
467
  getSignal(JobId: string, SignalId: string, request: $_model.GetSignalRequest): Promise<$_model.GetSignalResponse>;
468
468
  /**
469
- * Retrieves the details of a TensorBoard.
469
+ * Retrieves the details of a Tensorboard.
470
470
  *
471
471
  * @param request - GetTensorboardRequest
472
472
  * @param headers - map
@@ -477,7 +477,7 @@ export default class Client extends OpenApi {
477
477
  [key: string]: string;
478
478
  }, runtime: $dara.RuntimeOptions): Promise<$_model.GetTensorboardResponse>;
479
479
  /**
480
- * Retrieves the details of a TensorBoard.
480
+ * Retrieves the details of a Tensorboard.
481
481
  *
482
482
  * @param request - GetTensorboardRequest
483
483
  * @returns GetTensorboardResponse
@@ -520,7 +520,7 @@ export default class Client extends OpenApi {
520
520
  */
521
521
  getToken(request: $_model.GetTokenRequest): Promise<$_model.GetTokenResponse>;
522
522
  /**
523
- * Provides the method and steps to obtain an HTTP link for accessing a container.
523
+ * Provides the methods and steps to obtain the HTTP link for container access.
524
524
  *
525
525
  * @param request - GetWebTerminalRequest
526
526
  * @param headers - map
@@ -531,7 +531,7 @@ export default class Client extends OpenApi {
531
531
  [key: string]: string;
532
532
  }, runtime: $dara.RuntimeOptions): Promise<$_model.GetWebTerminalResponse>;
533
533
  /**
534
- * Provides the method and steps to obtain an HTTP link for accessing a container.
534
+ * Provides the methods and steps to obtain the HTTP link for container access.
535
535
  *
536
536
  * @param request - GetWebTerminalRequest
537
537
  * @returns GetWebTerminalResponse
@@ -592,7 +592,7 @@ export default class Client extends OpenApi {
592
592
  */
593
593
  listJobTemplates(request: $_model.ListJobTemplatesRequest): Promise<$_model.ListJobTemplatesResponse>;
594
594
  /**
595
- * Queries a list of jobs with support for pagination, sorting, and conditional filtering.
595
+ * Queries a list of jobs, with support for pagination, sorting, and conditional filtering.
596
596
  *
597
597
  * @param tmpReq - ListJobsRequest
598
598
  * @param headers - map
@@ -603,7 +603,7 @@ export default class Client extends OpenApi {
603
603
  [key: string]: string;
604
604
  }, runtime: $dara.RuntimeOptions): Promise<$_model.ListJobsResponse>;
605
605
  /**
606
- * Queries a list of jobs with support for pagination, sorting, and conditional filtering.
606
+ * Queries a list of jobs, with support for pagination, sorting, and conditional filtering.
607
607
  *
608
608
  * @param request - ListJobsRequest
609
609
  * @returns ListJobsResponse
@@ -859,7 +859,7 @@ export default class Client extends OpenApi {
859
859
  */
860
860
  updateJob(JobId: string, request: $_model.UpdateJobRequest): Promise<$_model.UpdateJobResponse>;
861
861
  /**
862
- * Updates a task template.
862
+ * Updates a job template.
863
863
  *
864
864
  * @param request - UpdateJobTemplateRequest
865
865
  * @param headers - map
@@ -870,7 +870,7 @@ export default class Client extends OpenApi {
870
870
  [key: string]: string;
871
871
  }, runtime: $dara.RuntimeOptions): Promise<$_model.UpdateJobTemplateResponse>;
872
872
  /**
873
- * Updates a task template.
873
+ * Updates a job template.
874
874
  *
875
875
  * @param request - UpdateJobTemplateRequest
876
876
  * @returns UpdateJobTemplateResponse
package/dist/client.js CHANGED
@@ -41,6 +41,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
41
41
  Object.defineProperty(exports, "__esModule", { value: true });
42
42
  // This file is auto-generated, don't edit it
43
43
  const $dara = __importStar(require("@darabonba/typescript"));
44
+ const gateway_pop_1 = __importDefault(require("@alicloud/gateway-pop"));
44
45
  const openapi_core_1 = __importDefault(require("@alicloud/openapi-core"));
45
46
  const openapi_core_2 = require("@alicloud/openapi-core");
46
47
  const $_model = __importStar(require("./models/model"));
@@ -48,6 +49,9 @@ __exportStar(require("./models/model"), exports);
48
49
  class Client extends openapi_core_1.default {
49
50
  constructor(config) {
50
51
  super(config);
52
+ this._productId = "pai-dlc";
53
+ let gatewayClient = new gateway_pop_1.default();
54
+ this._spi = gatewayClient;
51
55
  this._endpointRule = "regional";
52
56
  this._endpointMap = {
53
57
  'ap-northeast-2-pop': "pai-dlc.aliyuncs.com",
@@ -107,11 +111,11 @@ class Client extends openapi_core_1.default {
107
111
  return openapi_core_2.OpenApiUtil.getEndpointRules(productId, regionId, endpointRule, network, suffix);
108
112
  }
109
113
  /**
110
- * Creates a job to run in a cluster. You can specify configurations such as datasource config, code sources, startup commands, and compute resources for each node where the job runs.
114
+ * Creates a job to run in a cluster. You can specify the data source configuration, code source configuration, startup command, and compute resource configuration for each node where the job runs.
111
115
  *
112
116
  * @remarks
113
- * Before you call this operation, make sure that you fully understand the billing methods and [pricing](https://help.aliyun.com/document_detail/171758.html) of PAI-DLC.
114
- * >Notice: The total length of the CreateJob operation parameters, including system-generated parameters, cannot exceed 65,536 bytes.
117
+ * Make sure that you fully understand the billing methods and [pricing](https://help.aliyun.com/document_detail/171758.html) of PAI-DLC before you call this operation.
118
+ * >Notice: The total length of the parameters for the CreateJob operation, including system-generated parameters, cannot exceed 65,536 bytes.
115
119
  *
116
120
  * @param request - CreateJobRequest
117
121
  * @param headers - map
@@ -220,11 +224,11 @@ class Client extends openapi_core_1.default {
220
224
  return $dara.cast(await this.callApi(params, req, runtime), new $_model.CreateJobResponse({}));
221
225
  }
222
226
  /**
223
- * Creates a job to run in a cluster. You can specify configurations such as datasource config, code sources, startup commands, and compute resources for each node where the job runs.
227
+ * Creates a job to run in a cluster. You can specify the data source configuration, code source configuration, startup command, and compute resource configuration for each node where the job runs.
224
228
  *
225
229
  * @remarks
226
- * Before you call this operation, make sure that you fully understand the billing methods and [pricing](https://help.aliyun.com/document_detail/171758.html) of PAI-DLC.
227
- * >Notice: The total length of the CreateJob operation parameters, including system-generated parameters, cannot exceed 65,536 bytes.
230
+ * Make sure that you fully understand the billing methods and [pricing](https://help.aliyun.com/document_detail/171758.html) of PAI-DLC before you call this operation.
231
+ * >Notice: The total length of the parameters for the CreateJob operation, including system-generated parameters, cannot exceed 65,536 bytes.
228
232
  *
229
233
  * @param request - CreateJobRequest
230
234
  * @returns CreateJobResponse
@@ -417,7 +421,7 @@ class Client extends openapi_core_1.default {
417
421
  return await this.createSignalWithOptions(JobId, request, headers, runtime);
418
422
  }
419
423
  /**
420
- * Creates a TensorBoard instance by using a node or a specified datasource config.
424
+ * Creates a TensorBoard instance by using a node or specifying a datasource config.
421
425
  *
422
426
  * @param request - CreateTensorboardRequest
423
427
  * @param headers - map
@@ -505,7 +509,7 @@ class Client extends openapi_core_1.default {
505
509
  return $dara.cast(await this.callApi(params, req, runtime), new $_model.CreateTensorboardResponse({}));
506
510
  }
507
511
  /**
508
- * Creates a TensorBoard instance by using a node or a specified datasource config.
512
+ * Creates a TensorBoard instance by using a node or specifying a datasource config.
509
513
  *
510
514
  * @param request - CreateTensorboardRequest
511
515
  * @returns CreateTensorboardResponse
@@ -629,7 +633,7 @@ class Client extends openapi_core_1.default {
629
633
  return await this.deleteRayHistoryServerWithOptions(RayHistoryServerId, request, headers, runtime);
630
634
  }
631
635
  /**
632
- * Deletes a stopped TensorBoard.
636
+ * Deletes a stopped Tensorboard.
633
637
  *
634
638
  * @param request - DeleteTensorboardRequest
635
639
  * @param headers - map
@@ -660,7 +664,7 @@ class Client extends openapi_core_1.default {
660
664
  return $dara.cast(await this.callApi(params, req, runtime), new $_model.DeleteTensorboardResponse({}));
661
665
  }
662
666
  /**
663
- * Deletes a stopped TensorBoard.
667
+ * Deletes a stopped Tensorboard.
664
668
  *
665
669
  * @param request - DeleteTensorboardRequest
666
670
  * @returns DeleteTensorboardResponse
@@ -868,7 +872,7 @@ class Client extends openapi_core_1.default {
868
872
  return await this.getJobMetricsWithOptions(JobId, request, headers, runtime);
869
873
  }
870
874
  /**
871
- * Retrieves a specific computing power health check result for a DLC job.
875
+ * Retrieves the results of a specific computing power health check for a DLC job.
872
876
  *
873
877
  * @param request - GetJobSanityCheckResultRequest
874
878
  * @param headers - map
@@ -905,7 +909,7 @@ class Client extends openapi_core_1.default {
905
909
  return $dara.cast(await this.callApi(params, req, runtime), new $_model.GetJobSanityCheckResultResponse({}));
906
910
  }
907
911
  /**
908
- * Retrieves a specific computing power health check result for a DLC job.
912
+ * Retrieves the results of a specific computing power health check for a DLC job.
909
913
  *
910
914
  * @param request - GetJobSanityCheckResultRequest
911
915
  * @returns GetJobSanityCheckResultResponse
@@ -1299,7 +1303,7 @@ class Client extends openapi_core_1.default {
1299
1303
  return await this.getSignalWithOptions(JobId, SignalId, request, headers, runtime);
1300
1304
  }
1301
1305
  /**
1302
- * Retrieves the details of a TensorBoard.
1306
+ * Retrieves the details of a Tensorboard.
1303
1307
  *
1304
1308
  * @param request - GetTensorboardRequest
1305
1309
  * @param headers - map
@@ -1336,7 +1340,7 @@ class Client extends openapi_core_1.default {
1336
1340
  return $dara.cast(await this.callApi(params, req, runtime), new $_model.GetTensorboardResponse({}));
1337
1341
  }
1338
1342
  /**
1339
- * Retrieves the details of a TensorBoard.
1343
+ * Retrieves the details of a Tensorboard.
1340
1344
  *
1341
1345
  * @param request - GetTensorboardRequest
1342
1346
  * @returns GetTensorboardResponse
@@ -1440,7 +1444,7 @@ class Client extends openapi_core_1.default {
1440
1444
  return await this.getTokenWithOptions(request, headers, runtime);
1441
1445
  }
1442
1446
  /**
1443
- * Provides the method and steps to obtain an HTTP link for accessing a container.
1447
+ * Provides the methods and steps to obtain the HTTP link for container access.
1444
1448
  *
1445
1449
  * @param request - GetWebTerminalRequest
1446
1450
  * @param headers - map
@@ -1450,6 +1454,9 @@ class Client extends openapi_core_1.default {
1450
1454
  async getWebTerminalWithOptions(JobId, PodId, request, headers, runtime) {
1451
1455
  request.validate();
1452
1456
  let query = {};
1457
+ if (!$dara.isNull(request.containerName)) {
1458
+ query["ContainerName"] = request.containerName;
1459
+ }
1453
1460
  if (!$dara.isNull(request.isShared)) {
1454
1461
  query["IsShared"] = request.isShared;
1455
1462
  }
@@ -1474,7 +1481,7 @@ class Client extends openapi_core_1.default {
1474
1481
  return $dara.cast(await this.callApi(params, req, runtime), new $_model.GetWebTerminalResponse({}));
1475
1482
  }
1476
1483
  /**
1477
- * Provides the method and steps to obtain an HTTP link for accessing a container.
1484
+ * Provides the methods and steps to obtain the HTTP link for container access.
1478
1485
  *
1479
1486
  * @param request - GetWebTerminalRequest
1480
1487
  * @returns GetWebTerminalResponse
@@ -1653,7 +1660,7 @@ class Client extends openapi_core_1.default {
1653
1660
  return await this.listJobTemplatesWithOptions(request, headers, runtime);
1654
1661
  }
1655
1662
  /**
1656
- * Queries a list of jobs with support for pagination, sorting, and conditional filtering.
1663
+ * Queries a list of jobs, with support for pagination, sorting, and conditional filtering.
1657
1664
  *
1658
1665
  * @param tmpReq - ListJobsRequest
1659
1666
  * @param headers - map
@@ -1797,7 +1804,7 @@ class Client extends openapi_core_1.default {
1797
1804
  return $dara.cast(await this.callApi(params, req, runtime), new $_model.ListJobsResponse({}));
1798
1805
  }
1799
1806
  /**
1800
- * Queries a list of jobs with support for pagination, sorting, and conditional filtering.
1807
+ * Queries a list of jobs, with support for pagination, sorting, and conditional filtering.
1801
1808
  *
1802
1809
  * @param request - ListJobsRequest
1803
1810
  * @returns ListJobsResponse
@@ -2487,7 +2494,7 @@ class Client extends openapi_core_1.default {
2487
2494
  return await this.updateJobWithOptions(JobId, request, headers, runtime);
2488
2495
  }
2489
2496
  /**
2490
- * Updates a task template.
2497
+ * Updates a job template.
2491
2498
  *
2492
2499
  * @param request - UpdateJobTemplateRequest
2493
2500
  * @param headers - map
@@ -2536,7 +2543,7 @@ class Client extends openapi_core_1.default {
2536
2543
  return $dara.cast(await this.callApi(params, req, runtime), new $_model.UpdateJobTemplateResponse({}));
2537
2544
  }
2538
2545
  /**
2539
- * Updates a task template.
2546
+ * Updates a job template.
2540
2547
  *
2541
2548
  * @param request - UpdateJobTemplateRequest
2542
2549
  * @returns UpdateJobTemplateResponse