@alicloud/pai-dlc20201203 1.11.2 → 1.11.4
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 +94 -88
- package/dist/client.js +97 -88
- package/dist/client.js.map +1 -1
- package/dist/models/CreateJobTemplateRequest.d.ts +6 -6
- package/dist/models/CreateJobTemplateResponseBody.d.ts +22 -12
- package/dist/models/CreateJobTemplateResponseBody.js +2 -0
- package/dist/models/CreateJobTemplateResponseBody.js.map +1 -1
- package/dist/models/CreateRayHistoryServerRequest.d.ts +6 -6
- package/dist/models/CreateTensorboardRequest.d.ts +25 -29
- package/dist/models/CreateTensorboardRequest.js.map +1 -1
- package/dist/models/CreateTensorboardResponseBody.d.ts +2 -2
- package/dist/models/DeleteJobResponseBody.d.ts +1 -1
- package/dist/models/DeleteTensorboardRequest.d.ts +1 -1
- package/dist/models/DeleteTensorboardResponseBody.d.ts +1 -1
- package/dist/models/GetDashboardRequest.d.ts +2 -2
- package/dist/models/GetDashboardResponseBody.d.ts +1 -1
- package/dist/models/GetJobEventsRequest.d.ts +3 -3
- package/dist/models/GetJobEventsResponseBody.d.ts +1 -1
- package/dist/models/GetJobMetricsRequest.d.ts +19 -12
- package/dist/models/GetJobMetricsRequest.js.map +1 -1
- package/dist/models/GetJobMetricsResponseBody.d.ts +3 -3
- package/dist/models/GetJobResponseBody.d.ts +65 -41
- package/dist/models/GetJobResponseBody.js +6 -0
- package/dist/models/GetJobResponseBody.js.map +1 -1
- package/dist/models/GetJobSanityCheckResultRequest.d.ts +8 -9
- package/dist/models/GetJobSanityCheckResultRequest.js.map +1 -1
- package/dist/models/GetJobSanityCheckResultResponseBody.d.ts +1 -1
- package/dist/models/GetJobTemplateRequest.d.ts +1 -1
- package/dist/models/GetJobTemplateResponseBody.d.ts +27 -17
- package/dist/models/GetJobTemplateResponseBody.js +2 -0
- package/dist/models/GetJobTemplateResponseBody.js.map +1 -1
- package/dist/models/GetMetricsRequest.d.ts +9 -9
- package/dist/models/GetMetricsResponseBody.d.ts +6 -4
- package/dist/models/GetMetricsResponseBody.js.map +1 -1
- package/dist/models/GetPodEventsRequest.d.ts +4 -4
- package/dist/models/GetPodEventsResponseBody.d.ts +3 -3
- package/dist/models/GetPodLogsRequest.d.ts +1 -1
- package/dist/models/GetPodLogsResponseBody.d.ts +1 -1
- package/dist/models/GetRayDashboardRequest.d.ts +2 -2
- package/dist/models/GetRayDashboardResponseBody.d.ts +2 -2
- package/dist/models/GetRayHistoryServerResponseBody.d.ts +16 -15
- package/dist/models/GetRayHistoryServerResponseBody.js.map +1 -1
- package/dist/models/GetSignalResponseBody.d.ts +1 -1
- package/dist/models/GetTensorboardRequest.d.ts +2 -2
- package/dist/models/GetTensorboardSharedUrlRequest.d.ts +1 -1
- package/dist/models/GetTensorboardSharedUrlResponseBody.d.ts +2 -2
- package/dist/models/GetWebTerminalRequest.d.ts +5 -6
- package/dist/models/GetWebTerminalRequest.js.map +1 -1
- package/dist/models/GetWebTerminalResponseBody.d.ts +36 -35
- package/dist/models/GetWebTerminalResponseBody.js.map +1 -1
- package/dist/models/ListEcsSpecsRequest.d.ts +17 -21
- package/dist/models/ListEcsSpecsRequest.js.map +1 -1
- package/dist/models/ListEcsSpecsResponseBody.d.ts +1 -1
- package/dist/models/ListJobSanityCheckResultsRequest.d.ts +3 -4
- package/dist/models/ListJobSanityCheckResultsRequest.js.map +1 -1
- package/dist/models/ListJobSanityCheckResultsResponseBody.d.ts +2 -2
- package/dist/models/ListJobTemplatesRequest.d.ts +16 -8
- package/dist/models/ListJobTemplatesRequest.js +2 -0
- package/dist/models/ListJobTemplatesRequest.js.map +1 -1
- package/dist/models/ListJobTemplatesResponseBody.d.ts +24 -14
- package/dist/models/ListJobTemplatesResponseBody.js +2 -0
- package/dist/models/ListJobTemplatesResponseBody.js.map +1 -1
- package/dist/models/ListJobsRequest.d.ts +19 -19
- package/dist/models/ListJobsShrinkRequest.d.ts +19 -19
- package/dist/models/ListRayHistoryServersRequest.d.ts +22 -22
- package/dist/models/ListRayHistoryServersResponseBody.d.ts +18 -18
- package/dist/models/ListSignalsRequest.d.ts +1 -1
- package/dist/models/ListSignalsResponseBody.d.ts +3 -3
- package/dist/models/ListTensorboardsRequest.d.ts +28 -28
- package/dist/models/ListTensorboardsResponseBody.d.ts +1 -1
- package/dist/models/StartRayHistoryServerResponseBody.d.ts +1 -1
- package/dist/models/StartTensorboardRequest.d.ts +1 -1
- package/dist/models/StartTensorboardResponseBody.d.ts +1 -1
- package/dist/models/StopJobResponseBody.d.ts +1 -1
- package/dist/models/StopTensorboardRequest.d.ts +1 -1
- package/dist/models/StopTensorboardResponseBody.d.ts +2 -2
- package/dist/models/UpdateJobRequest.d.ts +7 -0
- package/dist/models/UpdateJobRequest.js.map +1 -1
- package/dist/models/UpdateJobTemplateRequest.d.ts +8 -8
- package/dist/models/UpdateJobTemplateResponseBody.d.ts +3 -3
- package/package.json +1 -1
- package/src/client.ts +98 -88
- package/src/models/CreateJobTemplateRequest.ts +6 -6
- package/src/models/CreateJobTemplateResponseBody.ts +24 -12
- package/src/models/CreateRayHistoryServerRequest.ts +6 -6
- package/src/models/CreateTensorboardRequest.ts +25 -29
- package/src/models/CreateTensorboardResponseBody.ts +2 -2
- package/src/models/DeleteJobResponseBody.ts +1 -1
- package/src/models/DeleteTensorboardRequest.ts +1 -1
- package/src/models/DeleteTensorboardResponseBody.ts +1 -1
- package/src/models/GetDashboardRequest.ts +2 -2
- package/src/models/GetDashboardResponseBody.ts +1 -1
- package/src/models/GetJobEventsRequest.ts +3 -3
- package/src/models/GetJobEventsResponseBody.ts +1 -1
- package/src/models/GetJobMetricsRequest.ts +19 -12
- package/src/models/GetJobMetricsResponseBody.ts +3 -3
- package/src/models/GetJobResponseBody.ts +71 -41
- package/src/models/GetJobSanityCheckResultRequest.ts +8 -9
- package/src/models/GetJobSanityCheckResultResponseBody.ts +1 -1
- package/src/models/GetJobTemplateRequest.ts +1 -1
- package/src/models/GetJobTemplateResponseBody.ts +29 -17
- package/src/models/GetMetricsRequest.ts +9 -9
- package/src/models/GetMetricsResponseBody.ts +6 -4
- package/src/models/GetPodEventsRequest.ts +4 -4
- package/src/models/GetPodEventsResponseBody.ts +3 -3
- package/src/models/GetPodLogsRequest.ts +1 -1
- package/src/models/GetPodLogsResponseBody.ts +1 -1
- package/src/models/GetRayDashboardRequest.ts +2 -2
- package/src/models/GetRayDashboardResponseBody.ts +2 -2
- package/src/models/GetRayHistoryServerResponseBody.ts +16 -15
- package/src/models/GetSignalResponseBody.ts +1 -1
- package/src/models/GetTensorboardRequest.ts +2 -2
- package/src/models/GetTensorboardSharedUrlRequest.ts +1 -1
- package/src/models/GetTensorboardSharedUrlResponseBody.ts +2 -2
- package/src/models/GetWebTerminalRequest.ts +5 -6
- package/src/models/GetWebTerminalResponseBody.ts +36 -35
- package/src/models/ListEcsSpecsRequest.ts +17 -21
- package/src/models/ListEcsSpecsResponseBody.ts +1 -1
- package/src/models/ListJobSanityCheckResultsRequest.ts +3 -4
- package/src/models/ListJobSanityCheckResultsResponseBody.ts +2 -2
- package/src/models/ListJobTemplatesRequest.ts +18 -8
- package/src/models/ListJobTemplatesResponseBody.ts +26 -14
- package/src/models/ListJobsRequest.ts +19 -19
- package/src/models/ListJobsShrinkRequest.ts +19 -19
- package/src/models/ListRayHistoryServersRequest.ts +22 -22
- package/src/models/ListRayHistoryServersResponseBody.ts +18 -18
- package/src/models/ListSignalsRequest.ts +1 -1
- package/src/models/ListSignalsResponseBody.ts +3 -3
- package/src/models/ListTensorboardsRequest.ts +28 -28
- package/src/models/ListTensorboardsResponseBody.ts +1 -1
- package/src/models/StartRayHistoryServerResponseBody.ts +1 -1
- package/src/models/StartTensorboardRequest.ts +1 -1
- package/src/models/StartTensorboardResponseBody.ts +1 -1
- package/src/models/StopJobResponseBody.ts +1 -1
- package/src/models/StopTensorboardRequest.ts +1 -1
- package/src/models/StopTensorboardResponseBody.ts +2 -2
- package/src/models/UpdateJobRequest.ts +7 -0
- package/src/models/UpdateJobTemplateRequest.ts +8 -8
- package/src/models/UpdateJobTemplateResponseBody.ts +3 -3
package/dist/client.d.ts
CHANGED
|
@@ -35,7 +35,7 @@ export default class Client extends OpenApi {
|
|
|
35
35
|
*/
|
|
36
36
|
createJob(request: $_model.CreateJobRequest): Promise<$_model.CreateJobResponse>;
|
|
37
37
|
/**
|
|
38
|
-
* Creates a
|
|
38
|
+
* Creates a task template.
|
|
39
39
|
*
|
|
40
40
|
* @param request - CreateJobTemplateRequest
|
|
41
41
|
* @param headers - map
|
|
@@ -46,7 +46,7 @@ export default class Client extends OpenApi {
|
|
|
46
46
|
[key: string]: string;
|
|
47
47
|
}, runtime: $dara.RuntimeOptions): Promise<$_model.CreateJobTemplateResponse>;
|
|
48
48
|
/**
|
|
49
|
-
* Creates a
|
|
49
|
+
* Creates a task template.
|
|
50
50
|
*
|
|
51
51
|
* @param request - CreateJobTemplateRequest
|
|
52
52
|
* @returns CreateJobTemplateResponse
|
|
@@ -56,8 +56,8 @@ export default class Client extends OpenApi {
|
|
|
56
56
|
* Creates a RayHistoryServer.
|
|
57
57
|
*
|
|
58
58
|
* @remarks
|
|
59
|
-
*
|
|
60
|
-
* >Notice: The total length of CreateJob
|
|
59
|
+
* Make sure you understand the billing methods and [pricing](https://help.aliyun.com/document_detail/171758.html) of PAI-DLC before using this operation.
|
|
60
|
+
* >Notice: The total length of the CreateJob operation parameters (including system-generated parameters) cannot exceed 65536 bytes.
|
|
61
61
|
*
|
|
62
62
|
* @param request - CreateRayHistoryServerRequest
|
|
63
63
|
* @param headers - map
|
|
@@ -71,21 +71,21 @@ export default class Client extends OpenApi {
|
|
|
71
71
|
* Creates a RayHistoryServer.
|
|
72
72
|
*
|
|
73
73
|
* @remarks
|
|
74
|
-
*
|
|
75
|
-
* >Notice: The total length of CreateJob
|
|
74
|
+
* Make sure you understand the billing methods and [pricing](https://help.aliyun.com/document_detail/171758.html) of PAI-DLC before using this operation.
|
|
75
|
+
* >Notice: The total length of the CreateJob operation parameters (including system-generated parameters) cannot exceed 65536 bytes.
|
|
76
76
|
*
|
|
77
77
|
* @param request - CreateRayHistoryServerRequest
|
|
78
78
|
* @returns CreateRayHistoryServerResponse
|
|
79
79
|
*/
|
|
80
80
|
createRayHistoryServer(request: $_model.CreateRayHistoryServerRequest): Promise<$_model.CreateRayHistoryServerResponse>;
|
|
81
81
|
/**
|
|
82
|
-
* Sends a signal to the
|
|
82
|
+
* Sends a signal to the pods of a specified job and retrieves the signal ID.
|
|
83
83
|
*
|
|
84
84
|
* @remarks
|
|
85
85
|
* ## Operation description
|
|
86
|
-
* - This API operation sends a specific signal to one or more
|
|
86
|
+
* - This API operation sends a specific signal to one or more pods of a specified job.
|
|
87
87
|
* - After the signal is sent, the API immediately returns a `SignalId`. The actual signal delivery is processed by a background worker.
|
|
88
|
-
* -
|
|
88
|
+
* - You can query the signal status by calling the `GetSignal` or `ListSignals` operation.
|
|
89
89
|
*
|
|
90
90
|
* @param request - CreateSignalRequest
|
|
91
91
|
* @param headers - map
|
|
@@ -96,20 +96,20 @@ export default class Client extends OpenApi {
|
|
|
96
96
|
[key: string]: string;
|
|
97
97
|
}, runtime: $dara.RuntimeOptions): Promise<$_model.CreateSignalResponse>;
|
|
98
98
|
/**
|
|
99
|
-
* Sends a signal to the
|
|
99
|
+
* Sends a signal to the pods of a specified job and retrieves the signal ID.
|
|
100
100
|
*
|
|
101
101
|
* @remarks
|
|
102
102
|
* ## Operation description
|
|
103
|
-
* - This API operation sends a specific signal to one or more
|
|
103
|
+
* - This API operation sends a specific signal to one or more pods of a specified job.
|
|
104
104
|
* - After the signal is sent, the API immediately returns a `SignalId`. The actual signal delivery is processed by a background worker.
|
|
105
|
-
* -
|
|
105
|
+
* - You can query the signal status by calling the `GetSignal` or `ListSignals` operation.
|
|
106
106
|
*
|
|
107
107
|
* @param request - CreateSignalRequest
|
|
108
108
|
* @returns CreateSignalResponse
|
|
109
109
|
*/
|
|
110
110
|
createSignal(JobId: string, request: $_model.CreateSignalRequest): Promise<$_model.CreateSignalResponse>;
|
|
111
111
|
/**
|
|
112
|
-
* Creates a TensorBoard
|
|
112
|
+
* Creates a TensorBoard instance. You can create a TensorBoard instance from a job or by specifying a datasource config.
|
|
113
113
|
*
|
|
114
114
|
* @param request - CreateTensorboardRequest
|
|
115
115
|
* @param headers - map
|
|
@@ -120,14 +120,14 @@ 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
|
|
123
|
+
* Creates a TensorBoard instance. You can create a TensorBoard instance from a job or by specifying a datasource config.
|
|
124
124
|
*
|
|
125
125
|
* @param request - CreateTensorboardRequest
|
|
126
126
|
* @returns CreateTensorboardResponse
|
|
127
127
|
*/
|
|
128
128
|
createTensorboard(request: $_model.CreateTensorboardRequest): Promise<$_model.CreateTensorboardResponse>;
|
|
129
129
|
/**
|
|
130
|
-
* Deletes a completed or stopped
|
|
130
|
+
* Deletes a job that has completed or been stopped.
|
|
131
131
|
*
|
|
132
132
|
* @param headers - map
|
|
133
133
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -137,12 +137,12 @@ export default class Client extends OpenApi {
|
|
|
137
137
|
[key: string]: string;
|
|
138
138
|
}, runtime: $dara.RuntimeOptions): Promise<$_model.DeleteJobResponse>;
|
|
139
139
|
/**
|
|
140
|
-
* Deletes a completed or stopped
|
|
140
|
+
* Deletes a job that has completed or been stopped.
|
|
141
141
|
* @returns DeleteJobResponse
|
|
142
142
|
*/
|
|
143
143
|
deleteJob(JobId: string): Promise<$_model.DeleteJobResponse>;
|
|
144
144
|
/**
|
|
145
|
-
* Deletes
|
|
145
|
+
* Deletes an unused task template. If the template is already in use by a node, it cannot be deleted.
|
|
146
146
|
*
|
|
147
147
|
* @param request - DeleteJobTemplateRequest
|
|
148
148
|
* @param headers - map
|
|
@@ -153,7 +153,7 @@ export default class Client extends OpenApi {
|
|
|
153
153
|
[key: string]: string;
|
|
154
154
|
}, runtime: $dara.RuntimeOptions): Promise<$_model.DeleteJobTemplateResponse>;
|
|
155
155
|
/**
|
|
156
|
-
* Deletes
|
|
156
|
+
* Deletes an unused task template. If the template is already in use by a node, it cannot be deleted.
|
|
157
157
|
*
|
|
158
158
|
* @param request - DeleteJobTemplateRequest
|
|
159
159
|
* @returns DeleteJobTemplateResponse
|
|
@@ -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
|
|
187
|
+
* Deletes a stopped Tensorboard.
|
|
188
188
|
*
|
|
189
189
|
* @param request - DeleteTensorboardRequest
|
|
190
190
|
* @param headers - map
|
|
@@ -195,17 +195,17 @@ 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
|
|
198
|
+
* Deletes a stopped Tensorboard.
|
|
199
199
|
*
|
|
200
200
|
* @param request - DeleteTensorboardRequest
|
|
201
201
|
* @returns DeleteTensorboardResponse
|
|
202
202
|
*/
|
|
203
203
|
deleteTensorboard(TensorboardId: string, request: $_model.DeleteTensorboardRequest): Promise<$_model.DeleteTensorboardResponse>;
|
|
204
204
|
/**
|
|
205
|
-
* Retrieves the
|
|
205
|
+
* Retrieves the dashboard URL of a DLC job, if available.
|
|
206
206
|
*
|
|
207
207
|
* @remarks
|
|
208
|
-
* Before using this
|
|
208
|
+
* Before using this operation, make sure that you fully understand the billing of PAI-DLC and its [pricing](https://help.aliyun.com/document_detail/171758.html).
|
|
209
209
|
*
|
|
210
210
|
* @param request - GetDashboardRequest
|
|
211
211
|
* @param headers - map
|
|
@@ -216,17 +216,17 @@ export default class Client extends OpenApi {
|
|
|
216
216
|
[key: string]: string;
|
|
217
217
|
}, runtime: $dara.RuntimeOptions): Promise<$_model.GetDashboardResponse>;
|
|
218
218
|
/**
|
|
219
|
-
* Retrieves the
|
|
219
|
+
* Retrieves the dashboard URL of a DLC job, if available.
|
|
220
220
|
*
|
|
221
221
|
* @remarks
|
|
222
|
-
* Before using this
|
|
222
|
+
* Before using this operation, make sure that you fully understand the billing of PAI-DLC and its [pricing](https://help.aliyun.com/document_detail/171758.html).
|
|
223
223
|
*
|
|
224
224
|
* @param request - GetDashboardRequest
|
|
225
225
|
* @returns GetDashboardResponse
|
|
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
|
|
229
|
+
* Retrieves the detailed configuration and runtime information of a node.
|
|
230
230
|
*
|
|
231
231
|
* @param request - GetJobRequest
|
|
232
232
|
* @param headers - map
|
|
@@ -237,14 +237,14 @@ 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
|
|
240
|
+
* Retrieves the detailed configuration and runtime information of a node.
|
|
241
241
|
*
|
|
242
242
|
* @param request - GetJobRequest
|
|
243
243
|
* @returns GetJobResponse
|
|
244
244
|
*/
|
|
245
245
|
getJob(JobId: string, request: $_model.GetJobRequest): Promise<$_model.GetJobResponse>;
|
|
246
246
|
/**
|
|
247
|
-
*
|
|
247
|
+
* Retrieves system events for a job.
|
|
248
248
|
*
|
|
249
249
|
* @param request - GetJobEventsRequest
|
|
250
250
|
* @param headers - map
|
|
@@ -255,14 +255,15 @@ export default class Client extends OpenApi {
|
|
|
255
255
|
[key: string]: string;
|
|
256
256
|
}, runtime: $dara.RuntimeOptions): Promise<$_model.GetJobEventsResponse>;
|
|
257
257
|
/**
|
|
258
|
-
*
|
|
258
|
+
* Retrieves system events for a job.
|
|
259
259
|
*
|
|
260
260
|
* @param request - GetJobEventsRequest
|
|
261
261
|
* @returns GetJobEventsResponse
|
|
262
262
|
*/
|
|
263
263
|
getJobEvents(JobId: string, request: $_model.GetJobEventsRequest): Promise<$_model.GetJobEventsResponse>;
|
|
264
264
|
/**
|
|
265
|
-
*
|
|
265
|
+
* Retrieves monitoring data for a node, including CPU, GPU, and memory usage, as well as network and disk read/write rates.
|
|
266
|
+
* ⚠️ Note: All node types except pay-as-you-go (postpaid) nodes based on general computing resources are integrated with CloudMonitor. Use CloudMonitor API operations for monitoring calls. Features already covered by the new API operations will no longer undergo maintenance in the original API operations. For more information, see [Training Monitoring and Alerts](https://www.alibabacloud.com/help/zh/pai/user-guide/training-monitoring-and-alerting).
|
|
266
267
|
*
|
|
267
268
|
* @param request - GetJobMetricsRequest
|
|
268
269
|
* @param headers - map
|
|
@@ -273,14 +274,15 @@ export default class Client extends OpenApi {
|
|
|
273
274
|
[key: string]: string;
|
|
274
275
|
}, runtime: $dara.RuntimeOptions): Promise<$_model.GetJobMetricsResponse>;
|
|
275
276
|
/**
|
|
276
|
-
*
|
|
277
|
+
* Retrieves monitoring data for a node, including CPU, GPU, and memory usage, as well as network and disk read/write rates.
|
|
278
|
+
* ⚠️ Note: All node types except pay-as-you-go (postpaid) nodes based on general computing resources are integrated with CloudMonitor. Use CloudMonitor API operations for monitoring calls. Features already covered by the new API operations will no longer undergo maintenance in the original API operations. For more information, see [Training Monitoring and Alerts](https://www.alibabacloud.com/help/zh/pai/user-guide/training-monitoring-and-alerting).
|
|
277
279
|
*
|
|
278
280
|
* @param request - GetJobMetricsRequest
|
|
279
281
|
* @returns GetJobMetricsResponse
|
|
280
282
|
*/
|
|
281
283
|
getJobMetrics(JobId: string, request: $_model.GetJobMetricsRequest): Promise<$_model.GetJobMetricsResponse>;
|
|
282
284
|
/**
|
|
283
|
-
*
|
|
285
|
+
* Retrieves the computing power health check result for a specific run of a DLC job.
|
|
284
286
|
*
|
|
285
287
|
* @param request - GetJobSanityCheckResultRequest
|
|
286
288
|
* @param headers - map
|
|
@@ -291,14 +293,14 @@ export default class Client extends OpenApi {
|
|
|
291
293
|
[key: string]: string;
|
|
292
294
|
}, runtime: $dara.RuntimeOptions): Promise<$_model.GetJobSanityCheckResultResponse>;
|
|
293
295
|
/**
|
|
294
|
-
*
|
|
296
|
+
* Retrieves the computing power health check result for a specific run of a DLC job.
|
|
295
297
|
*
|
|
296
298
|
* @param request - GetJobSanityCheckResultRequest
|
|
297
299
|
* @returns GetJobSanityCheckResultResponse
|
|
298
300
|
*/
|
|
299
301
|
getJobSanityCheckResult(JobId: string, request: $_model.GetJobSanityCheckResultRequest): Promise<$_model.GetJobSanityCheckResultResponse>;
|
|
300
302
|
/**
|
|
301
|
-
* Retrieves the details of a
|
|
303
|
+
* Retrieves the details of a task template.
|
|
302
304
|
*
|
|
303
305
|
* @param request - GetJobTemplateRequest
|
|
304
306
|
* @param headers - map
|
|
@@ -309,23 +311,23 @@ export default class Client extends OpenApi {
|
|
|
309
311
|
[key: string]: string;
|
|
310
312
|
}, runtime: $dara.RuntimeOptions): Promise<$_model.GetJobTemplateResponse>;
|
|
311
313
|
/**
|
|
312
|
-
* Retrieves the details of a
|
|
314
|
+
* Retrieves the details of a task template.
|
|
313
315
|
*
|
|
314
316
|
* @param request - GetJobTemplateRequest
|
|
315
317
|
* @returns GetJobTemplateResponse
|
|
316
318
|
*/
|
|
317
319
|
getJobTemplate(TemplateId: string, request: $_model.GetJobTemplateRequest): Promise<$_model.GetJobTemplateResponse>;
|
|
318
320
|
/**
|
|
319
|
-
*
|
|
321
|
+
* Retrieves metrics data.
|
|
320
322
|
*
|
|
321
323
|
* @remarks
|
|
322
|
-
* ##
|
|
323
|
-
* - This
|
|
324
|
-
* -
|
|
325
|
-
* -
|
|
326
|
-
* - To
|
|
327
|
-
* -
|
|
328
|
-
* - For advanced features or specific
|
|
324
|
+
* ## Operation description
|
|
325
|
+
* - This operation queries monitoring metrics for a specific job (JobId) or dimension (Dimensions) under a specified namespace (Namespace).
|
|
326
|
+
* - Custom query time ranges are supported. By default, data from the last hour is returned.
|
|
327
|
+
* - You can select different time intervals (Period) to retrieve data points at a finer or coarser granularity.
|
|
328
|
+
* - To retrieve large amounts of data with paging, use the `NextToken` parameter for paging operations.
|
|
329
|
+
* - `MetricName` is required and specifies the name of the monitoring metric to query.
|
|
330
|
+
* - For advanced features or specific types of monitoring metrics, refer to the relevant documentation for more information.
|
|
329
331
|
*
|
|
330
332
|
* @param request - GetMetricsRequest
|
|
331
333
|
* @param headers - map
|
|
@@ -336,23 +338,23 @@ export default class Client extends OpenApi {
|
|
|
336
338
|
[key: string]: string;
|
|
337
339
|
}, runtime: $dara.RuntimeOptions): Promise<$_model.GetMetricsResponse>;
|
|
338
340
|
/**
|
|
339
|
-
*
|
|
341
|
+
* Retrieves metrics data.
|
|
340
342
|
*
|
|
341
343
|
* @remarks
|
|
342
|
-
* ##
|
|
343
|
-
* - This
|
|
344
|
-
* -
|
|
345
|
-
* -
|
|
346
|
-
* - To
|
|
347
|
-
* -
|
|
348
|
-
* - For advanced features or specific
|
|
344
|
+
* ## Operation description
|
|
345
|
+
* - This operation queries monitoring metrics for a specific job (JobId) or dimension (Dimensions) under a specified namespace (Namespace).
|
|
346
|
+
* - Custom query time ranges are supported. By default, data from the last hour is returned.
|
|
347
|
+
* - You can select different time intervals (Period) to retrieve data points at a finer or coarser granularity.
|
|
348
|
+
* - To retrieve large amounts of data with paging, use the `NextToken` parameter for paging operations.
|
|
349
|
+
* - `MetricName` is required and specifies the name of the monitoring metric to query.
|
|
350
|
+
* - For advanced features or specific types of monitoring metrics, refer to the relevant documentation for more information.
|
|
349
351
|
*
|
|
350
352
|
* @param request - GetMetricsRequest
|
|
351
353
|
* @returns GetMetricsResponse
|
|
352
354
|
*/
|
|
353
355
|
getMetrics(request: $_model.GetMetricsRequest): Promise<$_model.GetMetricsResponse>;
|
|
354
356
|
/**
|
|
355
|
-
*
|
|
357
|
+
* Retrieves system events for a specific node in a job to locate and troubleshoot issues.
|
|
356
358
|
*
|
|
357
359
|
* @param request - GetPodEventsRequest
|
|
358
360
|
* @param headers - map
|
|
@@ -363,7 +365,7 @@ export default class Client extends OpenApi {
|
|
|
363
365
|
[key: string]: string;
|
|
364
366
|
}, runtime: $dara.RuntimeOptions): Promise<$_model.GetPodEventsResponse>;
|
|
365
367
|
/**
|
|
366
|
-
*
|
|
368
|
+
* Retrieves system events for a specific node in a job to locate and troubleshoot issues.
|
|
367
369
|
*
|
|
368
370
|
* @param request - GetPodEventsRequest
|
|
369
371
|
* @returns GetPodEventsResponse
|
|
@@ -388,10 +390,10 @@ export default class Client extends OpenApi {
|
|
|
388
390
|
*/
|
|
389
391
|
getPodLogs(JobId: string, PodId: string, request: $_model.GetPodLogsRequest): Promise<$_model.GetPodLogsResponse>;
|
|
390
392
|
/**
|
|
391
|
-
*
|
|
393
|
+
* Retrieves the Ray Dashboard URL.
|
|
392
394
|
*
|
|
393
395
|
* @remarks
|
|
394
|
-
* Before you use this operation,
|
|
396
|
+
* Before you use this operation, make sure that you fully understand the billing of PAI-DLC and its [pricing](https://help.aliyun.com/document_detail/171758.html).
|
|
395
397
|
*
|
|
396
398
|
* @param request - GetRayDashboardRequest
|
|
397
399
|
* @param headers - map
|
|
@@ -402,20 +404,21 @@ export default class Client extends OpenApi {
|
|
|
402
404
|
[key: string]: string;
|
|
403
405
|
}, runtime: $dara.RuntimeOptions): Promise<$_model.GetRayDashboardResponse>;
|
|
404
406
|
/**
|
|
405
|
-
*
|
|
407
|
+
* Retrieves the Ray Dashboard URL.
|
|
406
408
|
*
|
|
407
409
|
* @remarks
|
|
408
|
-
* Before you use this operation,
|
|
410
|
+
* Before you use this operation, make sure that you fully understand the billing of PAI-DLC and its [pricing](https://help.aliyun.com/document_detail/171758.html).
|
|
409
411
|
*
|
|
410
412
|
* @param request - GetRayDashboardRequest
|
|
411
413
|
* @returns GetRayDashboardResponse
|
|
412
414
|
*/
|
|
413
415
|
getRayDashboard(jobId: string, request: $_model.GetRayDashboardRequest): Promise<$_model.GetRayDashboardResponse>;
|
|
414
416
|
/**
|
|
415
|
-
*
|
|
417
|
+
* Queries a RayHistoryServer.
|
|
416
418
|
*
|
|
417
419
|
* @remarks
|
|
418
|
-
* Before you
|
|
420
|
+
* Before you use this operation, make sure that you are familiar with the billing of PAI-DLC and have read the [pricing](https://help.aliyun.com/document_detail/171758.html).
|
|
421
|
+
* >Notice: The total length of the CreateJob operation parameters, including system-generated parameters, cannot exceed 65,536 bytes.
|
|
419
422
|
*
|
|
420
423
|
* @param request - GetRayHistoryServerRequest
|
|
421
424
|
* @param headers - map
|
|
@@ -426,10 +429,11 @@ export default class Client extends OpenApi {
|
|
|
426
429
|
[key: string]: string;
|
|
427
430
|
}, runtime: $dara.RuntimeOptions): Promise<$_model.GetRayHistoryServerResponse>;
|
|
428
431
|
/**
|
|
429
|
-
*
|
|
432
|
+
* Queries a RayHistoryServer.
|
|
430
433
|
*
|
|
431
434
|
* @remarks
|
|
432
|
-
* Before you
|
|
435
|
+
* Before you use this operation, make sure that you are familiar with the billing of PAI-DLC and have read the [pricing](https://help.aliyun.com/document_detail/171758.html).
|
|
436
|
+
* >Notice: The total length of the CreateJob operation parameters, including system-generated parameters, cannot exceed 65,536 bytes.
|
|
433
437
|
*
|
|
434
438
|
* @param request - GetRayHistoryServerRequest
|
|
435
439
|
* @returns GetRayHistoryServerResponse
|
|
@@ -440,7 +444,7 @@ export default class Client extends OpenApi {
|
|
|
440
444
|
*
|
|
441
445
|
* @remarks
|
|
442
446
|
* ## Operation description
|
|
443
|
-
*
|
|
447
|
+
* You can call this operation to retrieve the details of a signal that corresponds to a 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 result.
|
|
444
448
|
*
|
|
445
449
|
* @param request - GetSignalRequest
|
|
446
450
|
* @param headers - map
|
|
@@ -455,14 +459,14 @@ export default class Client extends OpenApi {
|
|
|
455
459
|
*
|
|
456
460
|
* @remarks
|
|
457
461
|
* ## Operation description
|
|
458
|
-
*
|
|
462
|
+
* You can call this operation to retrieve the details of a signal that corresponds to a 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 result.
|
|
459
463
|
*
|
|
460
464
|
* @param request - GetSignalRequest
|
|
461
465
|
* @returns GetSignalResponse
|
|
462
466
|
*/
|
|
463
467
|
getSignal(JobId: string, SignalId: string, request: $_model.GetSignalRequest): Promise<$_model.GetSignalResponse>;
|
|
464
468
|
/**
|
|
465
|
-
* Retrieves the details of a Tensorboard
|
|
469
|
+
* Retrieves the details of a Tensorboard.
|
|
466
470
|
*
|
|
467
471
|
* @param request - GetTensorboardRequest
|
|
468
472
|
* @param headers - map
|
|
@@ -473,14 +477,14 @@ export default class Client extends OpenApi {
|
|
|
473
477
|
[key: string]: string;
|
|
474
478
|
}, runtime: $dara.RuntimeOptions): Promise<$_model.GetTensorboardResponse>;
|
|
475
479
|
/**
|
|
476
|
-
* Retrieves the details of a Tensorboard
|
|
480
|
+
* Retrieves the details of a Tensorboard.
|
|
477
481
|
*
|
|
478
482
|
* @param request - GetTensorboardRequest
|
|
479
483
|
* @returns GetTensorboardResponse
|
|
480
484
|
*/
|
|
481
485
|
getTensorboard(TensorboardId: string, request: $_model.GetTensorboardRequest): Promise<$_model.GetTensorboardResponse>;
|
|
482
486
|
/**
|
|
483
|
-
*
|
|
487
|
+
* Retrieves the sharing link for a TensorBoard task. The link contains a digital token. You can use the sharing link to access the shared TensorBoard task.
|
|
484
488
|
*
|
|
485
489
|
* @param request - GetTensorboardSharedUrlRequest
|
|
486
490
|
* @param headers - map
|
|
@@ -491,7 +495,7 @@ export default class Client extends OpenApi {
|
|
|
491
495
|
[key: string]: string;
|
|
492
496
|
}, runtime: $dara.RuntimeOptions): Promise<$_model.GetTensorboardSharedUrlResponse>;
|
|
493
497
|
/**
|
|
494
|
-
*
|
|
498
|
+
* Retrieves the sharing link for a TensorBoard task. The link contains a digital token. You can use the sharing link to access the shared TensorBoard task.
|
|
495
499
|
*
|
|
496
500
|
* @param request - GetTensorboardSharedUrlRequest
|
|
497
501
|
* @returns GetTensorboardSharedUrlResponse
|
|
@@ -516,7 +520,7 @@ export default class Client extends OpenApi {
|
|
|
516
520
|
*/
|
|
517
521
|
getToken(request: $_model.GetTokenRequest): Promise<$_model.GetTokenResponse>;
|
|
518
522
|
/**
|
|
519
|
-
* Provides
|
|
523
|
+
* Provides the method and steps to obtain an HTTP link for accessing a container.
|
|
520
524
|
*
|
|
521
525
|
* @param request - GetWebTerminalRequest
|
|
522
526
|
* @param headers - map
|
|
@@ -527,14 +531,14 @@ export default class Client extends OpenApi {
|
|
|
527
531
|
[key: string]: string;
|
|
528
532
|
}, runtime: $dara.RuntimeOptions): Promise<$_model.GetWebTerminalResponse>;
|
|
529
533
|
/**
|
|
530
|
-
* Provides
|
|
534
|
+
* Provides the method and steps to obtain an HTTP link for accessing a container.
|
|
531
535
|
*
|
|
532
536
|
* @param request - GetWebTerminalRequest
|
|
533
537
|
* @returns GetWebTerminalResponse
|
|
534
538
|
*/
|
|
535
539
|
getWebTerminal(JobId: string, PodId: string, request: $_model.GetWebTerminalRequest): Promise<$_model.GetWebTerminalResponse>;
|
|
536
540
|
/**
|
|
537
|
-
* Queries the list of supported
|
|
541
|
+
* Queries the list of currently supported machine resource configurations.
|
|
538
542
|
*
|
|
539
543
|
* @param request - ListEcsSpecsRequest
|
|
540
544
|
* @param headers - map
|
|
@@ -545,14 +549,14 @@ export default class Client extends OpenApi {
|
|
|
545
549
|
[key: string]: string;
|
|
546
550
|
}, runtime: $dara.RuntimeOptions): Promise<$_model.ListEcsSpecsResponse>;
|
|
547
551
|
/**
|
|
548
|
-
* Queries the list of supported
|
|
552
|
+
* Queries the list of currently supported machine resource configurations.
|
|
549
553
|
*
|
|
550
554
|
* @param request - ListEcsSpecsRequest
|
|
551
555
|
* @returns ListEcsSpecsResponse
|
|
552
556
|
*/
|
|
553
557
|
listEcsSpecs(request: $_model.ListEcsSpecsRequest): Promise<$_model.ListEcsSpecsResponse>;
|
|
554
558
|
/**
|
|
555
|
-
*
|
|
559
|
+
* Retrieves all computing power health check results for a specific DLC job.
|
|
556
560
|
*
|
|
557
561
|
* @param request - ListJobSanityCheckResultsRequest
|
|
558
562
|
* @param headers - map
|
|
@@ -563,14 +567,14 @@ export default class Client extends OpenApi {
|
|
|
563
567
|
[key: string]: string;
|
|
564
568
|
}, runtime: $dara.RuntimeOptions): Promise<$_model.ListJobSanityCheckResultsResponse>;
|
|
565
569
|
/**
|
|
566
|
-
*
|
|
570
|
+
* Retrieves all computing power health check results for a specific DLC job.
|
|
567
571
|
*
|
|
568
572
|
* @param request - ListJobSanityCheckResultsRequest
|
|
569
573
|
* @returns ListJobSanityCheckResultsResponse
|
|
570
574
|
*/
|
|
571
575
|
listJobSanityCheckResults(JobId: string, request: $_model.ListJobSanityCheckResultsRequest): Promise<$_model.ListJobSanityCheckResultsResponse>;
|
|
572
576
|
/**
|
|
573
|
-
* Lists
|
|
577
|
+
* Lists task templates by workspace with support for pagination and sorting. You can filter results by creator, TemplateId, or TemplateName.
|
|
574
578
|
*
|
|
575
579
|
* @param request - ListJobTemplatesRequest
|
|
576
580
|
* @param headers - map
|
|
@@ -581,7 +585,7 @@ export default class Client extends OpenApi {
|
|
|
581
585
|
[key: string]: string;
|
|
582
586
|
}, runtime: $dara.RuntimeOptions): Promise<$_model.ListJobTemplatesResponse>;
|
|
583
587
|
/**
|
|
584
|
-
* Lists
|
|
588
|
+
* Lists task templates by workspace with support for pagination and sorting. You can filter results by creator, TemplateId, or TemplateName.
|
|
585
589
|
*
|
|
586
590
|
* @param request - ListJobTemplatesRequest
|
|
587
591
|
* @returns ListJobTemplatesResponse
|
|
@@ -609,8 +613,8 @@ export default class Client extends OpenApi {
|
|
|
609
613
|
* Lists RayHistoryServer resources.
|
|
610
614
|
*
|
|
611
615
|
* @remarks
|
|
612
|
-
* Before
|
|
613
|
-
* >Notice: The total length of the CreateJob operation
|
|
616
|
+
* Before using this operation, make sure you understand the billing methods and [pricing](https://help.aliyun.com/document_detail/171758.html) of PAI-DLC.
|
|
617
|
+
* >Notice: The total length of parameters for the CreateJob operation (including system-generated parameters) cannot exceed 65536 bytes.
|
|
614
618
|
*
|
|
615
619
|
* @param request - ListRayHistoryServersRequest
|
|
616
620
|
* @param headers - map
|
|
@@ -624,8 +628,8 @@ export default class Client extends OpenApi {
|
|
|
624
628
|
* Lists RayHistoryServer resources.
|
|
625
629
|
*
|
|
626
630
|
* @remarks
|
|
627
|
-
* Before
|
|
628
|
-
* >Notice: The total length of the CreateJob operation
|
|
631
|
+
* Before using this operation, make sure you understand the billing methods and [pricing](https://help.aliyun.com/document_detail/171758.html) of PAI-DLC.
|
|
632
|
+
* >Notice: The total length of parameters for the CreateJob operation (including system-generated parameters) cannot exceed 65536 bytes.
|
|
629
633
|
*
|
|
630
634
|
* @param request - ListRayHistoryServersRequest
|
|
631
635
|
* @returns ListRayHistoryServersResponse
|
|
@@ -636,7 +640,7 @@ export default class Client extends OpenApi {
|
|
|
636
640
|
*
|
|
637
641
|
* @remarks
|
|
638
642
|
* ## Operation description
|
|
639
|
-
* You can call this
|
|
643
|
+
* You can call this operation to retrieve the details of all signal records for a specific job, including the signal ID, status, and creation time. You can use query parameters to further filter or sort the results.
|
|
640
644
|
*
|
|
641
645
|
* @param request - ListSignalsRequest
|
|
642
646
|
* @param headers - map
|
|
@@ -651,7 +655,7 @@ export default class Client extends OpenApi {
|
|
|
651
655
|
*
|
|
652
656
|
* @remarks
|
|
653
657
|
* ## Operation description
|
|
654
|
-
* You can call this
|
|
658
|
+
* You can call this operation to retrieve the details of all signal records for a specific job, including the signal ID, status, and creation time. You can use query parameters to further filter or sort the results.
|
|
655
659
|
*
|
|
656
660
|
* @param request - ListSignalsRequest
|
|
657
661
|
* @returns ListSignalsResponse
|
|
@@ -697,7 +701,8 @@ export default class Client extends OpenApi {
|
|
|
697
701
|
* Starts a Ray History Server.
|
|
698
702
|
*
|
|
699
703
|
* @remarks
|
|
700
|
-
* Before
|
|
704
|
+
* Before using this operation, make sure that you fully understand the billing method and [pricing](https://help.aliyun.com/document_detail/171758.html) of PAI-DLC.
|
|
705
|
+
* >Notice: The total length of the CreateJob operation parameters, including system-generated parameters, cannot exceed 65,536 bytes.
|
|
701
706
|
*
|
|
702
707
|
* @param request - StartRayHistoryServerRequest
|
|
703
708
|
* @param headers - map
|
|
@@ -711,14 +716,15 @@ export default class Client extends OpenApi {
|
|
|
711
716
|
* Starts a Ray History Server.
|
|
712
717
|
*
|
|
713
718
|
* @remarks
|
|
714
|
-
* Before
|
|
719
|
+
* Before using this operation, make sure that you fully understand the billing method and [pricing](https://help.aliyun.com/document_detail/171758.html) of PAI-DLC.
|
|
720
|
+
* >Notice: The total length of the CreateJob operation parameters, including system-generated parameters, cannot exceed 65,536 bytes.
|
|
715
721
|
*
|
|
716
722
|
* @param request - StartRayHistoryServerRequest
|
|
717
723
|
* @returns StartRayHistoryServerResponse
|
|
718
724
|
*/
|
|
719
725
|
startRayHistoryServer(RayHistoryServerId: string, request: $_model.StartRayHistoryServerRequest): Promise<$_model.StartRayHistoryServerResponse>;
|
|
720
726
|
/**
|
|
721
|
-
* Starts a
|
|
727
|
+
* Starts a Tensorboard.
|
|
722
728
|
*
|
|
723
729
|
* @param request - StartTensorboardRequest
|
|
724
730
|
* @param headers - map
|
|
@@ -729,7 +735,7 @@ export default class Client extends OpenApi {
|
|
|
729
735
|
[key: string]: string;
|
|
730
736
|
}, runtime: $dara.RuntimeOptions): Promise<$_model.StartTensorboardResponse>;
|
|
731
737
|
/**
|
|
732
|
-
* Starts a
|
|
738
|
+
* Starts a Tensorboard.
|
|
733
739
|
*
|
|
734
740
|
* @param request - StartTensorboardRequest
|
|
735
741
|
* @returns StartTensorboardResponse
|
|
@@ -775,7 +781,7 @@ export default class Client extends OpenApi {
|
|
|
775
781
|
*/
|
|
776
782
|
stopRayHistoryServer(RayHistoryServerId: string, request: $_model.StopRayHistoryServerRequest): Promise<$_model.StopRayHistoryServerResponse>;
|
|
777
783
|
/**
|
|
778
|
-
* Stops a TensorBoard
|
|
784
|
+
* Stops a TensorBoard.
|
|
779
785
|
*
|
|
780
786
|
* @param request - StopTensorboardRequest
|
|
781
787
|
* @param headers - map
|
|
@@ -786,7 +792,7 @@ export default class Client extends OpenApi {
|
|
|
786
792
|
[key: string]: string;
|
|
787
793
|
}, runtime: $dara.RuntimeOptions): Promise<$_model.StopTensorboardResponse>;
|
|
788
794
|
/**
|
|
789
|
-
* Stops a TensorBoard
|
|
795
|
+
* Stops a TensorBoard.
|
|
790
796
|
*
|
|
791
797
|
* @param request - StopTensorboardRequest
|
|
792
798
|
* @returns StopTensorboardResponse
|
|
@@ -853,7 +859,7 @@ export default class Client extends OpenApi {
|
|
|
853
859
|
*/
|
|
854
860
|
updateJob(JobId: string, request: $_model.UpdateJobRequest): Promise<$_model.UpdateJobResponse>;
|
|
855
861
|
/**
|
|
856
|
-
* Updates a
|
|
862
|
+
* Updates a task template.
|
|
857
863
|
*
|
|
858
864
|
* @param request - UpdateJobTemplateRequest
|
|
859
865
|
* @param headers - map
|
|
@@ -864,7 +870,7 @@ export default class Client extends OpenApi {
|
|
|
864
870
|
[key: string]: string;
|
|
865
871
|
}, runtime: $dara.RuntimeOptions): Promise<$_model.UpdateJobTemplateResponse>;
|
|
866
872
|
/**
|
|
867
|
-
* Updates a
|
|
873
|
+
* Updates a task template.
|
|
868
874
|
*
|
|
869
875
|
* @param request - UpdateJobTemplateRequest
|
|
870
876
|
* @returns UpdateJobTemplateResponse
|