@alicloud/ehpcinstant20230701 3.2.1 → 3.3.0

package/dist/client.js

@@ -62,7 +62,7 @@ class Client extends openapi_core_1.default {
         return openapi_core_2.OpenApiUtil.getEndpointRules(productId, regionId, endpointRule, network, suffix);
     }
     /**
-     * 添加托管侧用户自定义镜像
+     * Add a custom image.
      *
      * @param tmpReq - AddImageRequest
      * @param runtime - runtime options for this request RuntimeOptions
@@ -114,7 +114,7 @@ class Client extends openapi_core_1.default {
         return $dara.cast(await this.callApi(params, req, runtime), new $_model.AddImageResponse({}));
     }
     /**
-     * 添加托管侧用户自定义镜像
+     * Add a custom image.
      *
      * @param request - AddImageRequest
      * @returns AddImageResponse
@@ -124,7 +124,10 @@ class Client extends openapi_core_1.default {
         return await this.addImageWithOptions(request, runtime);
     }
     /**
-     * 创建执行计划创建执行计划
+     * 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
@@ -188,7 +191,10 @@ class Client extends openapi_core_1.default {
         return $dara.cast(await this.callApi(params, req, runtime), new $_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
@@ -198,7 +204,7 @@ class Client extends openapi_core_1.default {
         return await this.createActionPlanWithOptions(request, runtime);
     }
     /**
-     * 提交任务
+     * Create a E-HPC Instant job.
      *
      * @param tmpReq - CreateJobRequest
      * @param runtime - runtime options for this request RuntimeOptions
@@ -259,7 +265,7 @@ class Client extends openapi_core_1.default {
         return $dara.cast(await this.callApi(params, req, runtime), new $_model.CreateJobResponse({}));
     }
     /**
-     * 提交任务
+     * Create a E-HPC Instant job.
      *
      * @param request - CreateJobRequest
      * @returns CreateJobResponse
@@ -269,7 +275,7 @@ class Client extends openapi_core_1.default {
         return await this.createJobWithOptions(request, runtime);
     }
     /**
-     * 创建资源池
+     * Creates a resource pool.
      *
      * @param tmpReq - CreatePoolRequest
      * @param runtime - runtime options for this request RuntimeOptions
@@ -309,7 +315,7 @@ class Client extends openapi_core_1.default {
         return $dara.cast(await this.callApi(params, req, runtime), new $_model.CreatePoolResponse({}));
     }
     /**
-     * 创建资源池
+     * Creates a resource pool.
      *
      * @param request - CreatePoolRequest
      * @returns CreatePoolResponse
@@ -319,7 +325,11 @@ class Client extends openapi_core_1.default {
         return await this.createPoolWithOptions(request, runtime);
     }
     /**
-     * 删除执行计划
+     * 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
@@ -348,7 +358,11 @@ class Client extends openapi_core_1.default {
         return $dara.cast(await this.callApi(params, req, runtime), new $_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
@@ -358,7 +372,51 @@ class Client extends openapi_core_1.default {
         return await this.deleteActionPlanWithOptions(request, runtime);
     }
     /**
-     * 删除作业
+     * 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
+     */
+    async deleteJobRecordsWithOptions(tmpReq, runtime) {
+        tmpReq.validate();
+        let request = new $_model.DeleteJobRecordsShrinkRequest({});
+        openapi_core_2.OpenApiUtil.convert(tmpReq, request);
+        if (!$dara.isNull(tmpReq.jobIds)) {
+            request.jobIdsShrink = openapi_core_2.OpenApiUtil.arrayToStringWithSpecifiedStyle(tmpReq.jobIds, "JobIds", "json");
+        }
+        let query = {};
+        if (!$dara.isNull(request.jobIdsShrink)) {
+            query["JobIds"] = request.jobIdsShrink;
+        }
+        let req = new openapi_core_2.$OpenApiUtil.OpenApiRequest({
+            query: openapi_core_2.OpenApiUtil.query(query),
+        });
+        let params = new openapi_core_2.$OpenApiUtil.Params({
+            action: "DeleteJobRecords",
+            version: "2023-07-01",
+            protocol: "HTTPS",
+            pathname: "/",
+            method: "POST",
+            authType: "AK",
+            style: "RPC",
+            reqBodyType: "formData",
+            bodyType: "json",
+        });
+        return $dara.cast(await this.callApi(params, req, runtime), new $_model.DeleteJobRecordsResponse({}));
+    }
+    /**
+     * Deletes one or more job records that are in the final state from a specified cluster.
+     *
+     * @param request - DeleteJobRecordsRequest
+     * @returns DeleteJobRecordsResponse
+     */
+    async deleteJobRecords(request) {
+        let runtime = new $dara.RuntimeOptions({});
+        return await this.deleteJobRecordsWithOptions(request, runtime);
+    }
+    /**
+     * Deletes one or more jobs from a specified cluster.
      *
      * @param tmpReq - DeleteJobsRequest
      * @param runtime - runtime options for this request RuntimeOptions
@@ -401,7 +459,7 @@ class Client extends openapi_core_1.default {
         return $dara.cast(await this.callApi(params, req, runtime), new $_model.DeleteJobsResponse({}));
     }
     /**
-     * 删除作业
+     * Deletes one or more jobs from a specified cluster.
      *
      * @param request - DeleteJobsRequest
      * @returns DeleteJobsResponse
@@ -411,7 +469,7 @@ class Client extends openapi_core_1.default {
         return await this.deleteJobsWithOptions(request, runtime);
     }
     /**
-     * 删除资源池
+     * You can execute this statement to delete a resource pool.
      *
      * @param request - DeletePoolRequest
      * @param runtime - runtime options for this request RuntimeOptions
@@ -440,7 +498,7 @@ class Client extends openapi_core_1.default {
         return $dara.cast(await this.callApi(params, req, runtime), new $_model.DeletePoolResponse({}));
     }
     /**
-     * 删除资源池
+     * You can execute this statement to delete a resource pool.
      *
      * @param request - DeletePoolRequest
      * @returns DeletePoolResponse
@@ -450,7 +508,7 @@ class Client extends openapi_core_1.default {
         return await this.deletePoolWithOptions(request, runtime);
     }
     /**
-     * 查询作业性能数据
+     * 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
@@ -493,7 +551,7 @@ class Client extends openapi_core_1.default {
         return $dara.cast(await this.callApi(params, req, runtime), new $_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
@@ -503,7 +561,7 @@ class Client extends openapi_core_1.default {
         return await this.describeJobMetricDataWithOptions(request, runtime);
     }
     /**
-     * 查询作业即时监控项
+     * 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
@@ -543,7 +601,7 @@ class Client extends openapi_core_1.default {
         return $dara.cast(await this.callApi(params, req, runtime), new $_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
@@ -553,7 +611,7 @@ class Client extends openapi_core_1.default {
         return await this.describeJobMetricLastWithOptions(request, runtime);
     }
     /**
-     * 查询执行计划详情
+     * Querying Execution Plan Details
      *
      * @param request - GetActionPlanRequest
      * @param runtime - runtime options for this request RuntimeOptions
@@ -582,7 +640,7 @@ class Client extends openapi_core_1.default {
         return $dara.cast(await this.callApi(params, req, runtime), new $_model.GetActionPlanResponse({}));
     }
     /**
-     * 查询执行计划详情
+     * Querying Execution Plan Details
      *
      * @param request - GetActionPlanRequest
      * @returns GetActionPlanResponse
@@ -592,7 +650,7 @@ class Client extends openapi_core_1.default {
         return await this.getActionPlanWithOptions(request, runtime);
     }
     /**
-     * 查看应用版本列表
+     * Obtains the application version list.
      *
      * @param request - GetAppVersionsRequest
      * @param runtime - runtime options for this request RuntimeOptions
@@ -633,7 +691,7 @@ class Client extends openapi_core_1.default {
         return $dara.cast(await this.callApi(params, req, runtime), new $_model.GetAppVersionsResponse({}));
     }
     /**
-     * 查看应用版本列表
+     * Obtains the application version list.
      *
      * @param request - GetAppVersionsRequest
      * @returns GetAppVersionsResponse
@@ -643,7 +701,7 @@ class Client extends openapi_core_1.default {
         return await this.getAppVersionsWithOptions(request, runtime);
     }
     /**
-     * 查询托管侧镜像详情。
+     * Obtains the information about an image.
      *
      * @param tmpReq - GetImageRequest
      * @param runtime - runtime options for this request RuntimeOptions
@@ -686,7 +744,7 @@ class Client extends openapi_core_1.default {
         return $dara.cast(await this.callApi(params, req, runtime), new $_model.GetImageResponse({}));
     }
     /**
-     * 查询托管侧镜像详情。
+     * Obtains the information about an image.
      *
      * @param request - GetImageRequest
      * @returns GetImageResponse
@@ -696,7 +754,7 @@ class Client extends openapi_core_1.default {
         return await this.getImageWithOptions(request, runtime);
     }
     /**
-     * 查询作业详情
+     * Obtains the details of an execution job.
      *
      * @param request - GetJobRequest
      * @param runtime - runtime options for this request RuntimeOptions
@@ -725,7 +783,7 @@ class Client extends openapi_core_1.default {
         return $dara.cast(await this.callApi(params, req, runtime), new $_model.GetJobResponse({}));
     }
     /**
-     * 查询作业详情
+     * Obtains the details of an execution job.
      *
      * @param request - GetJobRequest
      * @returns GetJobResponse
@@ -735,7 +793,7 @@ class Client extends openapi_core_1.default {
         return await this.getJobWithOptions(request, runtime);
     }
     /**
-     * 查询队列详细信息
+     * Obtains the details of a resource pool.
      *
      * @param request - GetPoolRequest
      * @param runtime - runtime options for this request RuntimeOptions
@@ -764,7 +822,7 @@ class Client extends openapi_core_1.default {
         return $dara.cast(await this.callApi(params, req, runtime), new $_model.GetPoolResponse({}));
     }
     /**
-     * 查询队列详细信息
+     * Obtains the details of a resource pool.
      *
      * @param request - GetPoolRequest
      * @returns GetPoolResponse
@@ -774,7 +832,7 @@ class Client extends openapi_core_1.default {
         return await this.getPoolWithOptions(request, runtime);
     }
     /**
-     * 查询执行计划的执行情况。
+     * Queries the execution status of an execution plan.
      *
      * @param request - ListActionPlanActivitiesRequest
      * @param runtime - runtime options for this request RuntimeOptions
@@ -809,7 +867,7 @@ class Client extends openapi_core_1.default {
         return $dara.cast(await this.callApi(params, req, runtime), new $_model.ListActionPlanActivitiesResponse({}));
     }
     /**
-     * 查询执行计划的执行情况。
+     * Queries the execution status of an execution plan.
      *
      * @param request - ListActionPlanActivitiesRequest
      * @returns ListActionPlanActivitiesResponse
@@ -819,7 +877,7 @@ class Client extends openapi_core_1.default {
         return await this.listActionPlanActivitiesWithOptions(request, runtime);
     }
     /**
-     * 查询执行计划列表
+     * Queries the list of execution plans.
      *
      * @param tmpReq - ListActionPlansRequest
      * @param runtime - runtime options for this request RuntimeOptions
@@ -859,7 +917,7 @@ class Client extends openapi_core_1.default {
         return $dara.cast(await this.callApi(params, req, runtime), new $_model.ListActionPlansResponse({}));
     }
     /**
-     * 查询执行计划列表
+     * Queries the list of execution plans.
      *
      * @param request - ListActionPlansRequest
      * @returns ListActionPlansResponse
@@ -869,7 +927,7 @@ class Client extends openapi_core_1.default {
         return await this.listActionPlansWithOptions(request, runtime);
     }
     /**
-     * 查询全局Executor信息
+     * Querying Global Executor Information
      *
      * @param tmpReq - ListExecutorsRequest
      * @param runtime - runtime options for this request RuntimeOptions
@@ -909,7 +967,7 @@ class Client extends openapi_core_1.default {
         return $dara.cast(await this.callApi(params, req, runtime), new $_model.ListExecutorsResponse({}));
     }
     /**
-     * 查询全局Executor信息
+     * Querying Global Executor Information
      *
      * @param request - ListExecutorsRequest
      * @returns ListExecutorsResponse
@@ -919,7 +977,7 @@ class Client extends openapi_core_1.default {
         return await this.listExecutorsWithOptions(request, runtime);
     }
     /**
-     * 查看托管侧镜像列表
+     * Queries the image list.
      *
      * @param tmpReq - ListImagesRequest
      * @param runtime - runtime options for this request RuntimeOptions
@@ -974,7 +1032,7 @@ class Client extends openapi_core_1.default {
         return $dara.cast(await this.callApi(params, req, runtime), new $_model.ListImagesResponse({}));
     }
     /**
-     * 查看托管侧镜像列表
+     * Queries the image list.
      *
      * @param request - ListImagesRequest
      * @returns ListImagesResponse
@@ -984,7 +1042,10 @@ class Client extends openapi_core_1.default {
         return await this.listImagesWithOptions(request, runtime);
     }
     /**
-     * 查询作业Executor信息
+     * Queries job executor information.
+     *
+     * @remarks
+     * Queries job executor information.
      *
      * @param request - ListJobExecutorsRequest
      * @param runtime - runtime options for this request RuntimeOptions
@@ -1022,7 +1083,10 @@ class Client extends openapi_core_1.default {
         return $dara.cast(await this.callApi(params, req, runtime), new $_model.ListJobExecutorsResponse({}));
     }
     /**
-     * 查询作业Executor信息
+     * Queries job executor information.
+     *
+     * @remarks
+     * Queries job executor information.
      *
      * @param request - ListJobExecutorsRequest
      * @returns ListJobExecutorsResponse
@@ -1032,7 +1096,7 @@ class Client extends openapi_core_1.default {
         return await this.listJobExecutorsWithOptions(request, runtime);
     }
     /**
-     * 查询作业列表
+     * Queries the jobs in a cluster.
      *
      * @param tmpReq - ListJobsRequest
      * @param runtime - runtime options for this request RuntimeOptions
@@ -1078,7 +1142,7 @@ class Client extends openapi_core_1.default {
         return $dara.cast(await this.callApi(params, req, runtime), new $_model.ListJobsResponse({}));
     }
     /**
-     * 查询作业列表
+     * Queries the jobs in a cluster.
      *
      * @param request - ListJobsRequest
      * @returns ListJobsResponse
@@ -1088,7 +1152,7 @@ class Client extends openapi_core_1.default {
         return await this.listJobsWithOptions(request, runtime);
     }
     /**
-     * 查询资源池列表
+     * Queries the resource pool list.
      *
      * @param tmpReq - ListPoolsRequest
      * @param runtime - runtime options for this request RuntimeOptions
@@ -1128,7 +1192,7 @@ class Client extends openapi_core_1.default {
         return $dara.cast(await this.callApi(params, req, runtime), new $_model.ListPoolsResponse({}));
     }
     /**
-     * 查询资源池列表
+     * Queries the resource pool list.
      *
      * @param request - ListPoolsRequest
      * @returns ListPoolsResponse
@@ -1138,7 +1202,7 @@ class Client extends openapi_core_1.default {
         return await this.listPoolsWithOptions(request, runtime);
     }
     /**
-     * 查询一个或多个资源已经绑定的标签列表
+     * Queries the tags that are bound to one or more Instant resources.
      *
      * @param request - ListTagResourcesRequest
      * @param runtime - runtime options for this request RuntimeOptions
@@ -1179,7 +1243,7 @@ class Client extends openapi_core_1.default {
         return $dara.cast(await this.callApi(params, req, runtime), new $_model.ListTagResourcesResponse({}));
     }
     /**
-     * 查询一个或多个资源已经绑定的标签列表
+     * Queries the tags that are bound to one or more Instant resources.
      *
      * @param request - ListTagResourcesRequest
      * @returns ListTagResourcesResponse
@@ -1189,7 +1253,7 @@ class Client extends openapi_core_1.default {
         return await this.listTagResourcesWithOptions(request, runtime);
     }
     /**
-     * 移除托管侧镜像信息。
+     * Remove a custom image
      *
      * @param request - RemoveImageRequest
      * @param runtime - runtime options for this request RuntimeOptions
@@ -1221,7 +1285,7 @@ class Client extends openapi_core_1.default {
         return $dara.cast(await this.callApi(params, req, runtime), new $_model.RemoveImageResponse({}));
     }
     /**
-     * 移除托管侧镜像信息。
+     * Remove a custom image
      *
      * @param request - RemoveImageRequest
      * @returns RemoveImageResponse
@@ -1231,7 +1295,7 @@ class Client extends openapi_core_1.default {
         return await this.removeImageWithOptions(request, runtime);
     }
     /**
-     * 应用跨地域同步
+     * Application cross-region synchronization
      *
      * @param tmpReq - SynchronizeAppRequest
      * @param runtime - runtime options for this request RuntimeOptions
@@ -1268,7 +1332,7 @@ class Client extends openapi_core_1.default {
         return $dara.cast(await this.callApi(params, req, runtime), new $_model.SynchronizeAppResponse({}));
     }
     /**
-     * 应用跨地域同步
+     * Application cross-region synchronization
      *
      * @param request - SynchronizeAppRequest
      * @returns SynchronizeAppResponse
@@ -1278,7 +1342,7 @@ class Client extends openapi_core_1.default {
         return await this.synchronizeAppWithOptions(request, runtime);
     }
     /**
-     * 为指定的资源列表统一创建并绑定标签
+     * Create and bind tags to Instant resource list
      *
      * @param request - TagResourcesRequest
      * @param runtime - runtime options for this request RuntimeOptions
@@ -1313,7 +1377,7 @@ class Client extends openapi_core_1.default {
         return $dara.cast(await this.callApi(params, req, runtime), new $_model.TagResourcesResponse({}));
     }
     /**
-     * 为指定的资源列表统一创建并绑定标签
+     * Create and bind tags to Instant resource list
      *
      * @param request - TagResourcesRequest
      * @returns TagResourcesResponse
@@ -1323,7 +1387,7 @@ class Client extends openapi_core_1.default {
         return await this.tagResourcesWithOptions(request, runtime);
     }
     /**
-     * 为指定的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
@@ -1361,7 +1425,7 @@ class Client extends openapi_core_1.default {
         return $dara.cast(await this.callApi(params, req, runtime), new $_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
@@ -1371,7 +1435,7 @@ class Client extends openapi_core_1.default {
         return await this.unTagResourcesWithOptions(request, runtime);
     }
     /**
-     * 更新执行计划
+     * Adjust the resource scale of the execution plan or modify the execution status
      *
      * @param request - UpdateActionPlanRequest
      * @param runtime - runtime options for this request RuntimeOptions
@@ -1406,7 +1470,7 @@ class Client extends openapi_core_1.default {
         return $dara.cast(await this.callApi(params, req, runtime), new $_model.UpdateActionPlanResponse({}));
     }
     /**
-     * 更新执行计划
+     * Adjust the resource scale of the execution plan or modify the execution status
      *
      * @param request - UpdateActionPlanRequest
      * @returns UpdateActionPlanResponse
@@ -1416,7 +1480,7 @@ class Client extends openapi_core_1.default {
         return await this.updateActionPlanWithOptions(request, runtime);
     }
     /**
-     * 更新资源池
+     * Update the resource pool configuration.
      *
      * @param tmpReq - UpdatePoolRequest
      * @param runtime - runtime options for this request RuntimeOptions
@@ -1456,7 +1520,7 @@ class Client extends openapi_core_1.default {
         return $dara.cast(await this.callApi(params, req, runtime), new $_model.UpdatePoolResponse({}));
     }
     /**
-     * 更新资源池
+     * Update the resource pool configuration.
      *
      * @param request - UpdatePoolRequest
      * @returns UpdatePoolResponse