@alicloud/pai-dlc20201203 1.9.0 → 1.10.0

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 (225) hide show
  1. package/dist/client.d.ts +190 -48
  2. package/dist/client.js +301 -48
  3. package/dist/client.js.map +1 -1
  4. package/dist/models/AutoscalingMetricSpec.d.ts +17 -0
  5. package/dist/models/AutoscalingMetricSpec.js +2 -0
  6. package/dist/models/AutoscalingMetricSpec.js.map +1 -1
  7. package/dist/models/CreateJobRequest.d.ts +60 -78
  8. package/dist/models/CreateJobRequest.js.map +1 -1
  9. package/dist/models/CreateJobResponseBody.d.ts +2 -2
  10. package/dist/models/CreateJobTemplateRequest.d.ts +9 -4
  11. package/dist/models/CreateJobTemplateRequest.js.map +1 -1
  12. package/dist/models/CreateJobTemplateResponseBody.d.ts +30 -2
  13. package/dist/models/CreateJobTemplateResponseBody.js.map +1 -1
  14. package/dist/models/CreateRayHistoryServerRequest.d.ts +22 -0
  15. package/dist/models/CreateRayHistoryServerRequest.js.map +1 -1
  16. package/dist/models/CreateRayHistoryServerResponseBody.d.ts +6 -0
  17. package/dist/models/CreateRayHistoryServerResponseBody.js.map +1 -1
  18. package/dist/models/CreateSignalRequest.d.ts +20 -0
  19. package/dist/models/CreateSignalRequest.js +64 -0
  20. package/dist/models/CreateSignalRequest.js.map +1 -0
  21. package/dist/models/CreateSignalResponse.d.ts +19 -0
  22. package/dist/models/CreateSignalResponse.js +69 -0
  23. package/dist/models/CreateSignalResponse.js.map +1 -0
  24. package/dist/models/CreateSignalResponseBody.d.ts +38 -0
  25. package/dist/models/CreateSignalResponseBody.js +66 -0
  26. package/dist/models/CreateSignalResponseBody.js.map +1 -0
  27. package/dist/models/CredentialConfig.d.ts +12 -0
  28. package/dist/models/CredentialConfig.js.map +1 -1
  29. package/dist/models/DataJuicerConfig.d.ts +18 -0
  30. package/dist/models/DataJuicerConfig.js.map +1 -1
  31. package/dist/models/DataSourceItem.d.ts +1 -1
  32. package/dist/models/DebuggerConfig.d.ts +1 -1
  33. package/dist/models/DeleteJobTemplateResponseBody.d.ts +4 -1
  34. package/dist/models/DeleteJobTemplateResponseBody.js.map +1 -1
  35. package/dist/models/DeleteRayHistoryServerResponseBody.d.ts +3 -0
  36. package/dist/models/DeleteRayHistoryServerResponseBody.js.map +1 -1
  37. package/dist/models/DownloadJobResult.d.ts +72 -0
  38. package/dist/models/DownloadJobResult.js.map +1 -1
  39. package/dist/models/ElasticSpotSpec.d.ts +37 -0
  40. package/dist/models/ElasticSpotSpec.js +64 -0
  41. package/dist/models/ElasticSpotSpec.js.map +1 -0
  42. package/dist/models/ExtraPodSpec.d.ts +10 -6
  43. package/dist/models/ExtraPodSpec.js.map +1 -1
  44. package/dist/models/GetDashboardRequest.d.ts +2 -7
  45. package/dist/models/GetDashboardRequest.js.map +1 -1
  46. package/dist/models/GetDashboardResponseBody.d.ts +1 -1
  47. package/dist/models/GetJobRequest.d.ts +1 -1
  48. package/dist/models/GetJobResponseBody.d.ts +189 -88
  49. package/dist/models/GetJobResponseBody.js.map +1 -1
  50. package/dist/models/GetJobTemplateRequest.d.ts +1 -1
  51. package/dist/models/GetJobTemplateResponseBody.d.ts +44 -5
  52. package/dist/models/GetJobTemplateResponseBody.js.map +1 -1
  53. package/dist/models/GetMetricsRequest.d.ts +30 -0
  54. package/dist/models/GetMetricsRequest.js.map +1 -1
  55. package/dist/models/GetMetricsResponseBody.d.ts +18 -0
  56. package/dist/models/GetMetricsResponseBody.js.map +1 -1
  57. package/dist/models/GetRayDashboardRequest.d.ts +2 -7
  58. package/dist/models/GetRayDashboardRequest.js.map +1 -1
  59. package/dist/models/GetRayDashboardResponseBody.d.ts +1 -1
  60. package/dist/models/GetRayHistoryServerResponseBody.d.ts +55 -1
  61. package/dist/models/GetRayHistoryServerResponseBody.js.map +1 -1
  62. package/dist/models/GetSignalRequest.d.ts +18 -0
  63. package/dist/models/GetSignalRequest.js +58 -0
  64. package/dist/models/GetSignalRequest.js.map +1 -0
  65. package/dist/models/GetSignalResponse.d.ts +19 -0
  66. package/dist/models/GetSignalResponse.js +69 -0
  67. package/dist/models/GetSignalResponse.js.map +1 -0
  68. package/dist/models/GetSignalResponseBody.d.ts +65 -0
  69. package/dist/models/GetSignalResponseBody.js +86 -0
  70. package/dist/models/GetSignalResponseBody.js.map +1 -0
  71. package/dist/models/GetTensorboardRequest.d.ts +3 -3
  72. package/dist/models/HyperNodeSchedulingConfig.d.ts +15 -0
  73. package/dist/models/HyperNodeSchedulingConfig.js +60 -0
  74. package/dist/models/HyperNodeSchedulingConfig.js.map +1 -0
  75. package/dist/models/ImageConfig.d.ts +4 -4
  76. package/dist/models/JobItem.d.ts +69 -72
  77. package/dist/models/JobItem.js +2 -0
  78. package/dist/models/JobItem.js.map +1 -1
  79. package/dist/models/JobReplicaStatus.d.ts +31 -0
  80. package/dist/models/JobReplicaStatus.js +2 -0
  81. package/dist/models/JobReplicaStatus.js.map +1 -1
  82. package/dist/models/JobSettings.d.ts +44 -36
  83. package/dist/models/JobSettings.js +4 -0
  84. package/dist/models/JobSettings.js.map +1 -1
  85. package/dist/models/JobSpec.d.ts +35 -21
  86. package/dist/models/JobSpec.js +14 -0
  87. package/dist/models/JobSpec.js.map +1 -1
  88. package/dist/models/JobTemplateVersionDetail.d.ts +4 -4
  89. package/dist/models/ListEcsSpecsRequest.d.ts +1 -1
  90. package/dist/models/ListJobTemplatesRequest.d.ts +16 -4
  91. package/dist/models/ListJobTemplatesRequest.js.map +1 -1
  92. package/dist/models/ListJobTemplatesResponseBody.d.ts +45 -1
  93. package/dist/models/ListJobTemplatesResponseBody.js.map +1 -1
  94. package/dist/models/ListJobsRequest.d.ts +138 -63
  95. package/dist/models/ListJobsRequest.js.map +1 -1
  96. package/dist/models/ListJobsResponseBody.d.ts +4 -4
  97. package/dist/models/ListJobsShrinkRequest.d.ts +138 -63
  98. package/dist/models/ListJobsShrinkRequest.js.map +1 -1
  99. package/dist/models/ListRayHistoryServersRequest.d.ts +75 -0
  100. package/dist/models/ListRayHistoryServersRequest.js +2 -0
  101. package/dist/models/ListRayHistoryServersRequest.js.map +1 -1
  102. package/dist/models/ListRayHistoryServersResponseBody.d.ts +71 -0
  103. package/dist/models/ListRayHistoryServersResponseBody.js.map +1 -1
  104. package/dist/models/ListSignalsRequest.d.ts +43 -0
  105. package/dist/models/ListSignalsRequest.js +68 -0
  106. package/dist/models/ListSignalsRequest.js.map +1 -0
  107. package/dist/models/ListSignalsResponse.d.ts +19 -0
  108. package/dist/models/ListSignalsResponse.js +69 -0
  109. package/dist/models/ListSignalsResponse.js.map +1 -0
  110. package/dist/models/ListSignalsResponseBody.d.ts +93 -0
  111. package/dist/models/ListSignalsResponseBody.js +114 -0
  112. package/dist/models/ListSignalsResponseBody.js.map +1 -0
  113. package/dist/models/ListTensorboardsRequest.d.ts +34 -44
  114. package/dist/models/ListTensorboardsRequest.js.map +1 -1
  115. package/dist/models/ListTensorboardsResponseBody.d.ts +2 -2
  116. package/dist/models/ResourceRequirements.d.ts +2 -2
  117. package/dist/models/SanityCheckResultItem.d.ts +6 -6
  118. package/dist/models/SeccompProfile.d.ts +6 -0
  119. package/dist/models/SeccompProfile.js.map +1 -1
  120. package/dist/models/SecurityContext.d.ts +18 -0
  121. package/dist/models/SecurityContext.js.map +1 -1
  122. package/dist/models/ServiceSpec.d.ts +10 -0
  123. package/dist/models/ServiceSpec.js.map +1 -1
  124. package/dist/models/SetJobTemplateDefaultVersionRequest.d.ts +1 -1
  125. package/dist/models/SetJobTemplateDefaultVersionResponseBody.d.ts +4 -2
  126. package/dist/models/SetJobTemplateDefaultVersionResponseBody.js.map +1 -1
  127. package/dist/models/SignalTarget.d.ts +16 -0
  128. package/dist/models/SignalTarget.js +68 -0
  129. package/dist/models/SignalTarget.js.map +1 -0
  130. package/dist/models/StartRayHistoryServerResponseBody.d.ts +1 -1
  131. package/dist/models/StatusTransitionItem.d.ts +20 -0
  132. package/dist/models/StatusTransitionItem.js.map +1 -1
  133. package/dist/models/StopRayHistoryServerResponseBody.d.ts +1 -1
  134. package/dist/models/Tensorboard.d.ts +25 -78
  135. package/dist/models/Tensorboard.js.map +1 -1
  136. package/dist/models/TensorboardDataSourceSpec.d.ts +1 -1
  137. package/dist/models/UpdateJobRequest.d.ts +11 -7
  138. package/dist/models/UpdateJobRequest.js.map +1 -1
  139. package/dist/models/UpdateJobResponseBody.d.ts +2 -2
  140. package/dist/models/UpdateJobTemplateRequest.d.ts +17 -4
  141. package/dist/models/UpdateJobTemplateRequest.js.map +1 -1
  142. package/dist/models/UpdateJobTemplateResponseBody.d.ts +12 -1
  143. package/dist/models/UpdateJobTemplateResponseBody.js.map +1 -1
  144. package/dist/models/UpdateTensorboardRequest.d.ts +6 -5
  145. package/dist/models/UpdateTensorboardRequest.js.map +1 -1
  146. package/dist/models/UpdateTensorboardResponseBody.d.ts +2 -2
  147. package/dist/models/model.d.ts +13 -0
  148. package/dist/models/model.js +31 -5
  149. package/dist/models/model.js.map +1 -1
  150. package/package.json +2 -2
  151. package/src/client.ts +317 -48
  152. package/src/models/AutoscalingMetricSpec.ts +19 -0
  153. package/src/models/CreateJobRequest.ts +60 -78
  154. package/src/models/CreateJobResponseBody.ts +2 -2
  155. package/src/models/CreateJobTemplateRequest.ts +9 -4
  156. package/src/models/CreateJobTemplateResponseBody.ts +30 -2
  157. package/src/models/CreateRayHistoryServerRequest.ts +22 -0
  158. package/src/models/CreateRayHistoryServerResponseBody.ts +6 -0
  159. package/src/models/CreateSignalRequest.ts +38 -0
  160. package/src/models/CreateSignalResponse.ts +40 -0
  161. package/src/models/CreateSignalResponseBody.ts +59 -0
  162. package/src/models/CredentialConfig.ts +12 -0
  163. package/src/models/DataJuicerConfig.ts +18 -0
  164. package/src/models/DataSourceItem.ts +1 -1
  165. package/src/models/DebuggerConfig.ts +1 -1
  166. package/src/models/DeleteJobTemplateResponseBody.ts +4 -1
  167. package/src/models/DeleteRayHistoryServerResponseBody.ts +3 -0
  168. package/src/models/DownloadJobResult.ts +72 -0
  169. package/src/models/ElasticSpotSpec.ts +56 -0
  170. package/src/models/ExtraPodSpec.ts +10 -6
  171. package/src/models/GetDashboardRequest.ts +2 -7
  172. package/src/models/GetDashboardResponseBody.ts +1 -1
  173. package/src/models/GetJobRequest.ts +1 -1
  174. package/src/models/GetJobResponseBody.ts +189 -88
  175. package/src/models/GetJobTemplateRequest.ts +1 -1
  176. package/src/models/GetJobTemplateResponseBody.ts +44 -5
  177. package/src/models/GetMetricsRequest.ts +30 -0
  178. package/src/models/GetMetricsResponseBody.ts +18 -0
  179. package/src/models/GetRayDashboardRequest.ts +2 -7
  180. package/src/models/GetRayDashboardResponseBody.ts +1 -1
  181. package/src/models/GetRayHistoryServerResponseBody.ts +55 -1
  182. package/src/models/GetSignalRequest.ts +31 -0
  183. package/src/models/GetSignalResponse.ts +40 -0
  184. package/src/models/GetSignalResponseBody.ts +106 -0
  185. package/src/models/GetTensorboardRequest.ts +3 -3
  186. package/src/models/HyperNodeSchedulingConfig.ts +30 -0
  187. package/src/models/ImageConfig.ts +4 -4
  188. package/src/models/JobItem.ts +71 -72
  189. package/src/models/JobReplicaStatus.ts +33 -0
  190. package/src/models/JobSettings.ts +48 -36
  191. package/src/models/JobSpec.ts +47 -21
  192. package/src/models/JobTemplateVersionDetail.ts +4 -4
  193. package/src/models/ListEcsSpecsRequest.ts +1 -1
  194. package/src/models/ListJobTemplatesRequest.ts +16 -4
  195. package/src/models/ListJobTemplatesResponseBody.ts +45 -1
  196. package/src/models/ListJobsRequest.ts +138 -63
  197. package/src/models/ListJobsResponseBody.ts +4 -4
  198. package/src/models/ListJobsShrinkRequest.ts +138 -63
  199. package/src/models/ListRayHistoryServersRequest.ts +77 -0
  200. package/src/models/ListRayHistoryServersResponseBody.ts +71 -0
  201. package/src/models/ListSignalsRequest.ts +66 -0
  202. package/src/models/ListSignalsResponse.ts +40 -0
  203. package/src/models/ListSignalsResponseBody.ts +153 -0
  204. package/src/models/ListTensorboardsRequest.ts +34 -44
  205. package/src/models/ListTensorboardsResponseBody.ts +2 -2
  206. package/src/models/ResourceRequirements.ts +2 -2
  207. package/src/models/SanityCheckResultItem.ts +6 -6
  208. package/src/models/SeccompProfile.ts +6 -0
  209. package/src/models/SecurityContext.ts +18 -0
  210. package/src/models/ServiceSpec.ts +10 -0
  211. package/src/models/SetJobTemplateDefaultVersionRequest.ts +1 -1
  212. package/src/models/SetJobTemplateDefaultVersionResponseBody.ts +4 -2
  213. package/src/models/SignalTarget.ts +39 -0
  214. package/src/models/StartRayHistoryServerResponseBody.ts +1 -1
  215. package/src/models/StatusTransitionItem.ts +20 -0
  216. package/src/models/StopRayHistoryServerResponseBody.ts +1 -1
  217. package/src/models/Tensorboard.ts +25 -78
  218. package/src/models/TensorboardDataSourceSpec.ts +1 -1
  219. package/src/models/UpdateJobRequest.ts +11 -7
  220. package/src/models/UpdateJobResponseBody.ts +2 -2
  221. package/src/models/UpdateJobTemplateRequest.ts +17 -4
  222. package/src/models/UpdateJobTemplateResponseBody.ts +12 -1
  223. package/src/models/UpdateTensorboardRequest.ts +6 -5
  224. package/src/models/UpdateTensorboardResponseBody.ts +2 -2
  225. package/src/models/model.ts +13 -0
