@alicloud/ehpcinstant20230701 3.2.1 → 3.4.0

package/dist/client.d.ts

@@ -9,7 +9,7 @@ export default class Client extends OpenApi {
         [key: string]: string;
     }, endpoint: string): string;
     /**
-     * 添加托管侧用户自定义镜像
+     * Add a custom image.
      *
      * @param tmpReq - AddImageRequest
      * @param runtime - runtime options for this request RuntimeOptions
@@ -17,14 +17,17 @@ export default class Client extends OpenApi {
      */
     addImageWithOptions(tmpReq: $_model.AddImageRequest, runtime: $dara.RuntimeOptions): Promise<$_model.AddImageResponse>;
     /**
-     * 添加托管侧用户自定义镜像
+     * Add a custom image.
      *
      * @param request - AddImageRequest
      * @returns AddImageResponse
      */
     addImage(request: $_model.AddImageRequest): Promise<$_model.AddImageResponse>;
     /**
-     * 创建执行计划创建执行计划
+     * Create a E-HPC execution plan.
+     *
+     * @remarks
+     * *Make sure that you fully understand E-HPC Instnat billing methods and [prices](https://help.aliyun.com/zh/e-hpc/e-hpc-instant/product-overview/billing-overview?spm=a2c4g.11186623.help-menu-57664.d_0_2_0.5fdd28422y6UvO).
      *
      * @param tmpReq - CreateActionPlanRequest
      * @param runtime - runtime options for this request RuntimeOptions
@@ -32,14 +35,17 @@ export default class Client extends OpenApi {
      */
     createActionPlanWithOptions(tmpReq: $_model.CreateActionPlanRequest, runtime: $dara.RuntimeOptions): Promise<$_model.CreateActionPlanResponse>;
     /**
-     * 创建执行计划创建执行计划
+     * Create a E-HPC execution plan.
+     *
+     * @remarks
+     * *Make sure that you fully understand E-HPC Instnat billing methods and [prices](https://help.aliyun.com/zh/e-hpc/e-hpc-instant/product-overview/billing-overview?spm=a2c4g.11186623.help-menu-57664.d_0_2_0.5fdd28422y6UvO).
      *
      * @param request - CreateActionPlanRequest
      * @returns CreateActionPlanResponse
      */
     createActionPlan(request: $_model.CreateActionPlanRequest): Promise<$_model.CreateActionPlanResponse>;
     /**
-     * 提交任务
+     * Create a E-HPC Instant job.
      *
      * @param tmpReq - CreateJobRequest
      * @param runtime - runtime options for this request RuntimeOptions
@@ -47,14 +53,14 @@ export default class Client extends OpenApi {
      */
     createJobWithOptions(tmpReq: $_model.CreateJobRequest, runtime: $dara.RuntimeOptions): Promise<$_model.CreateJobResponse>;
     /**
-     * 提交任务
+     * Create a E-HPC Instant job.
      *
      * @param request - CreateJobRequest
      * @returns CreateJobResponse
      */
     createJob(request: $_model.CreateJobRequest): Promise<$_model.CreateJobResponse>;
     /**
-     * 创建资源池
+     * Creates a resource pool.
      *
      * @param tmpReq - CreatePoolRequest
      * @param runtime - runtime options for this request RuntimeOptions
@@ -62,14 +68,18 @@ export default class Client extends OpenApi {
      */
     createPoolWithOptions(tmpReq: $_model.CreatePoolRequest, runtime: $dara.RuntimeOptions): Promise<$_model.CreatePoolResponse>;
     /**
-     * 创建资源池
+     * Creates a resource pool.
      *
      * @param request - CreatePoolRequest
      * @returns CreatePoolResponse
      */
     createPool(request: $_model.CreatePoolRequest): Promise<$_model.CreatePoolResponse>;
     /**
-     * 删除执行计划
+     * Delete an execution plan
+     *
+     * @remarks
+     * *Make sure that you fully understand E-HPC Instnat billing methods and [prices](https://help.aliyun.com/zh/e-hpc/e-hpc-instant/product-overview/billing-overview?spm=a2c4g.11186623.help-menu-57664.d_0_2_0.5fdd28422y6UvO).**
+     * This operation stops all Instant jobs that are managed by ActionPlanId.
      *
      * @param request - DeleteActionPlanRequest
      * @param runtime - runtime options for this request RuntimeOptions
@@ -77,14 +87,33 @@ export default class Client extends OpenApi {
      */
     deleteActionPlanWithOptions(request: $_model.DeleteActionPlanRequest, runtime: $dara.RuntimeOptions): Promise<$_model.DeleteActionPlanResponse>;
     /**
-     * 删除执行计划
+     * Delete an execution plan
+     *
+     * @remarks
+     * *Make sure that you fully understand E-HPC Instnat billing methods and [prices](https://help.aliyun.com/zh/e-hpc/e-hpc-instant/product-overview/billing-overview?spm=a2c4g.11186623.help-menu-57664.d_0_2_0.5fdd28422y6UvO).**
+     * This operation stops all Instant jobs that are managed by ActionPlanId.
      *
      * @param request - DeleteActionPlanRequest
      * @returns DeleteActionPlanResponse
      */
     deleteActionPlan(request: $_model.DeleteActionPlanRequest): Promise<$_model.DeleteActionPlanResponse>;
     /**
-     * 删除作业
+     * Deletes one or more job records that are in the final state from a specified cluster.
+     *
+     * @param tmpReq - DeleteJobRecordsRequest
+     * @param runtime - runtime options for this request RuntimeOptions
+     * @returns DeleteJobRecordsResponse
+     */
+    deleteJobRecordsWithOptions(tmpReq: $_model.DeleteJobRecordsRequest, runtime: $dara.RuntimeOptions): Promise<$_model.DeleteJobRecordsResponse>;
+    /**
+     * Deletes one or more job records that are in the final state from a specified cluster.
+     *
+     * @param request - DeleteJobRecordsRequest
+     * @returns DeleteJobRecordsResponse
+     */
+    deleteJobRecords(request: $_model.DeleteJobRecordsRequest): Promise<$_model.DeleteJobRecordsResponse>;
+    /**
+     * Deletes one or more jobs from a specified cluster.
      *
      * @param tmpReq - DeleteJobsRequest
      * @param runtime - runtime options for this request RuntimeOptions
@@ -92,14 +121,14 @@ export default class Client extends OpenApi {
      */
     deleteJobsWithOptions(tmpReq: $_model.DeleteJobsRequest, runtime: $dara.RuntimeOptions): Promise<$_model.DeleteJobsResponse>;
     /**
-     * 删除作业
+     * Deletes one or more jobs from a specified cluster.
      *
      * @param request - DeleteJobsRequest
      * @returns DeleteJobsResponse
      */
     deleteJobs(request: $_model.DeleteJobsRequest): Promise<$_model.DeleteJobsResponse>;
     /**
-     * 删除资源池
+     * You can execute this statement to delete a resource pool.
      *
      * @param request - DeletePoolRequest
      * @param runtime - runtime options for this request RuntimeOptions
@@ -107,14 +136,14 @@ export default class Client extends OpenApi {
      */
     deletePoolWithOptions(request: $_model.DeletePoolRequest, runtime: $dara.RuntimeOptions): Promise<$_model.DeletePoolResponse>;
     /**
-     * 删除资源池
+     * You can execute this statement to delete a resource pool.
      *
      * @param request - DeletePoolRequest
      * @returns DeletePoolResponse
      */
     deletePool(request: $_model.DeletePoolRequest): Promise<$_model.DeletePoolResponse>;
     /**
-     * 查询作业性能数据
+     * You can query the monitoring time series dataset of a job by specifying the job array index and query metric parameters.
      *
      * @param tmpReq - DescribeJobMetricDataRequest
      * @param runtime - runtime options for this request RuntimeOptions
@@ -122,14 +151,14 @@ export default class Client extends OpenApi {
      */
     describeJobMetricDataWithOptions(tmpReq: $_model.DescribeJobMetricDataRequest, runtime: $dara.RuntimeOptions): Promise<$_model.DescribeJobMetricDataResponse>;
     /**
-     * 查询作业性能数据
+     * You can query the monitoring time series dataset of a job by specifying the job array index and query metric parameters.
      *
      * @param request - DescribeJobMetricDataRequest
      * @returns DescribeJobMetricDataResponse
      */
     describeJobMetricData(request: $_model.DescribeJobMetricDataRequest): Promise<$_model.DescribeJobMetricDataResponse>;
     /**
-     * 查询作业即时监控项
+     * Queries all instant monitoring metrics in the job array list by specifying a specific job array index list.
      *
      * @param tmpReq - DescribeJobMetricLastRequest
      * @param runtime - runtime options for this request RuntimeOptions
@@ -137,14 +166,14 @@ export default class Client extends OpenApi {
      */
     describeJobMetricLastWithOptions(tmpReq: $_model.DescribeJobMetricLastRequest, runtime: $dara.RuntimeOptions): Promise<$_model.DescribeJobMetricLastResponse>;
     /**
-     * 查询作业即时监控项
+     * Queries all instant monitoring metrics in the job array list by specifying a specific job array index list.
      *
      * @param request - DescribeJobMetricLastRequest
      * @returns DescribeJobMetricLastResponse
      */
     describeJobMetricLast(request: $_model.DescribeJobMetricLastRequest): Promise<$_model.DescribeJobMetricLastResponse>;
     /**
-     * 查询执行计划详情
+     * Querying Execution Plan Details
      *
      * @param request - GetActionPlanRequest
      * @param runtime - runtime options for this request RuntimeOptions
@@ -152,14 +181,14 @@ export default class Client extends OpenApi {
      */
     getActionPlanWithOptions(request: $_model.GetActionPlanRequest, runtime: $dara.RuntimeOptions): Promise<$_model.GetActionPlanResponse>;
     /**
-     * 查询执行计划详情
+     * Querying Execution Plan Details
      *
      * @param request - GetActionPlanRequest
      * @returns GetActionPlanResponse
      */
     getActionPlan(request: $_model.GetActionPlanRequest): Promise<$_model.GetActionPlanResponse>;
     /**
-     * 查看应用版本列表
+     * Obtains the application version list.
      *
      * @param request - GetAppVersionsRequest
      * @param runtime - runtime options for this request RuntimeOptions
@@ -167,14 +196,14 @@ export default class Client extends OpenApi {
      */
     getAppVersionsWithOptions(request: $_model.GetAppVersionsRequest, runtime: $dara.RuntimeOptions): Promise<$_model.GetAppVersionsResponse>;
     /**
-     * 查看应用版本列表
+     * Obtains the application version list.
      *
      * @param request - GetAppVersionsRequest
      * @returns GetAppVersionsResponse
      */
     getAppVersions(request: $_model.GetAppVersionsRequest): Promise<$_model.GetAppVersionsResponse>;
     /**
-     * 查询托管侧镜像详情。
+     * Obtains the information about an image.
      *
      * @param tmpReq - GetImageRequest
      * @param runtime - runtime options for this request RuntimeOptions
@@ -182,14 +211,14 @@ export default class Client extends OpenApi {
      */
     getImageWithOptions(tmpReq: $_model.GetImageRequest, runtime: $dara.RuntimeOptions): Promise<$_model.GetImageResponse>;
     /**
-     * 查询托管侧镜像详情。
+     * Obtains the information about an image.
      *
      * @param request - GetImageRequest
      * @returns GetImageResponse
      */
     getImage(request: $_model.GetImageRequest): Promise<$_model.GetImageResponse>;
     /**
-     * 查询作业详情
+     * Obtains the details of an execution job.
      *
      * @param request - GetJobRequest
      * @param runtime - runtime options for this request RuntimeOptions
@@ -197,14 +226,14 @@ export default class Client extends OpenApi {
      */
     getJobWithOptions(request: $_model.GetJobRequest, runtime: $dara.RuntimeOptions): Promise<$_model.GetJobResponse>;
     /**
-     * 查询作业详情
+     * Obtains the details of an execution job.
      *
      * @param request - GetJobRequest
      * @returns GetJobResponse
      */
     getJob(request: $_model.GetJobRequest): Promise<$_model.GetJobResponse>;
     /**
-     * 查询队列详细信息
+     * Obtains the details of a resource pool.
      *
      * @param request - GetPoolRequest
      * @param runtime - runtime options for this request RuntimeOptions
@@ -212,14 +241,14 @@ export default class Client extends OpenApi {
      */
     getPoolWithOptions(request: $_model.GetPoolRequest, runtime: $dara.RuntimeOptions): Promise<$_model.GetPoolResponse>;
     /**
-     * 查询队列详细信息
+     * Obtains the details of a resource pool.
      *
      * @param request - GetPoolRequest
      * @returns GetPoolResponse
      */
     getPool(request: $_model.GetPoolRequest): Promise<$_model.GetPoolResponse>;
     /**
-     * 查询执行计划的执行情况。
+     * Queries the execution status of an execution plan.
      *
      * @param request - ListActionPlanActivitiesRequest
      * @param runtime - runtime options for this request RuntimeOptions
@@ -227,14 +256,14 @@ export default class Client extends OpenApi {
      */
     listActionPlanActivitiesWithOptions(request: $_model.ListActionPlanActivitiesRequest, runtime: $dara.RuntimeOptions): Promise<$_model.ListActionPlanActivitiesResponse>;
     /**
-     * 查询执行计划的执行情况。
+     * Queries the execution status of an execution plan.
      *
      * @param request - ListActionPlanActivitiesRequest
      * @returns ListActionPlanActivitiesResponse
      */
     listActionPlanActivities(request: $_model.ListActionPlanActivitiesRequest): Promise<$_model.ListActionPlanActivitiesResponse>;
     /**
-     * 查询执行计划列表
+     * Queries the list of execution plans.
      *
      * @param tmpReq - ListActionPlansRequest
      * @param runtime - runtime options for this request RuntimeOptions
@@ -242,14 +271,29 @@ export default class Client extends OpenApi {
      */
     listActionPlansWithOptions(tmpReq: $_model.ListActionPlansRequest, runtime: $dara.RuntimeOptions): Promise<$_model.ListActionPlansResponse>;
     /**
-     * 查询执行计划列表
+     * Queries the list of execution plans.
      *
      * @param request - ListActionPlansRequest
      * @returns ListActionPlansResponse
      */
     listActionPlans(request: $_model.ListActionPlansRequest): Promise<$_model.ListActionPlansResponse>;
     /**
-     * 查询全局Executor信息
+     * 查询Executor的事件信息
+     *
+     * @param tmpReq - ListExecutorEventsRequest
+     * @param runtime - runtime options for this request RuntimeOptions
+     * @returns ListExecutorEventsResponse
+     */
+    listExecutorEventsWithOptions(tmpReq: $_model.ListExecutorEventsRequest, runtime: $dara.RuntimeOptions): Promise<$_model.ListExecutorEventsResponse>;
+    /**
+     * 查询Executor的事件信息
+     *
+     * @param request - ListExecutorEventsRequest
+     * @returns ListExecutorEventsResponse
+     */
+    listExecutorEvents(request: $_model.ListExecutorEventsRequest): Promise<$_model.ListExecutorEventsResponse>;
+    /**
+     * Querying Global Executor Information
      *
      * @param tmpReq - ListExecutorsRequest
      * @param runtime - runtime options for this request RuntimeOptions
@@ -257,14 +301,14 @@ export default class Client extends OpenApi {
      */
     listExecutorsWithOptions(tmpReq: $_model.ListExecutorsRequest, runtime: $dara.RuntimeOptions): Promise<$_model.ListExecutorsResponse>;
     /**
-     * 查询全局Executor信息
+     * Querying Global Executor Information
      *
      * @param request - ListExecutorsRequest
      * @returns ListExecutorsResponse
      */
     listExecutors(request: $_model.ListExecutorsRequest): Promise<$_model.ListExecutorsResponse>;
     /**
-     * 查看托管侧镜像列表
+     * Queries the image list.
      *
      * @param tmpReq - ListImagesRequest
      * @param runtime - runtime options for this request RuntimeOptions
@@ -272,14 +316,17 @@ export default class Client extends OpenApi {
      */
     listImagesWithOptions(tmpReq: $_model.ListImagesRequest, runtime: $dara.RuntimeOptions): Promise<$_model.ListImagesResponse>;
     /**
-     * 查看托管侧镜像列表
+     * Queries the image list.
      *
      * @param request - ListImagesRequest
      * @returns ListImagesResponse
      */
     listImages(request: $_model.ListImagesRequest): Promise<$_model.ListImagesResponse>;
     /**
-     * 查询作业Executor信息
+     * Queries job executor information.
+     *
+     * @remarks
+     * Queries job executor information.
      *
      * @param request - ListJobExecutorsRequest
      * @param runtime - runtime options for this request RuntimeOptions
@@ -287,14 +334,17 @@ export default class Client extends OpenApi {
      */
     listJobExecutorsWithOptions(request: $_model.ListJobExecutorsRequest, runtime: $dara.RuntimeOptions): Promise<$_model.ListJobExecutorsResponse>;
     /**
-     * 查询作业Executor信息
+     * Queries job executor information.
+     *
+     * @remarks
+     * Queries job executor information.
      *
      * @param request - ListJobExecutorsRequest
      * @returns ListJobExecutorsResponse
      */
     listJobExecutors(request: $_model.ListJobExecutorsRequest): Promise<$_model.ListJobExecutorsResponse>;
     /**
-     * 查询作业列表
+     * Queries the jobs in a cluster.
      *
      * @param tmpReq - ListJobsRequest
      * @param runtime - runtime options for this request RuntimeOptions
@@ -302,14 +352,14 @@ export default class Client extends OpenApi {
      */
     listJobsWithOptions(tmpReq: $_model.ListJobsRequest, runtime: $dara.RuntimeOptions): Promise<$_model.ListJobsResponse>;
     /**
-     * 查询作业列表
+     * Queries the jobs in a cluster.
      *
      * @param request - ListJobsRequest
      * @returns ListJobsResponse
      */
     listJobs(request: $_model.ListJobsRequest): Promise<$_model.ListJobsResponse>;
     /**
-     * 查询资源池列表
+     * Queries the resource pool list.
      *
      * @param tmpReq - ListPoolsRequest
      * @param runtime - runtime options for this request RuntimeOptions
@@ -317,14 +367,14 @@ export default class Client extends OpenApi {
      */
     listPoolsWithOptions(tmpReq: $_model.ListPoolsRequest, runtime: $dara.RuntimeOptions): Promise<$_model.ListPoolsResponse>;
     /**
-     * 查询资源池列表
+     * Queries the resource pool list.
      *
      * @param request - ListPoolsRequest
      * @returns ListPoolsResponse
      */
     listPools(request: $_model.ListPoolsRequest): Promise<$_model.ListPoolsResponse>;
     /**
-     * 查询一个或多个资源已经绑定的标签列表
+     * Queries the tags that are bound to one or more Instant resources.
      *
      * @param request - ListTagResourcesRequest
      * @param runtime - runtime options for this request RuntimeOptions
@@ -332,14 +382,14 @@ export default class Client extends OpenApi {
      */
     listTagResourcesWithOptions(request: $_model.ListTagResourcesRequest, runtime: $dara.RuntimeOptions): Promise<$_model.ListTagResourcesResponse>;
     /**
-     * 查询一个或多个资源已经绑定的标签列表
+     * Queries the tags that are bound to one or more Instant resources.
      *
      * @param request - ListTagResourcesRequest
      * @returns ListTagResourcesResponse
      */
     listTagResources(request: $_model.ListTagResourcesRequest): Promise<$_model.ListTagResourcesResponse>;
     /**
-     * 移除托管侧镜像信息。
+     * Remove a custom image
      *
      * @param request - RemoveImageRequest
      * @param runtime - runtime options for this request RuntimeOptions
@@ -347,14 +397,14 @@ export default class Client extends OpenApi {
      */
     removeImageWithOptions(request: $_model.RemoveImageRequest, runtime: $dara.RuntimeOptions): Promise<$_model.RemoveImageResponse>;
     /**
-     * 移除托管侧镜像信息。
+     * Remove a custom image
      *
      * @param request - RemoveImageRequest
      * @returns RemoveImageResponse
      */
     removeImage(request: $_model.RemoveImageRequest): Promise<$_model.RemoveImageResponse>;
     /**
-     * 应用跨地域同步
+     * Application cross-region synchronization
      *
      * @param tmpReq - SynchronizeAppRequest
      * @param runtime - runtime options for this request RuntimeOptions
@@ -362,14 +412,14 @@ export default class Client extends OpenApi {
      */
     synchronizeAppWithOptions(tmpReq: $_model.SynchronizeAppRequest, runtime: $dara.RuntimeOptions): Promise<$_model.SynchronizeAppResponse>;
     /**
-     * 应用跨地域同步
+     * Application cross-region synchronization
      *
      * @param request - SynchronizeAppRequest
      * @returns SynchronizeAppResponse
      */
     synchronizeApp(request: $_model.SynchronizeAppRequest): Promise<$_model.SynchronizeAppResponse>;
     /**
-     * 为指定的资源列表统一创建并绑定标签
+     * Create and bind tags to Instant resource list
      *
      * @param request - TagResourcesRequest
      * @param runtime - runtime options for this request RuntimeOptions
@@ -377,14 +427,14 @@ export default class Client extends OpenApi {
      */
     tagResourcesWithOptions(request: $_model.TagResourcesRequest, runtime: $dara.RuntimeOptions): Promise<$_model.TagResourcesResponse>;
     /**
-     * 为指定的资源列表统一创建并绑定标签
+     * Create and bind tags to Instant resource list
      *
      * @param request - TagResourcesRequest
      * @returns TagResourcesResponse
      */
     tagResources(request: $_model.TagResourcesRequest): Promise<$_model.TagResourcesResponse>;
     /**
-     * 为指定的ECS资源列表统一解绑标签
+     * Unbind tags from Instant resource list. If the tag is not bound to other resources, the tag is automatically deleted.
      *
      * @param request - UnTagResourcesRequest
      * @param runtime - runtime options for this request RuntimeOptions
@@ -392,14 +442,14 @@ export default class Client extends OpenApi {
      */
     unTagResourcesWithOptions(request: $_model.UnTagResourcesRequest, runtime: $dara.RuntimeOptions): Promise<$_model.UnTagResourcesResponse>;
     /**
-     * 为指定的ECS资源列表统一解绑标签
+     * Unbind tags from Instant resource list. If the tag is not bound to other resources, the tag is automatically deleted.
      *
      * @param request - UnTagResourcesRequest
      * @returns UnTagResourcesResponse
      */
     unTagResources(request: $_model.UnTagResourcesRequest): Promise<$_model.UnTagResourcesResponse>;
     /**
-     * 更新执行计划
+     * Adjust the resource scale of the execution plan or modify the execution status
      *
      * @param request - UpdateActionPlanRequest
      * @param runtime - runtime options for this request RuntimeOptions
@@ -407,14 +457,14 @@ export default class Client extends OpenApi {
      */
     updateActionPlanWithOptions(request: $_model.UpdateActionPlanRequest, runtime: $dara.RuntimeOptions): Promise<$_model.UpdateActionPlanResponse>;
     /**
-     * 更新执行计划
+     * Adjust the resource scale of the execution plan or modify the execution status
      *
      * @param request - UpdateActionPlanRequest
      * @returns UpdateActionPlanResponse
      */
     updateActionPlan(request: $_model.UpdateActionPlanRequest): Promise<$_model.UpdateActionPlanResponse>;
     /**
-     * 更新资源池
+     * Update the resource pool configuration.
      *
      * @param tmpReq - UpdatePoolRequest
      * @param runtime - runtime options for this request RuntimeOptions
@@ -422,7 +472,7 @@ export default class Client extends OpenApi {
      */
     updatePoolWithOptions(tmpReq: $_model.UpdatePoolRequest, runtime: $dara.RuntimeOptions): Promise<$_model.UpdatePoolResponse>;
     /**
-     * 更新资源池
+     * Update the resource pool configuration.
      *
      * @param request - UpdatePoolRequest
      * @returns UpdatePoolResponse