@alicloud/pai-dlc20201203 1.8.0 → 1.9.1

package/dist/client.d.ts

@@ -9,10 +9,11 @@ export default class Client extends OpenApi {
         [key: string]: string;
     }, endpoint: string): string;
     /**
-     * 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.
+     * 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.
      *
      * @remarks
-     * 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).
+     * 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.
+     * >Notice: The total length of CreateJob request parameters, including system-generated parameters, cannot exceed 65,536 bytes..
      *
      * @param request - CreateJobRequest
      * @param headers - map
@@ -23,17 +24,18 @@ export default class Client extends OpenApi {
         [key: string]: string;
     }, runtime: $dara.RuntimeOptions): Promise<$_model.CreateJobResponse>;
     /**
-     * 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.
+     * 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.
      *
      * @remarks
-     * 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).
+     * 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.
+     * >Notice: The total length of CreateJob request parameters, including system-generated parameters, cannot exceed 65,536 bytes..
      *
      * @param request - CreateJobRequest
      * @returns CreateJobResponse
      */
     createJob(request: $_model.CreateJobRequest): Promise<$_model.CreateJobResponse>;
     /**
-     * Create a job template.
+     * Creates a job template.
      *
      * @param request - CreateJobTemplateRequest
      * @param headers - map
@@ -44,14 +46,18 @@ export default class Client extends OpenApi {
         [key: string]: string;
     }, runtime: $dara.RuntimeOptions): Promise<$_model.CreateJobTemplateResponse>;
     /**
-     * Create a job template.
+     * Creates a job template.
      *
      * @param request - CreateJobTemplateRequest
      * @returns CreateJobTemplateResponse
      */
     createJobTemplate(request: $_model.CreateJobTemplateRequest): Promise<$_model.CreateJobTemplateResponse>;
     /**
-     * 创建 RayHistoryServer
+     * Creates a RayHistoryServer.
+     *
+     * @remarks
+     * 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).
+     * >Notice: The total length of CreateJob request parameters, including system-generated parameters, cannot exceed 65,536 bytes..
      *
      * @param request - CreateRayHistoryServerRequest
      * @param headers - map
@@ -62,7 +68,11 @@ export default class Client extends OpenApi {
         [key: string]: string;
     }, runtime: $dara.RuntimeOptions): Promise<$_model.CreateRayHistoryServerResponse>;
     /**
-     * 创建 RayHistoryServer
+     * Creates a RayHistoryServer.
+     *
+     * @remarks
+     * 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).
+     * >Notice: The total length of CreateJob request parameters, including system-generated parameters, cannot exceed 65,536 bytes..
      *
      * @param request - CreateRayHistoryServerRequest
      * @returns CreateRayHistoryServerResponse
@@ -102,7 +112,7 @@ export default class Client extends OpenApi {
      */
     deleteJob(JobId: string): Promise<$_model.DeleteJobResponse>;
     /**
-     * Deletes an unused job template. Templates that are used by jobs cannot be deleted.
+     * Deletes a job template. You cannot delete a job template that is in use by a job.
      *
      * @param request - DeleteJobTemplateRequest
      * @param headers - map
@@ -113,14 +123,17 @@ export default class Client extends OpenApi {
         [key: string]: string;
     }, runtime: $dara.RuntimeOptions): Promise<$_model.DeleteJobTemplateResponse>;
     /**
-     * Deletes an unused job template. Templates that are used by jobs cannot be deleted.
+     * Deletes a job template. You cannot delete a job template that is in use by a job.
      *
      * @param request - DeleteJobTemplateRequest
      * @returns DeleteJobTemplateResponse
      */
     deleteJobTemplate(TemplateId: string, request: $_model.DeleteJobTemplateRequest): Promise<$_model.DeleteJobTemplateResponse>;
     /**
-     * 删除RayHistoryServer
+     * Deletes a Ray History Server.
+     *
+     * @remarks
+     * Before calling this API, ensure you understand the billing methods and [Pricing](https://help.aliyun.com/document_detail/171758.html) of PAI-DLC.
      *
      * @param request - DeleteRayHistoryServerRequest
      * @param headers - map
@@ -131,7 +144,10 @@ export default class Client extends OpenApi {
         [key: string]: string;
     }, runtime: $dara.RuntimeOptions): Promise<$_model.DeleteRayHistoryServerResponse>;
     /**
-     * 删除RayHistoryServer
+     * Deletes a Ray History Server.
+     *
+     * @remarks
+     * Before calling this API, ensure you understand the billing methods and [Pricing](https://help.aliyun.com/document_detail/171758.html) of PAI-DLC.
      *
      * @param request - DeleteRayHistoryServerRequest
      * @returns DeleteRayHistoryServerResponse
@@ -156,10 +172,10 @@ export default class Client extends OpenApi {
      */
     deleteTensorboard(TensorboardId: string, request: $_model.DeleteTensorboardRequest): Promise<$_model.DeleteTensorboardResponse>;
     /**
-     * Gets the DLC task\\"s Dashboard URL, if one exists.
+     * Retrieves the Dashboard URL for a DLC job, if available.
      *
      * @remarks
-     * 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).
+     * Before using this API, review the billing methods and [pricing](https://help.aliyun.com/document_detail/171758.html) for PAI-DLC.
      *
      * @param request - GetDashboardRequest
      * @param headers - map
@@ -170,17 +186,17 @@ export default class Client extends OpenApi {
         [key: string]: string;
     }, runtime: $dara.RuntimeOptions): Promise<$_model.GetDashboardResponse>;
     /**
-     * Gets the DLC task\\"s Dashboard URL, if one exists.
+     * Retrieves the Dashboard URL for a DLC job, if available.
      *
      * @remarks
-     * 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).
+     * Before using this API, review the billing methods and [pricing](https://help.aliyun.com/document_detail/171758.html) for PAI-DLC.
      *
      * @param request - GetDashboardRequest
      * @returns GetDashboardResponse
      */
     getDashboard(jobId: string, request: $_model.GetDashboardRequest): Promise<$_model.GetDashboardResponse>;
     /**
-     * Obtains the configuration and runtime information of a job.
+     * Retrieves the detailed configuration and runtime information of a DLC job.
      *
      * @param request - GetJobRequest
      * @param headers - map
@@ -191,7 +207,7 @@ export default class Client extends OpenApi {
         [key: string]: string;
     }, runtime: $dara.RuntimeOptions): Promise<$_model.GetJobResponse>;
     /**
-     * Obtains the configuration and runtime information of a job.
+     * Retrieves the detailed configuration and runtime information of a DLC job.
      *
      * @param request - GetJobRequest
      * @returns GetJobResponse
@@ -252,7 +268,7 @@ export default class Client extends OpenApi {
      */
     getJobSanityCheckResult(JobId: string, request: $_model.GetJobSanityCheckResultRequest): Promise<$_model.GetJobSanityCheckResultResponse>;
     /**
-     * Obtains the details of a job template.
+     * Retrieves the details of a job template.
      *
      * @param request - GetJobTemplateRequest
      * @param headers - map
@@ -263,12 +279,48 @@ export default class Client extends OpenApi {
         [key: string]: string;
     }, runtime: $dara.RuntimeOptions): Promise<$_model.GetJobTemplateResponse>;
     /**
-     * Obtains the details of a job template.
+     * Retrieves the details of a job template.
      *
      * @param request - GetJobTemplateRequest
      * @returns GetJobTemplateResponse
      */
     getJobTemplate(TemplateId: string, request: $_model.GetJobTemplateRequest): Promise<$_model.GetJobTemplateResponse>;