package/dist/client.d.ts CHANGED
@@ -9,10 +9,11 @@ export default class Client extends OpenApi {
9
9
  [key: string]: string;
10
10
  }, endpoint: string): string;
11
11
  /**
12
- * 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.
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.
13
13
  *
14
14
  * @remarks
15
- * 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).
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..
16
17
  *
17
18
  * @param request - CreateJobRequest
18
19
  * @param headers - map
@@ -23,17 +24,18 @@ export default class Client extends OpenApi {
23
24
  [key: string]: string;
24
25
  }, runtime: $dara.RuntimeOptions): Promise<$_model.CreateJobResponse>;
25
26
  /**
26
- * 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.
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
28
  *
28
29
  * @remarks
29
- * 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).
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
32
  *
31
33
  * @param request - CreateJobRequest
32
34
  * @returns CreateJobResponse
33
35
  */
34
36
  createJob(request: $_model.CreateJobRequest): Promise<$_model.CreateJobResponse>;
35
37
  /**
36
- * Create a job template.
38
+ * Creates a job template.
37
39
  *
38
40
  * @param request - CreateJobTemplateRequest
39
41
  * @param headers - map
@@ -44,14 +46,18 @@ export default class Client extends OpenApi {
44
46
  [key: string]: string;
45
47
  }, runtime: $dara.RuntimeOptions): Promise<$_model.CreateJobTemplateResponse>;
46
48
  /**
47
- * Create a job template.
49
+ * Creates a job template.
48
50
  *
49
51
  * @param request - CreateJobTemplateRequest
50
52
  * @returns CreateJobTemplateResponse
51
53
  */
