@alicloud/ecd20200930 4.16.3 → 4.17.0

package/src/client.ts

@@ -984,6 +984,11 @@ export default class Client extends OpenApi {
   }
 
   /**
+   * @remarks
+   *   The cloud computers for which you want to change their policies must be in the Running state.
+   * *   After you call this operation, the assignment result is immediately returned. You can call the [DescribeDesktops](https://help.aliyun.com/document_detail/436815.html) operation to query the assignment of the cloud computer. The value of the `ManagementFlags` response parameter indicates the assignment of the cloud computer. A value of `ASSIGNING` indicates that the cloud computer is being assigned, and other values indicate that the cloud computer is assigned.
+   * *   We recommend that you check the assignment every 2 to 5 seconds and perform the checks within 50 seconds. Typically, 1 to 5 seconds are required to complete the assignment.
+   * 
    * @param request - BatchModifyEntitlementRequest
    * @param runtime - runtime options for this request RuntimeOptions
    * @returns BatchModifyEntitlementResponse
@@ -1037,6 +1042,11 @@ export default class Client extends OpenApi {
   }
 
   /**
+   * @remarks
+   *   The cloud computers for which you want to change their policies must be in the Running state.
+   * *   After you call this operation, the assignment result is immediately returned. You can call the [DescribeDesktops](https://help.aliyun.com/document_detail/436815.html) operation to query the assignment of the cloud computer. The value of the `ManagementFlags` response parameter indicates the assignment of the cloud computer. A value of `ASSIGNING` indicates that the cloud computer is being assigned, and other values indicate that the cloud computer is assigned.
+   * *   We recommend that you check the assignment every 2 to 5 seconds and perform the checks within 50 seconds. Typically, 1 to 5 seconds are required to complete the assignment.
+   * 
    * @param request - BatchModifyEntitlementRequest
    * @returns BatchModifyEntitlementResponse
    */
@@ -9282,6 +9292,146 @@ export default class Client extends OpenApi {
     return await this.describeGlobalDesktopRecordsWithOptions(request, runtime);
   }
 
