@alicloud/pai-dlc20201203 1.10.0 → 1.10.2

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 (65) hide show
  1. package/dist/client.d.ts +30 -30
  2. package/dist/client.js +33 -30
  3. package/dist/client.js.map +1 -1
  4. package/dist/models/ContainerSpec.d.ts +2 -0
  5. package/dist/models/ContainerSpec.js +6 -0
  6. package/dist/models/ContainerSpec.js.map +1 -1
  7. package/dist/models/CreateJobRequest.d.ts +29 -28
  8. package/dist/models/CreateJobRequest.js +2 -0
  9. package/dist/models/CreateJobRequest.js.map +1 -1
  10. package/dist/models/CreateJobResponseBody.d.ts +1 -1
  11. package/dist/models/CreateSignalRequest.d.ts +7 -0
  12. package/dist/models/CreateSignalRequest.js.map +1 -1
  13. package/dist/models/CreateSignalResponseBody.d.ts +15 -0
  14. package/dist/models/CreateSignalResponseBody.js.map +1 -1
  15. package/dist/models/DataJuicerConfig.d.ts +14 -9
  16. package/dist/models/DataJuicerConfig.js.map +1 -1
  17. package/dist/models/GetJobResponseBody.d.ts +31 -16
  18. package/dist/models/GetJobResponseBody.js +6 -0
  19. package/dist/models/GetJobResponseBody.js.map +1 -1
  20. package/dist/models/GetSignalRequest.d.ts +3 -0
  21. package/dist/models/GetSignalRequest.js.map +1 -1
  22. package/dist/models/GetSignalResponseBody.d.ts +38 -0
  23. package/dist/models/GetSignalResponseBody.js.map +1 -1
  24. package/dist/models/JobItem.d.ts +28 -38
  25. package/dist/models/JobItem.js +2 -0
  26. package/dist/models/JobItem.js.map +1 -1
  27. package/dist/models/JobSettings.d.ts +10 -10
  28. package/dist/models/JobSpec.d.ts +4 -3
  29. package/dist/models/JobSpec.js +2 -0
  30. package/dist/models/JobSpec.js.map +1 -1
  31. package/dist/models/ListJobsRequest.d.ts +18 -17
  32. package/dist/models/ListJobsRequest.js +2 -0
  33. package/dist/models/ListJobsRequest.js.map +1 -1
  34. package/dist/models/ListJobsShrinkRequest.d.ts +18 -17
  35. package/dist/models/ListJobsShrinkRequest.js +2 -0
  36. package/dist/models/ListJobsShrinkRequest.js.map +1 -1
  37. package/dist/models/ListSignalsRequest.d.ts +18 -0
  38. package/dist/models/ListSignalsRequest.js.map +1 -1
  39. package/dist/models/ListSignalsResponseBody.d.ts +51 -0
  40. package/dist/models/ListSignalsResponseBody.js.map +1 -1
  41. package/dist/models/PodItem.d.ts +5 -0
  42. package/dist/models/PodItem.js +2 -0
  43. package/dist/models/PodItem.js.map +1 -1
  44. package/dist/models/SignalTarget.d.ts +15 -0
  45. package/dist/models/SignalTarget.js.map +1 -1
  46. package/package.json +1 -1
  47. package/src/client.ts +34 -30
  48. package/src/models/ContainerSpec.ts +7 -0
  49. package/src/models/CreateJobRequest.ts +31 -28
  50. package/src/models/CreateJobResponseBody.ts +1 -1
  51. package/src/models/CreateSignalRequest.ts +7 -0
  52. package/src/models/CreateSignalResponseBody.ts +15 -0
  53. package/src/models/DataJuicerConfig.ts +14 -9
  54. package/src/models/GetJobResponseBody.ts +37 -16
  55. package/src/models/GetSignalRequest.ts +3 -0
  56. package/src/models/GetSignalResponseBody.ts +38 -0
  57. package/src/models/JobItem.ts +30 -38
  58. package/src/models/JobSettings.ts +10 -10
  59. package/src/models/JobSpec.ts +6 -3
  60. package/src/models/ListJobsRequest.ts +20 -17
  61. package/src/models/ListJobsShrinkRequest.ts +20 -17
  62. package/src/models/ListSignalsRequest.ts +18 -0
  63. package/src/models/ListSignalsResponseBody.ts +51 -0
  64. package/src/models/PodItem.ts +7 -0
  65. package/src/models/SignalTarget.ts +15 -0
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 and runs it in a cluster. You can specify the datasource config, code source configuration, startup command, and compute resource configuration for each node on which the job runs.
12
+ * Creates a job and runs it in a cluster. You can specify the datasource config, code source configuration, startup command, and compute resource configuration for each node of the job.
13
13
  *