52
54
  createJobTemplate(request: $_model.CreateJobTemplateRequest): Promise<$_model.CreateJobTemplateResponse>;
53
55
  /**
54
- * Create RayHistoryServer
56
+ * Creates a RayHistoryServer.
57
+ *
58
+ * @remarks
59
+ * Before you use this operation, make sure that you are familiar with the billing of PAI-DLC and the [pricing](https://help.aliyun.com/document_detail/171758.html).
60
+ * >Notice: The total length of CreateJob request parameters, including system-generated parameters, cannot exceed 65,536 bytes..
55
61
  *
56
62
  * @param request - CreateRayHistoryServerRequest
57
63
  * @param headers - map
@@ -62,12 +68,46 @@ export default class Client extends OpenApi {
62
68
  [key: string]: string;
63
69
  }, runtime: $dara.RuntimeOptions): Promise<$_model.CreateRayHistoryServerResponse>;
64
70
  /**
65
- * Create RayHistoryServer
71
+ * Creates a RayHistoryServer.
72
+ *
73
+ * @remarks
74
+ * Before you use this operation, make sure that you are familiar with the billing of PAI-DLC and the [pricing](https://help.aliyun.com/document_detail/171758.html).
75
+ * >Notice: The total length of CreateJob request parameters, including system-generated parameters, cannot exceed 65,536 bytes..
66
76
  *
67
77
  * @param request - CreateRayHistoryServerRequest
68
78
  * @returns CreateRayHistoryServerResponse
69
79
  */