+  /**
+   * 查询全局定时任务Batch记录
+   * 
+   * @param request - DescribeGlobalTimerBatchesRequest
+   * @param runtime - runtime options for this request RuntimeOptions
+   * @returns DescribeGlobalTimerBatchesResponse
+   */
+  async describeGlobalTimerBatchesWithOptions(request: $_model.DescribeGlobalTimerBatchesRequest, runtime: $dara.RuntimeOptions): Promise<$_model.DescribeGlobalTimerBatchesResponse> {
+    request.validate();
+    let query = { };
+    if (!$dara.isNull(request.groupId)) {
+      query["GroupId"] = request.groupId;
+    }
+
+    if (!$dara.isNull(request.maxResults)) {
+      query["MaxResults"] = request.maxResults;
+    }
+
+    if (!$dara.isNull(request.nextToken)) {
+      query["NextToken"] = request.nextToken;
+    }
+
+    if (!$dara.isNull(request.regionId)) {
+      query["RegionId"] = request.regionId;
+    }
+
+    if (!$dara.isNull(request.searchRegionId)) {
+      query["SearchRegionId"] = request.searchRegionId;
+    }
+
+    if (!$dara.isNull(request.timerType)) {
+      query["TimerType"] = request.timerType;
+    }
+
+    let req = new $OpenApiUtil.OpenApiRequest({
+      query: OpenApiUtil.query(query),
+    });
+    let params = new $OpenApiUtil.Params({
+      action: "DescribeGlobalTimerBatches",
+      version: "2020-09-30",
+      protocol: "HTTPS",
+      pathname: "/",
+      method: "POST",
+      authType: "AK",
+      style: "RPC",
+      reqBodyType: "formData",
+      bodyType: "json",
+    });
+    return $dara.cast<$_model.DescribeGlobalTimerBatchesResponse>(await this.callApi(params, req, runtime), new $_model.DescribeGlobalTimerBatchesResponse({}));
+  }
+
+  /**
+   * 查询全局定时任务Batch记录
+   * 
+   * @param request - DescribeGlobalTimerBatchesRequest
+   * @returns DescribeGlobalTimerBatchesResponse
+   */
+  async describeGlobalTimerBatches(request: $_model.DescribeGlobalTimerBatchesRequest): Promise<$_model.DescribeGlobalTimerBatchesResponse> {
+    let runtime = new $dara.RuntimeOptions({ });
+    return await this.describeGlobalTimerBatchesWithOptions(request, runtime);
+  }
+
+  /**
+   * Queries the execution records of scheduled tasks on cloud computers.
+   * 
+   * @param request - DescribeGlobalTimerRecordsRequest
+   * @param runtime - runtime options for this request RuntimeOptions
+   * @returns DescribeGlobalTimerRecordsResponse
+   */
+  async describeGlobalTimerRecordsWithOptions(request: $_model.DescribeGlobalTimerRecordsRequest, runtime: $dara.RuntimeOptions): Promise<$_model.DescribeGlobalTimerRecordsResponse> {
+    request.validate();
+    let query = { };
+    if (!$dara.isNull(request.batchId)) {
+      query["BatchId"] = request.batchId;
+    }
+
+    if (!$dara.isNull(request.desktopIds)) {
+      query["DesktopIds"] = request.desktopIds;
+    }
+
+    if (!$dara.isNull(request.groupId)) {
+      query["GroupId"] = request.groupId;
+    }
+
+    if (!$dara.isNull(request.maxResults)) {
+      query["MaxResults"] = request.maxResults;
+    }
+
+    if (!$dara.isNull(request.nextToken)) {
+      query["NextToken"] = request.nextToken;
+    }
+
+    if (!$dara.isNull(request.regionId)) {
+      query["RegionId"] = request.regionId;
+    }
+
+    if (!$dara.isNull(request.resultCategory)) {
+      query["ResultCategory"] = request.resultCategory;
+    }
+
+    if (!$dara.isNull(request.searchRegionId)) {
+      query["SearchRegionId"] = request.searchRegionId;
+    }
+
+    if (!$dara.isNull(request.timerResult)) {
+      query["TimerResult"] = request.timerResult;
+    }
+
+    if (!$dara.isNull(request.timerTypes)) {
+      query["TimerTypes"] = request.timerTypes;
+    }
+
+    let req = new $OpenApiUtil.OpenApiRequest({
+      query: OpenApiUtil.query(query),
+    });
+    let params = new $OpenApiUtil.Params({
+      action: "DescribeGlobalTimerRecords",
+      version: "2020-09-30",
+      protocol: "HTTPS",
+      pathname: "/",
+      method: "POST",
+      authType: "AK",
+      style: "RPC",
+      reqBodyType: "formData",
+      bodyType: "json",
+    });
+    return $dara.cast<$_model.DescribeGlobalTimerRecordsResponse>(await this.callApi(params, req, runtime), new $_model.DescribeGlobalTimerRecordsResponse({}));
+  }
+
+  /**
+   * Queries the execution records of scheduled tasks on cloud computers.
+   * 
+   * @param request - DescribeGlobalTimerRecordsRequest
+   * @returns DescribeGlobalTimerRecordsResponse
+   */
+  async describeGlobalTimerRecords(request: $_model.DescribeGlobalTimerRecordsRequest): Promise<$_model.DescribeGlobalTimerRecordsResponse> {
+    let runtime = new $dara.RuntimeOptions({ });
+    return await this.describeGlobalTimerRecordsWithOptions(request, runtime);
+  }
+
   /**
    * Queries the applications and their processes of an end user.
    * 
@@ -16771,6 +16921,10 @@ export default class Client extends OpenApi {
   /**
    * Modifies a custom cloud computer template.
    * 
+   * @remarks
+   * *
+   * **Warning** This operation employs the full parameter update logic to maintain compatibility between the no-configuration logic and the default update logic. In other words, any unspecified parameters are treated as empty.
+   * 
    * @param request - ModifyTemplateRequest
    * @param runtime - runtime options for this request RuntimeOptions
    * @returns ModifyTemplateResponse
@@ -16887,6 +17041,10 @@ export default class Client extends OpenApi {
   /**
    * Modifies a custom cloud computer template.
    * 
+   * @remarks
+   * *
+   * **Warning** This operation employs the full parameter update logic to maintain compatibility between the no-configuration logic and the default update logic. In other words, any unspecified parameters are treated as empty.
+   * 
    * @param request - ModifyTemplateRequest
    * @returns ModifyTemplateResponse
    */

package/src/models/BatchModifyEntitlementRequest.ts