+    /**
+     * Retrieve metrics data.
+     *
+     * @remarks
+     * ## Request description
+     * - This API retrieves monitoring metrics for a specific job (JobId) or dimensions under a given namespace.
+     * - It supports custom time ranges. By default, it returns data from the last hour.
+     * - Select different time intervals (Period) to obtain data points with finer or coarser granularity.
+     * - To paginate through large datasets, use the `NextToken` parameter.
+     * - The `MetricName` parameter is required and specifies the monitoring metric to query.
+     * - For advanced features or specific metric types, see the related documentation.
+     *
+     * @param request - GetMetricsRequest
+     * @param headers - map
+     * @param runtime - runtime options for this request RuntimeOptions
+     * @returns GetMetricsResponse
+     */
+    getMetricsWithOptions(request: $_model.GetMetricsRequest, headers: {
+        [key: string]: string;
+    }, runtime: $dara.RuntimeOptions): Promise<$_model.GetMetricsResponse>;
+    /**
+     * Retrieve metrics data.
+     *
+     * @remarks
+     * ## Request description
+     * - This API retrieves monitoring metrics for a specific job (JobId) or dimensions under a given namespace.
+     * - It supports custom time ranges. By default, it returns data from the last hour.
+     * - Select different time intervals (Period) to obtain data points with finer or coarser granularity.
+     * - To paginate through large datasets, use the `NextToken` parameter.
+     * - The `MetricName` parameter is required and specifies the monitoring metric to query.
+     * - For advanced features or specific metric types, see the related documentation.
+     *
+     * @param request - GetMetricsRequest
+     * @returns GetMetricsResponse
+     */
+    getMetrics(request: $_model.GetMetricsRequest): Promise<$_model.GetMetricsResponse>;
     /**
      * Obtains the system events of a specific node in a job to locate and troubleshoot issues.
      *
@@ -306,10 +358,10 @@ export default class Client extends OpenApi {
      */
     getPodLogs(JobId: string, PodId: string, request: $_model.GetPodLogsRequest): Promise<$_model.GetPodLogsResponse>;
     /**
-     * Obtains a Ray Dashboard URL.
+     * Retrieve the Ray Dashboard URL.
      *
      * @remarks
-     * 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).
+     * Before you use this operation, review the PAI-DLC billing model and [pricing](https://help.aliyun.com/document_detail/171758.html).
      *
      * @param request - GetRayDashboardRequest
      * @param headers - map
@@ -320,17 +372,20 @@ export default class Client extends OpenApi {
         [key: string]: string;
     }, runtime: $dara.RuntimeOptions): Promise<$_model.GetRayDashboardResponse>;
     /**
-     * Obtains a Ray Dashboard URL.
+     * Retrieve the Ray Dashboard URL.
      *
      * @remarks
-     * 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).
+     * Before you use this operation, review the PAI-DLC billing model and [pricing](https://help.aliyun.com/document_detail/171758.html).
      *
      * @param request - GetRayDashboardRequest
      * @returns GetRayDashboardResponse
      */
     getRayDashboard(jobId: string, request: $_model.GetRayDashboardRequest): Promise<$_model.GetRayDashboardResponse>;
     /**
-     * 查询 RayHistoryServer
+     * Retrieves the details of a specific RayHistoryServer.
+     *
+     * @remarks
+     * 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.
      *
      * @param request - GetRayHistoryServerRequest
      * @param headers - map
@@ -341,14 +396,17 @@ export default class Client extends OpenApi {
         [key: string]: string;
     }, runtime: $dara.RuntimeOptions): Promise<$_model.GetRayHistoryServerResponse>;
     /**
-     * 查询 RayHistoryServer
+     * Retrieves the details of a specific RayHistoryServer.
+     *
+     * @remarks
+     * 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.
      *
      * @param request - GetRayHistoryServerRequest
      * @returns GetRayHistoryServerResponse
      */
     getRayHistoryServer(RayHistoryServerId: string, request: $_model.GetRayHistoryServerRequest): Promise<$_model.GetRayHistoryServerResponse>;
     /**
-     * Queries the information of a TensorBoard instance.
+     * Retrieves the details of a Tensorboard instance.
      *
      * @param request - GetTensorboardRequest
      * @param headers - map
@@ -359,7 +417,7 @@ export default class Client extends OpenApi {
         [key: string]: string;
     }, runtime: $dara.RuntimeOptions): Promise<$_model.GetTensorboardResponse>;
     /**
-     * Queries the information of a TensorBoard instance.
+     * Retrieves the details of a Tensorboard instance.
      *
      * @param request - GetTensorboardRequest
      * @returns GetTensorboardResponse
@@ -456,7 +514,7 @@ export default class Client extends OpenApi {
      */
     listJobSanityCheckResults(JobId: string, request: $_model.ListJobSanityCheckResultsRequest): Promise<$_model.ListJobSanityCheckResultsResponse>;
     /**
-     * List job templates by workspace. Support paging and sorting. Filter by creator, TemplateId, or TemplateName.
+     * Lists job templates in a specified workspace. You can paginate, sort, and filter the results by creator, `TemplateId`, or `TemplateName`.
      *
      * @param request - ListJobTemplatesRequest
      * @param headers - map
@@ -467,14 +525,14 @@ export default class Client extends OpenApi {
         [key: string]: string;
     }, runtime: $dara.RuntimeOptions): Promise<$_model.ListJobTemplatesResponse>;
     /**
-     * List job templates by workspace. Support paging and sorting. Filter by creator, TemplateId, or TemplateName.
+     * Lists job templates in a specified workspace. You can paginate, sort, and filter the results by creator, `TemplateId`, or `TemplateName`.
      *
      * @param request - ListJobTemplatesRequest
      * @returns ListJobTemplatesResponse
      */
     listJobTemplates(request: $_model.ListJobTemplatesRequest): Promise<$_model.ListJobTemplatesResponse>;
     /**
-     * Queries a list of jobs and supports pagination, sorting, and filtering by conditions.
+     * Retrieves a list of jobs with support for pagination, sorting, and conditional filtering.
      *
      * @param tmpReq - ListJobsRequest
      * @param headers - map
@@ -485,14 +543,18 @@ export default class Client extends OpenApi {
         [key: string]: string;
     }, runtime: $dara.RuntimeOptions): Promise<$_model.ListJobsResponse>;
     /**
-     * Queries a list of jobs and supports pagination, sorting, and filtering by conditions.
+     * Retrieves a list of jobs with support for pagination, sorting, and conditional filtering.
      *
      * @param request - ListJobsRequest
      * @returns ListJobsResponse
      */
     listJobs(request: $_model.ListJobsRequest): Promise<$_model.ListJobsResponse>;
     /**
-     * 列出资源RayHistoryServer
+     * Lists RayHistoryServer resources.
+     *
+     * @remarks
+     * 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).
+     * >Notice: The total length of the CreateJob operation parameters, including system-generated parameters, cannot exceed 65,536 bytes..
      *
      * @param request - ListRayHistoryServersRequest
      * @param headers - map
@@ -503,14 +565,18 @@ export default class Client extends OpenApi {
         [key: string]: string;
     }, runtime: $dara.RuntimeOptions): Promise<$_model.ListRayHistoryServersResponse>;
     /**
-     * 列出资源RayHistoryServer
+     * Lists RayHistoryServer resources.
+     *
+     * @remarks
+     * 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).
+     * >Notice: The total length of the CreateJob operation parameters, including system-generated parameters, cannot exceed 65,536 bytes..
      *
      * @param request - ListRayHistoryServersRequest
      * @returns ListRayHistoryServersResponse
      */
     listRayHistoryServers(request: $_model.ListRayHistoryServersRequest): Promise<$_model.ListRayHistoryServersResponse>;
     /**
-     * Queries a list of TensorBoard instances.
+     * Queries a list of created Tensorboard instances.
      *
      * @param request - ListTensorboardsRequest
      * @param headers - map
@@ -521,14 +587,14 @@ export default class Client extends OpenApi {
         [key: string]: string;
     }, runtime: $dara.RuntimeOptions): Promise<$_model.ListTensorboardsResponse>;
     /**
-     * Queries a list of TensorBoard instances.
+     * Queries a list of created Tensorboard instances.
      *
      * @param request - ListTensorboardsRequest
      * @returns ListTensorboardsResponse
      */
     listTensorboards(request: $_model.ListTensorboardsRequest): Promise<$_model.ListTensorboardsResponse>;
     /**
-     * Sets the default version of the template.
+     * Sets the default version of a job template.
      *
      * @param request - SetJobTemplateDefaultVersionRequest
      * @param headers - map
@@ -539,14 +605,17 @@ export default class Client extends OpenApi {
         [key: string]: string;
     }, runtime: $dara.RuntimeOptions): Promise<$_model.SetJobTemplateDefaultVersionResponse>;
     /**
-     * Sets the default version of the template.
+     * Sets the default version of a job template.
      *
      * @param request - SetJobTemplateDefaultVersionRequest
      * @returns SetJobTemplateDefaultVersionResponse
      */
     setJobTemplateDefaultVersion(TemplateId: string, request: $_model.SetJobTemplateDefaultVersionRequest): Promise<$_model.SetJobTemplateDefaultVersionResponse>;
     /**
-     * 启动 Ray History Server
+     * Starts a Ray History Server.
+     *
+     * @remarks
+     * 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.
      *
      * @param request - StartRayHistoryServerRequest
      * @param headers - map
@@ -557,7 +626,10 @@ export default class Client extends OpenApi {
         [key: string]: string;
     }, runtime: $dara.RuntimeOptions): Promise<$_model.StartRayHistoryServerResponse>;
     /**
-     * 启动 Ray History Server
+     * Starts a Ray History Server.
+     *
+     * @remarks
+     * 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.
      *
      * @param request - StartRayHistoryServerRequest
      * @returns StartRayHistoryServerResponse
@@ -597,7 +669,10 @@ export default class Client extends OpenApi {
      */
     stopJob(JobId: string): Promise<$_model.StopJobResponse>;
     /**
-     * 停止 Ray History Server
+     * Stops a Ray History Server.
+     *
+     * @remarks
+     * 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.
      *
      * @param request - StopRayHistoryServerRequest
      * @param headers - map
@@ -608,7 +683,10 @@ export default class Client extends OpenApi {
         [key: string]: string;
     }, runtime: $dara.RuntimeOptions): Promise<$_model.StopRayHistoryServerResponse>;
     /**
-     * 停止 Ray History Server
+     * Stops a Ray History Server.
+     *
+     * @remarks
+     * 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.
      *
      * @param request - StopRayHistoryServerRequest
      * @returns StopRayHistoryServerResponse
@@ -633,7 +711,7 @@ export default class Client extends OpenApi {
      */
     stopTensorboard(TensorboardId: string, request: $_model.StopTensorboardRequest): Promise<$_model.StopTensorboardResponse>;
     /**
-     * Updates the configuration information of a job. For example, you can modify the priority of a job in a queue.
+     * Updates a job\\"s configuration, such as its priority.
      *
      * @param request - UpdateJobRequest
      * @param headers - map
@@ -644,7 +722,7 @@ export default class Client extends OpenApi {
         [key: string]: string;
     }, runtime: $dara.RuntimeOptions): Promise<$_model.UpdateJobResponse>;
     /**
-     * Updates the configuration information of a job. For example, you can modify the priority of a job in a queue.
+     * Updates a job\\"s configuration, such as its priority.
      *
      * @param request - UpdateJobRequest
      * @returns UpdateJobResponse
@@ -669,7 +747,7 @@ export default class Client extends OpenApi {
      */
     updateJobTemplate(TemplateId: string, request: $_model.UpdateJobTemplateRequest): Promise<$_model.UpdateJobTemplateResponse>;
     /**
-     * Updates a TensorBoard instance.
+     * Update a Tensorboard.
      *
      * @param request - UpdateTensorboardRequest
      * @param headers - map
@@ -680,7 +758,7 @@ export default class Client extends OpenApi {
         [key: string]: string;
     }, runtime: $dara.RuntimeOptions): Promise<$_model.UpdateTensorboardResponse>;
     /**
-     * Updates a TensorBoard instance.
+     * Update a Tensorboard.
      *
      * @param request - UpdateTensorboardRequest
      * @returns UpdateTensorboardResponse