70
80
  createRayHistoryServer(request: $_model.CreateRayHistoryServerRequest): Promise<$_model.CreateRayHistoryServerResponse>;
81
+ /**
82
+ * 创建信号
83
+ *
84
+ * @remarks
85
+ * ## 请求说明
86
+ * - 该API用于向指定作业的一个或多个Pod发送特定信号。
87
+ * - 发送信号后,API立即返回一个`SignalId`,实际的信号投递由后台worker处理。
88
+ * - 信号的状态可以通过`GetSignal`或`ListSignals`接口查询。
89
+ *
90
+ * @param request - CreateSignalRequest
91
+ * @param headers - map
92
+ * @param runtime - runtime options for this request RuntimeOptions
93
+ * @returns CreateSignalResponse
94
+ */
95
+ createSignalWithOptions(JobId: string, request: $_model.CreateSignalRequest, headers: {
96
+ [key: string]: string;
97
+ }, runtime: $dara.RuntimeOptions): Promise<$_model.CreateSignalResponse>;
98
+ /**
99
+ * 创建信号
100
+ *
101
+ * @remarks
102
+ * ## 请求说明
103
+ * - 该API用于向指定作业的一个或多个Pod发送特定信号。
104
+ * - 发送信号后,API立即返回一个`SignalId`,实际的信号投递由后台worker处理。
105
+ * - 信号的状态可以通过`GetSignal`或`ListSignals`接口查询。
106
+ *
107
+ * @param request - CreateSignalRequest
108
+ * @returns CreateSignalResponse
109
+ */
110
+ createSignal(JobId: string, request: $_model.CreateSignalRequest): Promise<$_model.CreateSignalResponse>;
71
111
  /**
72
112
  * Creates a TensorBoard by using a job or specifying a data source configuration.
73
113
  *
@@ -102,7 +142,7 @@ export default class Client extends OpenApi {
102
142
  */
103
143
  deleteJob(JobId: string): Promise<$_model.DeleteJobResponse>;
104
144
  /**
105
- * Deletes an unused job template. Templates that are used by jobs cannot be deleted.
145
+ * Deletes a job template. You cannot delete a job template that is in use by a job.
106
146
  *
107
147
  * @param request - DeleteJobTemplateRequest
108
148
  * @param headers - map
@@ -113,14 +153,17 @@ export default class Client extends OpenApi {
113
153
  [key: string]: string;
114
154
  }, runtime: $dara.RuntimeOptions): Promise<$_model.DeleteJobTemplateResponse>;
115
155
  /**
116
- * Deletes an unused job template. Templates that are used by jobs cannot be deleted.
156
+ * Deletes a job template. You cannot delete a job template that is in use by a job.
117
157
  *
118
158
  * @param request - DeleteJobTemplateRequest
119
159
  * @returns DeleteJobTemplateResponse
120
160
  */
121
161
  deleteJobTemplate(TemplateId: string, request: $_model.DeleteJobTemplateRequest): Promise<$_model.DeleteJobTemplateResponse>;