@@ -5,27 +5,44 @@ import * as $dara from '@darabonba/typescript';
 export class BatchModifyEntitlementRequest extends $dara.Model {
   /**
    * @remarks
+   * The IDs of the cloud computers for which you want to modify end users.
+   * 
    * This parameter is required.
    */
   desktopId?: string[];
+  /**
+   * @remarks
+   * The IDs of the users.
+   */
   endUserId?: string[];
   /**
+   * @remarks
+   * The number of cloud computers allocated to each user.
+   * 
    * @example
    * 0
    */
   maxDesktopPerUser?: number;
   /**
+   * @remarks
+   * The number of users assigned to each cloud computer.
+   * 
    * @example
    * 1
    */
   maxUserPerDesktop?: number;
   /**
+   * @remarks
+   * Whether to preview the assign results instead of actually assigning cloud computers.
+   * 
    * @example
    * true
    */
   preview?: boolean;
   /**
    * @remarks
+   * The ID of the region. Call the DescribeRegions operation to query the list of regions where Elastic Desktop Service (EDS) Enterprise is available.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -33,6 +50,13 @@ export class BatchModifyEntitlementRequest extends $dara.Model {
    */
   regionId?: string;
   /**
+   * @remarks
+   * The disproportional assignment policy. Valid values:
+   * 
+   * AVERAGE: The system preferentially guarantees that each user is assigned with at least a cloud computer. If the number of selected cloud computers cannot be proportionally assigned to the selected users, ensure that each user is assigned a cloud computer.
+   * 
+   * CENTRAL: The system preferentially assigns the designated number of cloud computers to each user. If the number of selected cloud computers cannot be proportionally assigned to the selected users, ensure that each user is assigned the specified number of cloud computers.
+   * 
    * @example
    * AVERAGE
    */

package/src/models/BatchModifyEntitlementResponseBody.ts

@@ -4,12 +4,30 @@ import * as $dara from '@darabonba/typescript';
 
 export class BatchModifyEntitlementResponseBodyEntitlementsAssignModels extends $dara.Model {
   /**
+   * @remarks
+   * The cloud computer ID.
+   * 
    * @example
    * ecd-e94kzikmpljjx99pl
    */
   desktopId?: string;
+  /**
+   * @remarks
+   * The authorized user IDs for the cloud computer.
+   */
   endUserIds?: string[];
   /**
+   * @remarks
+   * The assign result for each cloud computer.
+   * 
+   * Valid values:
+   * 
+   * *   FAILED
+   * *   NOT_STARTED
+   * *   STARTED
+   * *   PROCESSING
+   * *   FINISHED
+   * 
    * @example
    * FINISHED
    */
@@ -45,11 +63,25 @@ export class BatchModifyEntitlementResponseBodyEntitlementsAssignModels extends
 export class BatchModifyEntitlementResponseBodyEntitlements extends $dara.Model {
   assignModels?: BatchModifyEntitlementResponseBodyEntitlementsAssignModels[];
   /**
+   * @remarks
+   * The result.
+   * 
+   * Valid values:
+   * 
+   * *   FAILED
+   * *   NOT_STARTED
+   * *   STARTED
+   * *   PROCESSING
+   * *   FINISHED
+   * 
    * @example
    * FINISHED
    */
   status?: string;
   /**
+   * @remarks
+   * The task ID.
+   * 
    * @example
    * B2F4F018-0EDF-159C-B285-117B5F1C****
    */
@@ -85,6 +117,9 @@ export class BatchModifyEntitlementResponseBodyEntitlements extends $dara.Model
 export class BatchModifyEntitlementResponseBody extends $dara.Model {
   entitlements?: BatchModifyEntitlementResponseBodyEntitlements;
   /**
+   * @remarks
+   * The request ID.
+   * 
    * @example
    * 51592A88-0F2C-55E6-AD2C-2AD9C10D****
    */

package/src/models/DescribeGlobalTimerBatchesRequest.ts

@@ -0,0 +1,66 @@
+// This file is auto-generated, don't edit it
+import * as $dara from '@darabonba/typescript';
+
+
+export class DescribeGlobalTimerBatchesRequest extends $dara.Model {
+  /**
+   * @example
+   * ccg-i1ruuudp92qpj****
+   */
+  groupId?: string;
+  /**
+   * @example
+   * 20
+   */
+  maxResults?: string;
+  /**
+   * @example
+   * caeba0bbb2be03f84eb48b699f0a4883
+   */
+  nextToken?: string;
+  /**
+   * @example
+   * cn-shanghai
+   */
+  regionId?: string;
+  /**
+   * @example
+   * cn-hangzhou
+   */
+  searchRegionId?: string;
+  /**
+   * @example
+   * 1
+   */
+  timerType?: string;
+  static names(): { [key: string]: string } {
+    return {
+      groupId: 'GroupId',
+      maxResults: 'MaxResults',
+      nextToken: 'NextToken',
+      regionId: 'RegionId',
+      searchRegionId: 'SearchRegionId',
+      timerType: 'TimerType',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      groupId: 'string',
+      maxResults: 'string',
+      nextToken: 'string',
+      regionId: 'string',
+      searchRegionId: 'string',
+      timerType: 'string',
+    };
+  }
+
+  validate() {
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+

package/src/models/DescribeGlobalTimerBatchesResponse.ts

@@ -0,0 +1,40 @@
+// This file is auto-generated, don't edit it
+import * as $dara from '@darabonba/typescript';
+import { DescribeGlobalTimerBatchesResponseBody } from "./DescribeGlobalTimerBatchesResponseBody";
+
+
+export class DescribeGlobalTimerBatchesResponse extends $dara.Model {
+  headers?: { [key: string]: string };
+  statusCode?: number;
+  body?: DescribeGlobalTimerBatchesResponseBody;
+  static names(): { [key: string]: string } {
+    return {
+      headers: 'headers',
+      statusCode: 'statusCode',
+      body: 'body',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      headers: { 'type': 'map', 'keyType': 'string', 'valueType': 'string' },
+      statusCode: 'number',
+      body: DescribeGlobalTimerBatchesResponseBody,
+    };
+  }
+
+  validate() {
+    if(this.headers) {
+      $dara.Model.validateMap(this.headers);
+    }
+    if(this.body && typeof (this.body as any).validate === 'function') {
+      (this.body as any).validate();
+    }
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+

package/src/models/DescribeGlobalTimerBatchesResponseBody.ts

@@ -0,0 +1,123 @@
+// This file is auto-generated, don't edit it
+import * as $dara from '@darabonba/typescript';
+
+
+export class DescribeGlobalTimerBatchesResponseBodyResults extends $dara.Model {
+  /**
+   * @example
+   * ccg-0cvfvf6u1enx1****
+   */
+  batchId?: string;
+  /**
+   * @example
+   * 2023-08-03T08:27:29Z
+   */
+  createTime?: string;
+  /**
+   * @example
+   * 0
+   */
+  failedCount?: number;
+  /**
+   * @example
+   * 0
+   */
+  runningCount?: number;
+  /**
+   * @example
+   * 0
+   */
+  skippedCount?: number;
+  /**
+   * @example
+   * 0
+   */
+  succeedCount?: number;
+  /**
+   * @example
+   * TimerBoot
+   */
+  timerType?: string;
+  static names(): { [key: string]: string } {
+    return {
+      batchId: 'BatchId',
+      createTime: 'CreateTime',
+      failedCount: 'FailedCount',
+      runningCount: 'RunningCount',
+      skippedCount: 'SkippedCount',
+      succeedCount: 'SucceedCount',
+      timerType: 'TimerType',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      batchId: 'string',
+      createTime: 'string',
+      failedCount: 'number',
+      runningCount: 'number',
+      skippedCount: 'number',
+      succeedCount: 'number',
+      timerType: 'string',
+    };
+  }
+
+  validate() {
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+
+export class DescribeGlobalTimerBatchesResponseBody extends $dara.Model {
+  /**
+   * @example
+   * 1
+   */
+  count?: number;
+  /**
+   * @example
+   * caeba0bbb2be03f84eb48b699f0a4883
+   */
+  nextToken?: string;
+  /**
+   * @remarks
+   * Id of the request
+   * 
+   * @example
+   * E54EB497-D7B7-5F04-B744-D8DFA7B******
+   */
+  requestId?: string;
+  results?: DescribeGlobalTimerBatchesResponseBodyResults[];
+  static names(): { [key: string]: string } {
+    return {
+      count: 'Count',
+      nextToken: 'NextToken',
+      requestId: 'RequestId',
+      results: 'Results',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      count: 'number',
+      nextToken: 'string',
+      requestId: 'string',
+      results: { 'type': 'array', 'itemType': DescribeGlobalTimerBatchesResponseBodyResults },
+    };
+  }
+
+  validate() {
+    if(Array.isArray(this.results)) {
+      $dara.Model.validateArray(this.results);
+    }
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+

package/src/models/DescribeGlobalTimerRecordsRequest.ts

@@ -0,0 +1,144 @@
+// This file is auto-generated, don't edit it
+import * as $dara from '@darabonba/typescript';
+
+
+export class DescribeGlobalTimerRecordsRequest extends $dara.Model {
+  /**
+   * @remarks
+   * The ID of the batch in which the scheduled task is executed.
+   * 
+   * @example
+   * ccg-****
+   */
+  batchId?: string;
+  /**
+   * @remarks
+   * The cloud computer IDs.
+   */
+  desktopIds?: string[];
+  /**
+   * @remarks
+   * The ID of the scheduled task group.
+   * 
+   * @example
+   * ccg-0cvfvf6u1enx1****
+   */
+  groupId?: string;
+  /**
+   * @remarks
+   * The number of entries per page.
+   * 
+   * Maximum value: 100.
+   * 
+   * Default value: 10.
+   * 
+   * @example
+   * 10
+   */
+  maxResults?: string;
+  /**
+   * @remarks
+   * The pagination token that is used in the next request to retrieve a new page of results.
+   * 
+   * @example
+   * AAAAAV3MpHK1AP0pfERHZN5pu6nmB7qrRFJ8vmttjxPL****
+   */
+  nextToken?: string;
+  /**
+   * @remarks
+   * The region ID. You can call the [DescribeRegions](~~DescribeRegions~~) operation to query the list of regions where Elastic Desktop Service (EDS) Enterprise is available.
+   * 
+   * @example
+   * cn-shanghai
+   */
+  regionId?: string;
+  /**
+   * @remarks
+   * The type of the execution result. You can specify this parameter to filter the execution results.
+   * 
+   * Valid values:
+   * 
+   * *   FAILED: The execution is successful.
+   * *   FAILED: The execution failed.
+   * *   RUNNING: The execution is in progress.
+   * *   SKIPPED: The execution is skipped.
+   * 
+   * @example
+   * SUCCEED
+   */
+  resultCategory?: string;
+  /**
+   * @remarks
+   * The ID of the searched region. You can specify this parameter to filter cloud computers in specific regions.
+   * 
+   * @example
+   * cn-shanghai
+   */
+  searchRegionId?: string;
+  /**
+   * @remarks
+   * The execution result of the scheduled task.
+   * 
+   * Valid values:
+   * 
+   * *   CONNECTED_NOT_RUN: The cloud computer is connected, but the scheduled task is not executed.
+   * *   PAUSED: The scheduled task is suspended.
+   * *   COMPLETED: The scheduled task is executed.
+   * *   FAILED: The scheduled task failed to be executed.
+   * *   RUNNING: The scheduled task is being executed.
+   * *   TERMINATED: The scheduled task is stopped.
+   * 
+   * @example
+   * RUNNING
+   */
+  timerResult?: string;
+  /**
+   * @remarks
+   * The scheduled tasks.
+   */
+  timerTypes?: string[];
+  static names(): { [key: string]: string } {
+    return {
+      batchId: 'BatchId',
+      desktopIds: 'DesktopIds',
+      groupId: 'GroupId',
+      maxResults: 'MaxResults',
+      nextToken: 'NextToken',
+      regionId: 'RegionId',
+      resultCategory: 'ResultCategory',
+      searchRegionId: 'SearchRegionId',
+      timerResult: 'TimerResult',
+      timerTypes: 'TimerTypes',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      batchId: 'string',
+      desktopIds: { 'type': 'array', 'itemType': 'string' },
+      groupId: 'string',
+      maxResults: 'string',
+      nextToken: 'string',
+      regionId: 'string',
+      resultCategory: 'string',
+      searchRegionId: 'string',
+      timerResult: 'string',
+      timerTypes: { 'type': 'array', 'itemType': 'string' },
+    };
+  }
+
+  validate() {
+    if(Array.isArray(this.desktopIds)) {
+      $dara.Model.validateArray(this.desktopIds);
+    }
+    if(Array.isArray(this.timerTypes)) {
+      $dara.Model.validateArray(this.timerTypes);
+    }
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+