14
14
  * @remarks
15
- * Before you call this operation, make sure that you are familiar with the billing and [pricing](https://help.aliyun.com/document_detail/171758.html) of PAI-DLC.
16
- * >Notice: The total length of CreateJob request parameters, including system-generated parameters, cannot exceed 65,536 bytes..
15
+ * Make sure that you are familiar with the billing and [pricing](https://help.aliyun.com/document_detail/171758.html) of PAI-DLC before you call this operation.
16
+ * >Notice: The total length of CreateJob request parameters (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 and runs it in a cluster. You can specify the datasource config, code source configuration, startup command, and compute resource configuration for each node on which the job runs.
27
+ * Creates a job and runs it in a cluster. You can specify the datasource config, code source configuration, startup command, and compute resource configuration for each node of the job.
28
28
  *
29
29
  * @remarks
30
- * Before you call this operation, make sure that you are familiar with the billing and [pricing](https://help.aliyun.com/document_detail/171758.html) of PAI-DLC.
31
- * >Notice: The total length of CreateJob request parameters, including system-generated parameters, cannot exceed 65,536 bytes..
30
+ * Make sure that you are familiar with the billing and [pricing](https://help.aliyun.com/document_detail/171758.html) of PAI-DLC before you call this operation.
31
+ * >Notice: The total length of CreateJob request parameters (including system-generated parameters) cannot exceed 65,536 bytes.
32
32
  *
33
33
  * @param request - CreateJobRequest
34
34
  * @returns CreateJobResponse
@@ -79,13 +79,13 @@ export default class Client extends OpenApi {
79
79
  */
80
80
  createRayHistoryServer(request: $_model.CreateRayHistoryServerRequest): Promise<$_model.CreateRayHistoryServerResponse>;
81
81
  /**
82
- * 创建信号
82
+ * Sends a signal to the Pods of a specified job and retrieves the signal ID.
83
83
  *
84
84
  * @remarks
85
- * ## 请求说明
86
- * - 该API用于向指定作业的一个或多个Pod发送特定信号。
87
- * - 发送信号后,API立即返回一个`SignalId`,实际的信号投递由后台worker处理。
88
- * - 信号的状态可以通过`GetSignal`或`ListSignals`接口查询。
85
+ * ## Operation description
86
+ * - This API operation sends a specific signal to one or more Pods of a specified job.
87
+ * - After the signal is sent, the API immediately returns a `SignalId`. The actual signal delivery is processed by a background worker.
88
+ * - Query the signal status by calling the `GetSignal` or `ListSignals` operation.
89
89
  *
90
90
  * @param request - CreateSignalRequest
91
91
  * @param headers - map
@@ -96,13 +96,13 @@ export default class Client extends OpenApi {
96
96
  [key: string]: string;
97
97
  }, runtime: $dara.RuntimeOptions): Promise<$_model.CreateSignalResponse>;
98
98
  /**
99
- * 创建信号
99
+ * Sends a signal to the Pods of a specified job and retrieves the signal ID.
100
100
  *
101
101
  * @remarks
102
- * ## 请求说明
103
- * - 该API用于向指定作业的一个或多个Pod发送特定信号。
104
- * - 发送信号后,API立即返回一个`SignalId`,实际的信号投递由后台worker处理。
105
- * - 信号的状态可以通过`GetSignal`或`ListSignals`接口查询。
102
+ * ## Operation description
103
+ * - This API operation sends a specific signal to one or more Pods of a specified job.
104
+ * - After the signal is sent, the API immediately returns a `SignalId`. The actual signal delivery is processed by a background worker.
105
+ * - Query the signal status by calling the `GetSignal` or `ListSignals` operation.
106
106
  *
107
107
  * @param request - CreateSignalRequest
108
108
  * @returns CreateSignalResponse
@@ -226,7 +226,7 @@ export default class Client extends OpenApi {
226
226
  */
227
227
  getDashboard(jobId: string, request: $_model.GetDashboardRequest): Promise<$_model.GetDashboardResponse>;
228
228
  /**
229
- * Retrieves the detailed configuration and runtime information of a DLC job.
229
+ * Retrieves the detailed configuration and runtime information of a job.
230
230
  *
231
231
  * @param request - GetJobRequest
232
232
  * @param headers - map
@@ -237,7 +237,7 @@ export default class Client extends OpenApi {
237
237
  [key: string]: string;
238
238
  }, runtime: $dara.RuntimeOptions): Promise<$_model.GetJobResponse>;
239
239
  /**
240
- * Retrieves the detailed configuration and runtime information of a DLC job.
240
+ * Retrieves the detailed configuration and runtime information of a job.
241
241
  *
242
242
  * @param request - GetJobRequest
243
243
  * @returns GetJobResponse
@@ -436,11 +436,11 @@ export default class Client extends OpenApi {
436
436
  */
437
437
  getRayHistoryServer(RayHistoryServerId: string, request: $_model.GetRayHistoryServerRequest): Promise<$_model.GetRayHistoryServerResponse>;
438
438
  /**
439
- * 获取信号
439
+ * Queries the details of a specific signal in a specified job.
440
440
  *
441
441
  * @remarks
442
- * ## 请求说明
443
- * 通过此 API,用户可以获取到指定 `JobId` 和 `SignalId` 对应的信号详情,包括信号的状态、发送范围等信息。请注意,返回的结果中不再包含每个 Pod 的原始结果结构,而是通过 `Status`, `Reason`, 和 `Message` 字段来表达信号处理的整体情况。
442
+ * ## Operation description
443
+ * This API allows you to retrieve the signal details for the specified `JobId` and `SignalId`, including the signal status and delivery scope. Note that the response no longer contains the raw result structure for each pod. Instead, the `Status`, `Reason`, and `Message` fields describe the overall signal processing status.
444
444
  *
445
445
  * @param request - GetSignalRequest
446
446
  * @param headers - map
@@ -451,11 +451,11 @@ export default class Client extends OpenApi {
451
451
  [key: string]: string;
452
452
  }, runtime: $dara.RuntimeOptions): Promise<$_model.GetSignalResponse>;
453
453
  /**
454
- * 获取信号
454
+ * Queries the details of a specific signal in a specified job.
455
455
  *
456
456
  * @remarks
457
- * ## 请求说明
458
- * 通过此 API,用户可以获取到指定 `JobId` 和 `SignalId` 对应的信号详情,包括信号的状态、发送范围等信息。请注意,返回的结果中不再包含每个 Pod 的原始结果结构,而是通过 `Status`, `Reason`, 和 `Message` 字段来表达信号处理的整体情况。
457
+ * ## Operation description
458
+ * This API allows you to retrieve the signal details for the specified `JobId` and `SignalId`, including the signal status and delivery scope. Note that the response no longer contains the raw result structure for each pod. Instead, the `Status`, `Reason`, and `Message` fields describe the overall signal processing status.
459
459
  *
460
460
  * @param request - GetSignalRequest
461
461
  * @returns GetSignalResponse
@@ -632,11 +632,11 @@ export default class Client extends OpenApi {
632
632
  */
633
633
  listRayHistoryServers(request: $_model.ListRayHistoryServersRequest): Promise<$_model.ListRayHistoryServersResponse>;
634
634
  /**
635
- * 获取信号列表
635
+ * Queries all signal records of a specified job.
636
636
  *
637
637
  * @remarks
638
- * ## 请求说明
639
- * 通过此 API 可以获取特定作业下的所有信号记录详情,包括信号 ID、状态、创建时间等信息。支持通过查询参数进一步筛选或排序结果。
638
+ * ## Operation description
639
+ * You can call this API operation to retrieve the details of all signal records for a specific job, including signal IDs, statuses, and creation times. You can use query parameters to further filter or sort the results.
640
640
  *
641
641
  * @param request - ListSignalsRequest
642
642
  * @param headers - map
@@ -647,11 +647,11 @@ export default class Client extends OpenApi {
647
647
  [key: string]: string;
648
648
  }, runtime: $dara.RuntimeOptions): Promise<$_model.ListSignalsResponse>;
649
649
  /**
650
- * 获取信号列表
650
+ * Queries all signal records of a specified job.
651
651
  *
652
652
  * @remarks
653
- * ## 请求说明
654
- * 通过此 API 可以获取特定作业下的所有信号记录详情,包括信号 ID、状态、创建时间等信息。支持通过查询参数进一步筛选或排序结果。
653
+ * ## Operation description
654
+ * You can call this API operation to retrieve the details of all signal records for a specific job, including signal IDs, statuses, and creation times. You can use query parameters to further filter or sort the results.
655
655
  *
656
656
  * @param request - ListSignalsRequest
657
657
  * @returns ListSignalsResponse
package/dist/client.js CHANGED
@@ -125,11 +125,11 @@ class Client extends openapi_core_1.default {
125
125
  return openapi_core_2.OpenApiUtil.getEndpointRules(productId, regionId, endpointRule, network, suffix);
126
126
  }
127
127
  /**
128
- * Creates a job and runs it in a cluster. You can specify the datasource config, code source configuration, startup command, and compute resource configuration for each node on which the job runs.
128
+ * Creates a job and runs it in a cluster. You can specify the datasource config, code source configuration, startup command, and compute resource configuration for each node of the job.
129
129
  *
130
130
  * @remarks
131
- * Before you call this operation, make sure that you are familiar with the billing and [pricing](https://help.aliyun.com/document_detail/171758.html) of PAI-DLC.
132
- * >Notice: The total length of CreateJob request parameters, including system-generated parameters, cannot exceed 65,536 bytes..
131
+ * Make sure that you are familiar with the billing and [pricing](https://help.aliyun.com/document_detail/171758.html) of PAI-DLC before you call this operation.
132
+ * >Notice: The total length of CreateJob request parameters (including system-generated parameters) cannot exceed 65,536 bytes.
133
133
  *
134
134
  * @param request - CreateJobRequest
135
135
  * @param headers - map
@@ -235,11 +235,11 @@ class Client extends openapi_core_1.default {
235
235
  return $dara.cast(await this.callApi(params, req, runtime), new $_model.CreateJobResponse({}));
236
236
  }
237
237
  /**
238
- * Creates a job and runs it in a cluster. You can specify the datasource config, code source configuration, startup command, and compute resource configuration for each node on which the job runs.
238
+ * Creates a job and runs it in a cluster. You can specify the datasource config, code source configuration, startup command, and compute resource configuration for each node of the job.
239
239
  *
240
240
  * @remarks
241
- * Before you call this operation, make sure that you are familiar with the billing and [pricing](https://help.aliyun.com/document_detail/171758.html) of PAI-DLC.
242
- * >Notice: The total length of CreateJob request parameters, including system-generated parameters, cannot exceed 65,536 bytes..
241
+ * Make sure that you are familiar with the billing and [pricing](https://help.aliyun.com/document_detail/171758.html) of PAI-DLC before you call this operation.
242
+ * >Notice: The total length of CreateJob request parameters (including system-generated parameters) cannot exceed 65,536 bytes.
243
243
  *
244
244
  * @param request - CreateJobRequest
245
245
  * @returns CreateJobResponse
@@ -375,13 +375,13 @@ class Client extends openapi_core_1.default {
375
375
  return await this.createRayHistoryServerWithOptions(request, headers, runtime);
376
376
  }
377
377
  /**
378
- * 创建信号
378
+ * Sends a signal to the Pods of a specified job and retrieves the signal ID.
379
379
  *
380
380
  * @remarks
381
- * ## 请求说明
382
- * - 该API用于向指定作业的一个或多个Pod发送特定信号。
383
- * - 发送信号后,API立即返回一个`SignalId`,实际的信号投递由后台worker处理。
384
- * - 信号的状态可以通过`GetSignal`或`ListSignals`接口查询。
381
+ * ## Operation description
382
+ * - This API operation sends a specific signal to one or more Pods of a specified job.
383
+ * - After the signal is sent, the API immediately returns a `SignalId`. The actual signal delivery is processed by a background worker.
384
+ * - Query the signal status by calling the `GetSignal` or `ListSignals` operation.
385
385
  *
386
386
  * @param request - CreateSignalRequest
387
387
  * @param headers - map
@@ -415,13 +415,13 @@ class Client extends openapi_core_1.default {
415
415
  return $dara.cast(await this.callApi(params, req, runtime), new $_model.CreateSignalResponse({}));
416
416
  }
417
417
  /**
418
- * 创建信号
418
+ * Sends a signal to the Pods of a specified job and retrieves the signal ID.
419
419
  *
420
420
  * @remarks
421
- * ## 请求说明
422
- * - 该API用于向指定作业的一个或多个Pod发送特定信号。
423
- * - 发送信号后,API立即返回一个`SignalId`,实际的信号投递由后台worker处理。
424
- * - 信号的状态可以通过`GetSignal`或`ListSignals`接口查询。
421
+ * ## Operation description
422
+ * - This API operation sends a specific signal to one or more Pods of a specified job.
423
+ * - After the signal is sent, the API immediately returns a `SignalId`. The actual signal delivery is processed by a background worker.
424
+ * - Query the signal status by calling the `GetSignal` or `ListSignals` operation.
425
425
  *
426
426
  * @param request - CreateSignalRequest
427
427
  * @returns CreateSignalResponse
@@ -737,7 +737,7 @@ class Client extends openapi_core_1.default {
737
737
  return await this.getDashboardWithOptions(jobId, request, headers, runtime);
738
738
  }
739
739
  /**
740
- * Retrieves the detailed configuration and runtime information of a DLC job.
740
+ * Retrieves the detailed configuration and runtime information of a job.
741
741
  *
742
742
  * @param request - GetJobRequest
743
743
  * @param headers - map
@@ -768,7 +768,7 @@ class Client extends openapi_core_1.default {
768
768
  return $dara.cast(await this.callApi(params, req, runtime), new $_model.GetJobResponse({}));
769
769
  }
770
770
  /**
771
- * Retrieves the detailed configuration and runtime information of a DLC job.
771
+ * Retrieves the detailed configuration and runtime information of a job.
772
772
  *
773
773
  * @param request - GetJobRequest
774
774
  * @returns GetJobResponse
@@ -1257,11 +1257,11 @@ class Client extends openapi_core_1.default {
1257
1257
  return await this.getRayHistoryServerWithOptions(RayHistoryServerId, request, headers, runtime);
1258
1258
  }
1259
1259
  /**
1260
- * 获取信号
1260
+ * Queries the details of a specific signal in a specified job.
1261
1261
  *
1262
1262
  * @remarks
1263
- * ## 请求说明
1264
- * 通过此 API,用户可以获取到指定 `JobId` 和 `SignalId` 对应的信号详情,包括信号的状态、发送范围等信息。请注意,返回的结果中不再包含每个 Pod 的原始结果结构,而是通过 `Status`, `Reason`, 和 `Message` 字段来表达信号处理的整体情况。
1263
+ * ## Operation description
1264
+ * This API allows you to retrieve the signal details for the specified `JobId` and `SignalId`, including the signal status and delivery scope. Note that the response no longer contains the raw result structure for each pod. Instead, the `Status`, `Reason`, and `Message` fields describe the overall signal processing status.
1265
1265
  *
1266
1266
  * @param request - GetSignalRequest
1267
1267
  * @param headers - map
@@ -1292,11 +1292,11 @@ class Client extends openapi_core_1.default {
1292
1292
  return $dara.cast(await this.callApi(params, req, runtime), new $_model.GetSignalResponse({}));
1293
1293
  }
1294
1294
  /**
1295
- * 获取信号
1295
+ * Queries the details of a specific signal in a specified job.
1296
1296
  *
1297
1297
  * @remarks
1298
- * ## 请求说明
1299
- * 通过此 API,用户可以获取到指定 `JobId` 和 `SignalId` 对应的信号详情,包括信号的状态、发送范围等信息。请注意,返回的结果中不再包含每个 Pod 的原始结果结构,而是通过 `Status`, `Reason`, 和 `Message` 字段来表达信号处理的整体情况。
1298
+ * ## Operation description
1299
+ * This API allows you to retrieve the signal details for the specified `JobId` and `SignalId`, including the signal status and delivery scope. Note that the response no longer contains the raw result structure for each pod. Instead, the `Status`, `Reason`, and `Message` fields describe the overall signal processing status.
1300
1300
  *
1301
1301
  * @param request - GetSignalRequest
1302
1302
  * @returns GetSignalResponse
@@ -1742,6 +1742,9 @@ class Client extends openapi_core_1.default {
1742
1742
  if (!$dara.isNull(request.resourceId)) {
1743
1743
  query["ResourceId"] = request.resourceId;
1744
1744
  }
1745
+ if (!$dara.isNull(request.resourceIds)) {
1746
+ query["ResourceIds"] = request.resourceIds;
1747
+ }
1745
1748
  if (!$dara.isNull(request.resourceQuotaName)) {
1746
1749
  query["ResourceQuotaName"] = request.resourceQuotaName;
1747
1750
  }
@@ -1905,11 +1908,11 @@ class Client extends openapi_core_1.default {
1905
1908
  return await this.listRayHistoryServersWithOptions(request, headers, runtime);
1906
1909
  }
1907
1910
  /**
1908
- * 获取信号列表
1911
+ * Queries all signal records of a specified job.
1909
1912
  *
1910
1913
  * @remarks
1911
- * ## 请求说明
1912
- * 通过此 API 可以获取特定作业下的所有信号记录详情,包括信号 ID、状态、创建时间等信息。支持通过查询参数进一步筛选或排序结果。
1914
+ * ## Operation description
1915
+ * You can call this API operation to retrieve the details of all signal records for a specific job, including signal IDs, statuses, and creation times. You can use query parameters to further filter or sort the results.
1913
1916
  *
1914
1917
  * @param request - ListSignalsRequest
1915
1918
  * @param headers - map
@@ -1955,11 +1958,11 @@ class Client extends openapi_core_1.default {
1955
1958
  return $dara.cast(await this.callApi(params, req, runtime), new $_model.ListSignalsResponse({}));
1956
1959
  }
1957
1960
  /**
1958
- * 获取信号列表
1961
+ * Queries all signal records of a specified job.
1959
1962
  *
1960
1963
  * @remarks
1961
- * ## 请求说明
1962
- * 通过此 API 可以获取特定作业下的所有信号记录详情,包括信号 ID、状态、创建时间等信息。支持通过查询参数进一步筛选或排序结果。
1964
+ * ## Operation description
1965
+ * You can call this API operation to retrieve the details of all signal records for a specific job, including signal IDs, statuses, and creation times. You can use query parameters to further filter or sort the results.
1963
1966
  *
1964
1967
  * @param request - ListSignalsRequest
1965
1968
  * @returns ListSignalsResponse