122
162
  /**
123
- * Delete RayHistoryServer
163
+ * Deletes a Ray History Server.
164
+ *
165
+ * @remarks
166
+ * Before calling this API, ensure you understand the billing methods and [Pricing](https://help.aliyun.com/document_detail/171758.html) of PAI-DLC.
124
167
  *
125
168
  * @param request - DeleteRayHistoryServerRequest
126
169
  * @param headers - map
@@ -131,7 +174,10 @@ export default class Client extends OpenApi {
131
174
  [key: string]: string;
132
175
  }, runtime: $dara.RuntimeOptions): Promise<$_model.DeleteRayHistoryServerResponse>;
133
176
  /**
134
- * Delete RayHistoryServer
177
+ * Deletes a Ray History Server.
178
+ *
179
+ * @remarks
180
+ * Before calling this API, ensure you understand the billing methods and [Pricing](https://help.aliyun.com/document_detail/171758.html) of PAI-DLC.
135
181
  *
136
182
  * @param request - DeleteRayHistoryServerRequest
137
183
  * @returns DeleteRayHistoryServerResponse
@@ -156,10 +202,10 @@ export default class Client extends OpenApi {
156
202
  */
157
203
  deleteTensorboard(TensorboardId: string, request: $_model.DeleteTensorboardRequest): Promise<$_model.DeleteTensorboardResponse>;
158
204
  /**
159
- * Gets the DLC task\\"s Dashboard URL, if one exists.
205
+ * Retrieves the Dashboard URL for a DLC job, if available.
160
206
  *
161
207
  * @remarks
162
- * 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).
208
+ * Before using this API, review the billing methods and [pricing](https://help.aliyun.com/document_detail/171758.html) for PAI-DLC.
163
209
  *
164
210
  * @param request - GetDashboardRequest
165
211
  * @param headers - map
@@ -170,17 +216,17 @@ export default class Client extends OpenApi {
170
216
  [key: string]: string;
171
217
  }, runtime: $dara.RuntimeOptions): Promise<$_model.GetDashboardResponse>;
172
218
  /**
173
- * Gets the DLC task\\"s Dashboard URL, if one exists.
219
+ * Retrieves the Dashboard URL for a DLC job, if available.
174
220
  *
175
221
  * @remarks
176
- * 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).
222
+ * Before using this API, review the billing methods and [pricing](https://help.aliyun.com/document_detail/171758.html) for PAI-DLC.
177
223
  *
178
224
  * @param request - GetDashboardRequest
179
225
  * @returns GetDashboardResponse
180
226
  */
181
227
  getDashboard(jobId: string, request: $_model.GetDashboardRequest): Promise<$_model.GetDashboardResponse>;
182
228
  /**
183
- * Obtains the configuration and runtime information of a job.
229
+ * Retrieves the detailed configuration and runtime information of a DLC job.
184
230
  *
185
231
  * @param request - GetJobRequest
186
232
  * @param headers - map
@@ -191,7 +237,7 @@ export default class Client extends OpenApi {
191
237
  [key: string]: string;
192
238
  }, runtime: $dara.RuntimeOptions): Promise<$_model.GetJobResponse>;
193
239
  /**
194
- * Obtains the configuration and runtime information of a job.
240
+ * Retrieves the detailed configuration and runtime information of a DLC job.
195
241
  *
196
242
  * @param request - GetJobRequest
197
243
  * @returns GetJobResponse
@@ -252,7 +298,7 @@ export default class Client extends OpenApi {
252
298
  */
253
299
  getJobSanityCheckResult(JobId: string, request: $_model.GetJobSanityCheckResultRequest): Promise<$_model.GetJobSanityCheckResultResponse>;
254
300
  /**
255
- * Obtains the details of a job template.
301
+ * Retrieves the details of a job template.
256
302
  *
257
303
  * @param request - GetJobTemplateRequest
258
304
  * @param headers - map
@@ -263,14 +309,23 @@ export default class Client extends OpenApi {
263
309
  [key: string]: string;
264
310
  }, runtime: $dara.RuntimeOptions): Promise<$_model.GetJobTemplateResponse>;
265
311
  /**
266
- * Obtains the details of a job template.
312
+ * Retrieves the details of a job template.
267
313
  *
268
314
  * @param request - GetJobTemplateRequest
269
315
  * @returns GetJobTemplateResponse
270
316
  */
271
317
  getJobTemplate(TemplateId: string, request: $_model.GetJobTemplateRequest): Promise<$_model.GetJobTemplateResponse>;
272
318
  /**
273
- * 获取metrics数据
319
+ * Retrieve metrics data.
320
+ *
321
+ * @remarks
322
+ * ## Request description
323
+ * - This API retrieves monitoring metrics for a specific job (JobId) or dimensions under a given namespace.
324
+ * - It supports custom time ranges. By default, it returns data from the last hour.
325
+ * - Select different time intervals (Period) to obtain data points with finer or coarser granularity.
326
+ * - To paginate through large datasets, use the `NextToken` parameter.
327
+ * - The `MetricName` parameter is required and specifies the monitoring metric to query.
328
+ * - For advanced features or specific metric types, see the related documentation.
274
329
  *
275
330
  * @param request - GetMetricsRequest
276
331
  * @param headers - map
@@ -281,7 +336,16 @@ export default class Client extends OpenApi {
281
336
  [key: string]: string;
282
337
  }, runtime: $dara.RuntimeOptions): Promise<$_model.GetMetricsResponse>;
283
338
  /**
284
- * 获取metrics数据
339
+ * Retrieve metrics data.
340
+ *
341
+ * @remarks
342
+ * ## Request description
343
+ * - This API retrieves monitoring metrics for a specific job (JobId) or dimensions under a given namespace.
344
+ * - It supports custom time ranges. By default, it returns data from the last hour.
345
+ * - Select different time intervals (Period) to obtain data points with finer or coarser granularity.
346
+ * - To paginate through large datasets, use the `NextToken` parameter.
347
+ * - The `MetricName` parameter is required and specifies the monitoring metric to query.
348
+ * - For advanced features or specific metric types, see the related documentation.
285
349
  *
286
350
  * @param request - GetMetricsRequest
287
351
  * @returns GetMetricsResponse
@@ -324,10 +388,10 @@ export default class Client extends OpenApi {
324
388
  */
325
389
  getPodLogs(JobId: string, PodId: string, request: $_model.GetPodLogsRequest): Promise<$_model.GetPodLogsResponse>;
326
390
  /**
327
- * Obtains a Ray Dashboard URL.
391
+ * Retrieve the Ray Dashboard URL.
328
392
  *
329
393
  * @remarks
330
- * 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).
394
+ * Before you use this operation, review the PAI-DLC billing model and [pricing](https://help.aliyun.com/document_detail/171758.html).
331
395
  *
332
396
  * @param request - GetRayDashboardRequest
333
397
  * @param headers - map
@@ -338,17 +402,20 @@ export default class Client extends OpenApi {
338
402
  [key: string]: string;
339
403
  }, runtime: $dara.RuntimeOptions): Promise<$_model.GetRayDashboardResponse>;
340
404
  /**
341
- * Obtains a Ray Dashboard URL.
405
+ * Retrieve the Ray Dashboard URL.
342
406
  *
343
407
  * @remarks
344
- * 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).
408
+ * Before you use this operation, review the PAI-DLC billing model and [pricing](https://help.aliyun.com/document_detail/171758.html).
345
409
  *
346
410
  * @param request - GetRayDashboardRequest
347
411
  * @returns GetRayDashboardResponse
348
412
  */
349
413
  getRayDashboard(jobId: string, request: $_model.GetRayDashboardRequest): Promise<$_model.GetRayDashboardResponse>;
350
414
  /**
351
- * Query RayHistoryServer
415
+ * Retrieves the details of a specific RayHistoryServer.
416
+ *
417
+ * @remarks
418
+ * Before you call this API operation, make sure that you understand the billing methods and [pricing](https://help.aliyun.com/document_detail/171758.html) of PAI-DLC.>Notice: The total length of the parameters for the CreateJob API, including system-generated parameters, cannot exceed 65,536 bytes.
352
419
  *
353
420
  * @param request - GetRayHistoryServerRequest
354
421
  * @param headers - map
@@ -359,14 +426,43 @@ export default class Client extends OpenApi {
359
426
  [key: string]: string;
360
427
  }, runtime: $dara.RuntimeOptions): Promise<$_model.GetRayHistoryServerResponse>;
361
428
  /**
362
- * Query RayHistoryServer
429
+ * Retrieves the details of a specific RayHistoryServer.
430
+ *
431
+ * @remarks
432
+ * Before you call this API operation, make sure that you understand the billing methods and [pricing](https://help.aliyun.com/document_detail/171758.html) of PAI-DLC.>Notice: The total length of the parameters for the CreateJob API, including system-generated parameters, cannot exceed 65,536 bytes.
363
433
  *
364
434
  * @param request - GetRayHistoryServerRequest
365
435
  * @returns GetRayHistoryServerResponse
366
436
  */
367
437
  getRayHistoryServer(RayHistoryServerId: string, request: $_model.GetRayHistoryServerRequest): Promise<$_model.GetRayHistoryServerResponse>;
368
438
  /**
369
- * Queries the information of a TensorBoard instance.
439
+ * 获取信号
440
+ *
441
+ * @remarks
442
+ * ## 请求说明
443
+ * 通过此 API,用户可以获取到指定 `JobId` 和 `SignalId` 对应的信号详情,包括信号的状态、发送范围等信息。请注意,返回的结果中不再包含每个 Pod 的原始结果结构,而是通过 `Status`, `Reason`, 和 `Message` 字段来表达信号处理的整体情况。
444
+ *
445
+ * @param request - GetSignalRequest
446
+ * @param headers - map
447
+ * @param runtime - runtime options for this request RuntimeOptions
448
+ * @returns GetSignalResponse
449
+ */
450
+ getSignalWithOptions(JobId: string, SignalId: string, request: $_model.GetSignalRequest, headers: {
451
+ [key: string]: string;
452
+ }, runtime: $dara.RuntimeOptions): Promise<$_model.GetSignalResponse>;
453
+ /**
454
+ * 获取信号
455
+ *
456
+ * @remarks
457
+ * ## 请求说明
458
+ * 通过此 API,用户可以获取到指定 `JobId` 和 `SignalId` 对应的信号详情,包括信号的状态、发送范围等信息。请注意,返回的结果中不再包含每个 Pod 的原始结果结构,而是通过 `Status`, `Reason`, 和 `Message` 字段来表达信号处理的整体情况。
459
+ *
460
+ * @param request - GetSignalRequest
461
+ * @returns GetSignalResponse
462
+ */
463
+ getSignal(JobId: string, SignalId: string, request: $_model.GetSignalRequest): Promise<$_model.GetSignalResponse>;
464
+ /**
465
+ * Retrieves the details of a Tensorboard instance.
370
466
  *
371
467
  * @param request - GetTensorboardRequest
372
468
  * @param headers - map
@@ -377,7 +473,7 @@ export default class Client extends OpenApi {
377
473
  [key: string]: string;
378
474
  }, runtime: $dara.RuntimeOptions): Promise<$_model.GetTensorboardResponse>;
379
475
  /**
380
- * Queries the information of a TensorBoard instance.
476
+ * Retrieves the details of a Tensorboard instance.
381
477
  *
382
478
  * @param request - GetTensorboardRequest
383
479
  * @returns GetTensorboardResponse
@@ -474,7 +570,7 @@ export default class Client extends OpenApi {
474
570
  */
475
571
  listJobSanityCheckResults(JobId: string, request: $_model.ListJobSanityCheckResultsRequest): Promise<$_model.ListJobSanityCheckResultsResponse>;
476
572
  /**
477
- * List job templates by workspace. Support paging and sorting. Filter by creator, TemplateId, or TemplateName.
573
+ * Lists job templates in a specified workspace. You can paginate, sort, and filter the results by creator, `TemplateId`, or `TemplateName`.
478
574
  *
479
575
  * @param request - ListJobTemplatesRequest
480
576
  * @param headers - map
@@ -485,14 +581,14 @@ export default class Client extends OpenApi {
485
581
  [key: string]: string;
486
582
  }, runtime: $dara.RuntimeOptions): Promise<$_model.ListJobTemplatesResponse>;
487
583
  /**
488
- * List job templates by workspace. Support paging and sorting. Filter by creator, TemplateId, or TemplateName.
584
+ * Lists job templates in a specified workspace. You can paginate, sort, and filter the results by creator, `TemplateId`, or `TemplateName`.
489
585
  *
490
586
  * @param request - ListJobTemplatesRequest
491
587
  * @returns ListJobTemplatesResponse
492
588
  */
493
589
  listJobTemplates(request: $_model.ListJobTemplatesRequest): Promise<$_model.ListJobTemplatesResponse>;
494
590
  /**
495
- * Queries a list of jobs and supports pagination, sorting, and filtering by conditions.
591
+ * Retrieves a list of jobs with support for pagination, sorting, and conditional filtering.
496
592
  *
497
593
  * @param tmpReq - ListJobsRequest
498
594
  * @param headers - map
@@ -503,14 +599,18 @@ export default class Client extends OpenApi {
503
599
  [key: string]: string;
504
600
  }, runtime: $dara.RuntimeOptions): Promise<$_model.ListJobsResponse>;
505
601
  /**
506
- * Queries a list of jobs and supports pagination, sorting, and filtering by conditions.
602
+ * Retrieves a list of jobs with support for pagination, sorting, and conditional filtering.
507
603
  *
508
604
  * @param request - ListJobsRequest
509
605
  * @returns ListJobsResponse
510
606
  */
511
607
  listJobs(request: $_model.ListJobsRequest): Promise<$_model.ListJobsResponse>;
512
608
  /**
513
- * List resource RayHistoryServer
609
+ * Lists RayHistoryServer resources.
610
+ *
611
+ * @remarks
612
+ * Before you use this operation, make sure that you are familiar with the billing and [pricing](https://help.aliyun.com/document_detail/171758.html) of Platform for AI - Deep Learning Containers (PAI-DLC).
613
+ * >Notice: The total length of the CreateJob operation parameters, including system-generated parameters, cannot exceed 65,536 bytes..
514
614
  *
515
615
  * @param request - ListRayHistoryServersRequest
516
616
  * @param headers - map
@@ -521,14 +621,44 @@ export default class Client extends OpenApi {
521
621
  [key: string]: string;
522
622
  }, runtime: $dara.RuntimeOptions): Promise<$_model.ListRayHistoryServersResponse>;
523
623
  /**
524
- * List resource RayHistoryServer
624
+ * Lists RayHistoryServer resources.
625
+ *
626
+ * @remarks
627
+ * Before you use this operation, make sure that you are familiar with the billing and [pricing](https://help.aliyun.com/document_detail/171758.html) of Platform for AI - Deep Learning Containers (PAI-DLC).
628
+ * >Notice: The total length of the CreateJob operation parameters, including system-generated parameters, cannot exceed 65,536 bytes..
525
629
  *
526
630
  * @param request - ListRayHistoryServersRequest
527
631
  * @returns ListRayHistoryServersResponse
528
632
  */
529
633
  listRayHistoryServers(request: $_model.ListRayHistoryServersRequest): Promise<$_model.ListRayHistoryServersResponse>;
530
634
  /**
531
- * Queries a list of TensorBoard instances.
635
+ * 获取信号列表
636
+ *
637
+ * @remarks
638
+ * ## 请求说明
639
+ * 通过此 API 可以获取特定作业下的所有信号记录详情,包括信号 ID、状态、创建时间等信息。支持通过查询参数进一步筛选或排序结果。
640
+ *
641
+ * @param request - ListSignalsRequest
642
+ * @param headers - map
643
+ * @param runtime - runtime options for this request RuntimeOptions
644
+ * @returns ListSignalsResponse
645
+ */
646
+ listSignalsWithOptions(JobId: string, request: $_model.ListSignalsRequest, headers: {
647
+ [key: string]: string;
648
+ }, runtime: $dara.RuntimeOptions): Promise<$_model.ListSignalsResponse>;
649
+ /**
650
+ * 获取信号列表
651
+ *
652
+ * @remarks
653
+ * ## 请求说明
654
+ * 通过此 API 可以获取特定作业下的所有信号记录详情,包括信号 ID、状态、创建时间等信息。支持通过查询参数进一步筛选或排序结果。
655
+ *
656
+ * @param request - ListSignalsRequest
657
+ * @returns ListSignalsResponse
658
+ */
659
+ listSignals(JobId: string, request: $_model.ListSignalsRequest): Promise<$_model.ListSignalsResponse>;
660
+ /**
661
+ * Queries a list of created Tensorboard instances.
532
662
  *
533
663
  * @param request - ListTensorboardsRequest
534
664
  * @param headers - map
@@ -539,14 +669,14 @@ export default class Client extends OpenApi {
539
669
  [key: string]: string;
540
670
  }, runtime: $dara.RuntimeOptions): Promise<$_model.ListTensorboardsResponse>;
541
671
  /**
542
- * Queries a list of TensorBoard instances.
672
+ * Queries a list of created Tensorboard instances.
543
673
  *
544
674
  * @param request - ListTensorboardsRequest
545
675
  * @returns ListTensorboardsResponse
546
676
  */
547
677
  listTensorboards(request: $_model.ListTensorboardsRequest): Promise<$_model.ListTensorboardsResponse>;
548
678
  /**
549
- * Sets the default version of the template.
679
+ * Sets the default version of a job template.
550
680
  *
551
681
  * @param request - SetJobTemplateDefaultVersionRequest
552
682
  * @param headers - map
@@ -557,14 +687,17 @@ export default class Client extends OpenApi {
557
687
  [key: string]: string;
558
688
  }, runtime: $dara.RuntimeOptions): Promise<$_model.SetJobTemplateDefaultVersionResponse>;
559
689
  /**
560
- * Sets the default version of the template.
690
+ * Sets the default version of a job template.
561
691
  *
562
692
  * @param request - SetJobTemplateDefaultVersionRequest
563
693
  * @returns SetJobTemplateDefaultVersionResponse
564
694
  */
565
695
  setJobTemplateDefaultVersion(TemplateId: string, request: $_model.SetJobTemplateDefaultVersionRequest): Promise<$_model.SetJobTemplateDefaultVersionResponse>;
566
696
  /**
567
- * Start Ray History Server
697
+ * Starts a Ray History Server.
698
+ *
699
+ * @remarks
700
+ * Before calling this operation, familiarize yourself with the billing methods and [pricing](https://help.aliyun.com/document_detail/171758.html) of PAI-DLC.>Notice: The total length of the API parameters for the CreateJob operation, including system-generated parameters, cannot exceed 65,536 bytes.
568
701
  *
569
702
  * @param request - StartRayHistoryServerRequest
570
703
  * @param headers - map
@@ -575,7 +708,10 @@ export default class Client extends OpenApi {
575
708
  [key: string]: string;
576
709
  }, runtime: $dara.RuntimeOptions): Promise<$_model.StartRayHistoryServerResponse>;
577
710
  /**
578
- * Start Ray History Server
711
+ * Starts a Ray History Server.
712
+ *
713
+ * @remarks
714
+ * Before calling this operation, familiarize yourself with the billing methods and [pricing](https://help.aliyun.com/document_detail/171758.html) of PAI-DLC.>Notice: The total length of the API parameters for the CreateJob operation, including system-generated parameters, cannot exceed 65,536 bytes.
579
715
  *
580
716
  * @param request - StartRayHistoryServerRequest
581
717
  * @returns StartRayHistoryServerResponse
@@ -615,7 +751,10 @@ export default class Client extends OpenApi {
615
751
  */
616
752
  stopJob(JobId: string): Promise<$_model.StopJobResponse>;
617
753
  /**
618
- * Stop Ray History Server
754
+ * Stops a Ray History Server.
755
+ *
756
+ * @remarks
757
+ * Before calling this operation, ensure you understand the billing methods and [pricing](https://help.aliyun.com/document_detail/171758.html) for PAI-DLC.>Notice: The total length of the parameters for the CreateJob interface, including system-generated parameters, cannot exceed 65,536 bytes.
619
758
  *
620
759
  * @param request - StopRayHistoryServerRequest
621
760
  * @param headers - map
@@ -626,7 +765,10 @@ export default class Client extends OpenApi {
626
765
  [key: string]: string;
627
766
  }, runtime: $dara.RuntimeOptions): Promise<$_model.StopRayHistoryServerResponse>;
628
767
  /**
629
- * Stop Ray History Server
768
+ * Stops a Ray History Server.
769
+ *
770
+ * @remarks
771
+ * Before calling this operation, ensure you understand the billing methods and [pricing](https://help.aliyun.com/document_detail/171758.html) for PAI-DLC.>Notice: The total length of the parameters for the CreateJob interface, including system-generated parameters, cannot exceed 65,536 bytes.
630
772
  *
631
773
  * @param request - StopRayHistoryServerRequest
632
774
  * @returns StopRayHistoryServerResponse
@@ -651,7 +793,7 @@ export default class Client extends OpenApi {
651
793
  */
652
794
  stopTensorboard(TensorboardId: string, request: $_model.StopTensorboardRequest): Promise<$_model.StopTensorboardResponse>;
653
795
  /**
654
- * Updates the configuration information of a job. For example, you can modify the priority of a job in a queue.
796
+ * Updates a job\\"s configuration, such as its priority.
655
797
  *
656
798
  * @param request - UpdateJobRequest
657
799
  * @param headers - map
@@ -662,7 +804,7 @@ export default class Client extends OpenApi {
662
804
  [key: string]: string;
663
805
  }, runtime: $dara.RuntimeOptions): Promise<$_model.UpdateJobResponse>;
664
806
  /**
665
- * Updates the configuration information of a job. For example, you can modify the priority of a job in a queue.
807
+ * Updates a job\\"s configuration, such as its priority.
666
808
  *
667
809
  * @param request - UpdateJobRequest
668
810
  * @returns UpdateJobResponse
@@ -687,7 +829,7 @@ export default class Client extends OpenApi {
687
829
  */
688
830
  updateJobTemplate(TemplateId: string, request: $_model.UpdateJobTemplateRequest): Promise<$_model.UpdateJobTemplateResponse>;
689
831
  /**
690
- * Updates a TensorBoard instance.
832
+ * Update a Tensorboard.
691
833
  *
692
834
  * @param request - UpdateTensorboardRequest
693
835
  * @param headers - map
@@ -698,7 +840,7 @@ export default class Client extends OpenApi {
698
840
  [key: string]: string;
699
841
  }, runtime: $dara.RuntimeOptions): Promise<$_model.UpdateTensorboardResponse>;
700
842
  /**
701
- * Updates a TensorBoard instance.
843
+ * Update a Tensorboard.
702
844
  *
703
845
  * @param request - UpdateTensorboardRequest
704
846
  * @returns UpdateTensorboardResponse