@alicloud/ecd20200930 4.15.0 → 4.16.0

package/src/client.ts

@@ -971,6 +971,68 @@ export default class Client extends OpenApi {
     return await this.attachEndUserWithOptions(request, runtime);
   }
 
+  /**
+   * @param request - BatchModifyEntitlementRequest
+   * @param runtime - runtime options for this request RuntimeOptions
+   * @returns BatchModifyEntitlementResponse
+   */
+  async batchModifyEntitlementWithOptions(request: $_model.BatchModifyEntitlementRequest, runtime: $dara.RuntimeOptions): Promise<$_model.BatchModifyEntitlementResponse> {
+    request.validate();
+    let query = { };
+    if (!$dara.isNull(request.desktopId)) {
+      query["DesktopId"] = request.desktopId;
+    }
+
+    if (!$dara.isNull(request.endUserId)) {
+      query["EndUserId"] = request.endUserId;
+    }
+
+    if (!$dara.isNull(request.maxDesktopPerUser)) {
+      query["MaxDesktopPerUser"] = request.maxDesktopPerUser;
+    }
+
+    if (!$dara.isNull(request.maxUserPerDesktop)) {
+      query["MaxUserPerDesktop"] = request.maxUserPerDesktop;
+    }
+
+    if (!$dara.isNull(request.preview)) {
+      query["Preview"] = request.preview;
+    }
+
+    if (!$dara.isNull(request.regionId)) {
+      query["RegionId"] = request.regionId;
+    }
+
+    if (!$dara.isNull(request.strategy)) {
+      query["Strategy"] = request.strategy;
+    }
+
+    let req = new $OpenApiUtil.OpenApiRequest({
+      query: OpenApiUtil.query(query),
+    });
+    let params = new $OpenApiUtil.Params({
+      action: "BatchModifyEntitlement",
+      version: "2020-09-30",
+      protocol: "HTTPS",
+      pathname: "/",
+      method: "POST",
+      authType: "AK",
+      style: "RPC",
+      reqBodyType: "formData",
+      bodyType: "json",
+    });
+    return $dara.cast<$_model.BatchModifyEntitlementResponse>(await this.callApi(params, req, runtime), new $_model.BatchModifyEntitlementResponse({}));
+  }
+
+  /**
+   * @param request - BatchModifyEntitlementRequest
+   * @returns BatchModifyEntitlementResponse
+   */
+  async batchModifyEntitlement(request: $_model.BatchModifyEntitlementRequest): Promise<$_model.BatchModifyEntitlementResponse> {
+    let runtime = new $dara.RuntimeOptions({ });
+    return await this.batchModifyEntitlementWithOptions(request, runtime);
+  }
+
   /**
    * Binds a configuration group to resources.
    * 
@@ -2375,6 +2437,10 @@ export default class Client extends OpenApi {
       query["ClientControlMenu"] = request.clientControlMenu;
     }
 
+    if (!$dara.isNull(request.clientCreateSnapshot)) {
+      query["ClientCreateSnapshot"] = request.clientCreateSnapshot;
+    }
+
     if (!$dara.isNull(request.clientType)) {
       query["ClientType"] = request.clientType;
     }
@@ -2795,6 +2861,10 @@ export default class Client extends OpenApi {
       query["WatermarkSecurity"] = request.watermarkSecurity;
     }
 
+    if (!$dara.isNull(request.watermarkShadow)) {
+      query["WatermarkShadow"] = request.watermarkShadow;
+    }
+
     if (!$dara.isNull(request.watermarkTransparencyValue)) {
       query["WatermarkTransparencyValue"] = request.watermarkTransparencyValue;
     }
@@ -5066,6 +5136,11 @@ export default class Client extends OpenApi {
   /**
    * Creates a custom cloud computer template. A cloud computer template (or simply "template") simplifies the process of creating cloud computers by providing a predefined set of configurations. This eliminates the need to manually configure each setting, saving significant time and effort.
    * 
+   * @remarks
+   * When you call this operation, take note of the following item:
+   * *   Most parameters in templates are optional. When you create a template, Elastic Desktop Service (EDS) does not validate the existence or correctness of the parameter values you specify. The parameter values in the template are only verified when you use the template to create cloud computers.
+   * *   For parameters that include the region attribute in the template, it\\"s important to note that if the specified region doesn’t match the region where the template is used to create a cloud computer, those parameters will not take effect.
+   * 
    * @param request - CreateTemplateRequest
    * @param runtime - runtime options for this request RuntimeOptions
    * @returns CreateTemplateResponse
@@ -5186,6 +5261,11 @@ export default class Client extends OpenApi {
   /**
    * Creates a custom cloud computer template. A cloud computer template (or simply "template") simplifies the process of creating cloud computers by providing a predefined set of configurations. This eliminates the need to manually configure each setting, saving significant time and effort.
    * 
+   * @remarks
+   * When you call this operation, take note of the following item:
+   * *   Most parameters in templates are optional. When you create a template, Elastic Desktop Service (EDS) does not validate the existence or correctness of the parameter values you specify. The parameter values in the template are only verified when you use the template to create cloud computers.
+   * *   For parameters that include the region attribute in the template, it\\"s important to note that if the specified region doesn’t match the region where the template is used to create a cloud computer, those parameters will not take effect.
+   * 
    * @param request - CreateTemplateRequest
    * @returns CreateTemplateResponse
    */
@@ -12891,7 +12971,7 @@ export default class Client extends OpenApi {
   }
 
   /**
-   * 查询桌面内安装的应用
+   * Queries applications installed on a cloud computer.
    * 
    * @param request - ListInstalledAppsRequest
    * @param runtime - runtime options for this request RuntimeOptions
@@ -12930,7 +13010,7 @@ export default class Client extends OpenApi {
   }
 
   /**
-   * 查询桌面内安装的应用
+   * Queries applications installed on a cloud computer.
    * 
    * @param request - ListInstalledAppsRequest
    * @returns ListInstalledAppsResponse
@@ -14004,6 +14084,10 @@ export default class Client extends OpenApi {
       query["ClientControlMenu"] = request.clientControlMenu;
     }
 
+    if (!$dara.isNull(request.clientCreateSnapshot)) {
+      query["ClientCreateSnapshot"] = request.clientCreateSnapshot;
+    }
+
     if (!$dara.isNull(request.clientType)) {
       query["ClientType"] = request.clientType;
     }
@@ -14436,6 +14520,10 @@ export default class Client extends OpenApi {
       query["WatermarkSecurity"] = request.watermarkSecurity;
     }
 
+    if (!$dara.isNull(request.watermarkShadow)) {
+      query["WatermarkShadow"] = request.watermarkShadow;
+    }
+
     if (!$dara.isNull(request.watermarkTransparencyValue)) {
       query["WatermarkTransparencyValue"] = request.watermarkTransparencyValue;
     }

package/src/models/BatchModifyEntitlementRequest.ts

@@ -0,0 +1,78 @@
+// This file is auto-generated, don't edit it
+import * as $dara from '@darabonba/typescript';
+
+
+export class BatchModifyEntitlementRequest extends $dara.Model {
+  /**
+   * @remarks
+   * This parameter is required.
+   */
+  desktopId?: string[];
+  endUserId?: string[];
+  /**
+   * @example
+   * 0
+   */
+  maxDesktopPerUser?: number;
+  /**
+   * @example
+   * 1
+   */
+  maxUserPerDesktop?: number;
+  /**
+   * @example
+   * true
+   */
+  preview?: boolean;
+  /**
+   * @remarks
+   * This parameter is required.
+   * 
+   * @example
+   * cn-hangzhou
+   */
+  regionId?: string;
+  /**
+   * @example
+   * AVERAGE
+   */
+  strategy?: string;
+  static names(): { [key: string]: string } {
+    return {
+      desktopId: 'DesktopId',
+      endUserId: 'EndUserId',
+      maxDesktopPerUser: 'MaxDesktopPerUser',
+      maxUserPerDesktop: 'MaxUserPerDesktop',
+      preview: 'Preview',
+      regionId: 'RegionId',
+      strategy: 'Strategy',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      desktopId: { 'type': 'array', 'itemType': 'string' },
+      endUserId: { 'type': 'array', 'itemType': 'string' },
+      maxDesktopPerUser: 'number',
+      maxUserPerDesktop: 'number',
+      preview: 'boolean',
+      regionId: 'string',
+      strategy: 'string',
+    };
+  }
+
+  validate() {
+    if(Array.isArray(this.desktopId)) {
+      $dara.Model.validateArray(this.desktopId);
+    }
+    if(Array.isArray(this.endUserId)) {
+      $dara.Model.validateArray(this.endUserId);
+    }
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+

package/src/models/BatchModifyEntitlementResponse.ts

@@ -0,0 +1,40 @@
+// This file is auto-generated, don't edit it
+import * as $dara from '@darabonba/typescript';
+import { BatchModifyEntitlementResponseBody } from "./BatchModifyEntitlementResponseBody";
+
+
+export class BatchModifyEntitlementResponse extends $dara.Model {
+  headers?: { [key: string]: string };
+  statusCode?: number;
+  body?: BatchModifyEntitlementResponseBody;
+  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: BatchModifyEntitlementResponseBody,
+    };
+  }
+
+  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/BatchModifyEntitlementResponseBody.ts

@@ -0,0 +1,117 @@
+// This file is auto-generated, don't edit it
+import * as $dara from '@darabonba/typescript';
+
+
+export class BatchModifyEntitlementResponseBodyEntitlementsAssignModels extends $dara.Model {
+  /**
+   * @example
+   * ecd-e94kzikmpljjx99pl
+   */
+  desktopId?: string;
+  endUserIds?: string[];
+  /**
+   * @example
+   * FINISHED
+   */
+  innerStatus?: string;
+  static names(): { [key: string]: string } {
+    return {
+      desktopId: 'DesktopId',
+      endUserIds: 'EndUserIds',
+      innerStatus: 'InnerStatus',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      desktopId: 'string',
+      endUserIds: { 'type': 'array', 'itemType': 'string' },
+      innerStatus: 'string',
+    };
+  }
+
+  validate() {
+    if(Array.isArray(this.endUserIds)) {
+      $dara.Model.validateArray(this.endUserIds);
+    }
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+
+export class BatchModifyEntitlementResponseBodyEntitlements extends $dara.Model {
+  assignModels?: BatchModifyEntitlementResponseBodyEntitlementsAssignModels[];
+  /**
+   * @example
+   * FINISHED
+   */
+  status?: string;
+  /**
+   * @example
+   * B2F4F018-0EDF-159C-B285-117B5F1C****
+   */
+  taskId?: string;
+  static names(): { [key: string]: string } {
+    return {
+      assignModels: 'AssignModels',
+      status: 'Status',
+      taskId: 'TaskId',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      assignModels: { 'type': 'array', 'itemType': BatchModifyEntitlementResponseBodyEntitlementsAssignModels },
+      status: 'string',
+      taskId: 'string',
+    };
+  }
+
+  validate() {
+    if(Array.isArray(this.assignModels)) {
+      $dara.Model.validateArray(this.assignModels);
+    }
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+
+export class BatchModifyEntitlementResponseBody extends $dara.Model {
+  entitlements?: BatchModifyEntitlementResponseBodyEntitlements;
+  /**
+   * @example
+   * 51592A88-0F2C-55E6-AD2C-2AD9C10D****
+   */
+  requestId?: string;
+  static names(): { [key: string]: string } {
+    return {
+      entitlements: 'Entitlements',
+      requestId: 'RequestId',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      entitlements: BatchModifyEntitlementResponseBodyEntitlements,
+      requestId: 'string',
+    };
+  }
+
+  validate() {
+    if(this.entitlements && typeof (this.entitlements as any).validate === 'function') {
+      (this.entitlements as any).validate();
+    }
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+

package/src/models/CreateCenterPolicyRequest.ts

@@ -689,6 +689,7 @@ export class CreateCenterPolicyRequest extends $dara.Model {
    */
   cameraRedirect?: string;
   clientControlMenu?: string;
+  clientCreateSnapshot?: string;
   /**
    * @remarks
    * The types of Alibaba Cloud Workspace clients that end users can use to connect to cloud computers.
@@ -1636,6 +1637,7 @@ export class CreateCenterPolicyRequest extends $dara.Model {
    * on
    */
   watermarkSecurity?: string;
+  watermarkShadow?: string;
   /**
    * @remarks
    * The watermark opacity. A higher value makes the watermark more opaque. Valid values: 10 to 100.
@@ -1696,6 +1698,7 @@ export class CreateCenterPolicyRequest extends $dara.Model {
       businessType: 'BusinessType',
       cameraRedirect: 'CameraRedirect',
       clientControlMenu: 'ClientControlMenu',
+      clientCreateSnapshot: 'ClientCreateSnapshot',
       clientType: 'ClientType',
       clipboard: 'Clipboard',
       clipboardGraineds: 'ClipboardGraineds',
@@ -1801,6 +1804,7 @@ export class CreateCenterPolicyRequest extends $dara.Model {
       watermarkPower: 'WatermarkPower',
       watermarkRowAmount: 'WatermarkRowAmount',
       watermarkSecurity: 'WatermarkSecurity',
+      watermarkShadow: 'WatermarkShadow',
       watermarkTransparencyValue: 'WatermarkTransparencyValue',
       watermarkType: 'WatermarkType',
       wuyingKeeper: 'WuyingKeeper',
@@ -1818,6 +1822,7 @@ export class CreateCenterPolicyRequest extends $dara.Model {
       businessType: 'number',
       cameraRedirect: 'string',
       clientControlMenu: 'string',
+      clientCreateSnapshot: 'string',
       clientType: { 'type': 'array', 'itemType': CreateCenterPolicyRequestClientType },
       clipboard: 'string',
       clipboardGraineds: { 'type': 'array', 'itemType': CreateCenterPolicyRequestClipboardGraineds },
@@ -1923,6 +1928,7 @@ export class CreateCenterPolicyRequest extends $dara.Model {
       watermarkPower: 'string',
       watermarkRowAmount: 'number',
       watermarkSecurity: 'string',
+      watermarkShadow: 'string',
       watermarkTransparencyValue: 'number',
       watermarkType: 'string',
       wuyingKeeper: 'string',

package/src/models/CreateTemplateRequest.ts

@@ -4,11 +4,21 @@ import * as $dara from '@darabonba/typescript';
 
 export class CreateTemplateRequestDataDiskList extends $dara.Model {
   /**
+   * @remarks
+   * The PL of the data disk. Default value: `AutoPL`.
+   * 
    * @example
    * AutoPL
    */
   performanceLevel?: string;
   /**
+   * @remarks
+   * The size of the data disk. Unit: GiB. Valid values: 40 to 2040. Increments: 10 GiB.
+   * 
+   * **
+   * 
+   * **Keep in mind** that the larger the ESSD disk capacity, the higher the available PL (for example, PL2 is available for disks larger than 460 GiB). A higher PL comes with a higher cost. Select an ESSD based on your specific needs.
+   * 
    * @example
    * 40
    */
@@ -38,36 +48,62 @@ export class CreateTemplateRequestDataDiskList extends $dara.Model {
 
 export class CreateTemplateRequestRegionConfigList extends $dara.Model {
   /**
+   * @remarks
+   * The office network ID.
+   * 
    * @example
    * cn-hangzhou+dir-709******
    */
   officeSiteId?: 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-hangzhou
    */
   regionId?: string;
   /**
+   * @remarks
+   * The ID of the cloud computer type.
+   * 
    * @example
    * eds.enterprise_office.8c16g
    */
   resourceInstanceType?: string;
   /**
+   * @remarks
+   * The ID of the automatic snapshot policy.
+   * 
    * @example
    * sp-35fvn8m21pnx2****
    */
   snapshotPolicyId?: string;
   /**
+   * @remarks
+   * The subnet ID.
+   * 
    * @example
    * vsw-bp1yiu**********
    */
   subnetId?: string;
   /**
+   * @remarks
+   * Specifies whether to enable disk encryption.
+   * 
+   * Valid values:
+   * 
+   * *   false (default): disables disk encryption.
+   * *   true: enables disk encryption.
+   * 
    * @example
    * false
    */
   volumeEncryptionEnable?: boolean;
   /**
+   * @remarks
+   * The ID of the Key Management Service (KMS) key that you want to use to encrypt disks. You can call the [ListKeys](https://help.aliyun.com/document_detail/28951.html) operation to query KMS keys.
+   * 
    * @example
    * a7b3c0c8-b3a2-4876-b1cc-*********
    */
@@ -107,11 +143,17 @@ export class CreateTemplateRequestRegionConfigList extends $dara.Model {
 
 export class CreateTemplateRequestResourceTagList extends $dara.Model {
   /**
+   * @remarks
+   * The tag key.
+   * 
    * @example
    * department
    */
   key?: string;
   /**
+   * @remarks
+   * The tag value.
+   * 
    * @example
    * design
    */
@@ -141,11 +183,17 @@ export class CreateTemplateRequestResourceTagList extends $dara.Model {
 
 export class CreateTemplateRequestSiteConfigList extends $dara.Model {
   /**
+   * @remarks
+   * 应用管控策略ID
+   * 
    * @example
    * bwr-5a5371e0db954d********
    */
   appRuleId?: string;
   /**
+   * @remarks
+   * 站点ID。
+   * 
    * @example
    * mainland
    */
@@ -177,19 +225,43 @@ export class CreateTemplateRequest extends $dara.Model {
   autoPay?: boolean;
   autoRenew?: boolean;
   /**
+   * @remarks
+   * >  This parameter is not publicly available.
+   * 
+   * Valid values:
+   * 
+   * *   1: the Enterprise edition.
+   * 
    * @example
    * 1
    */
   bizType?: string;
   chargeType?: string;
+  /**
+   * @remarks
+   * The data disks.
+   */
   dataDiskList?: CreateTemplateRequestDataDiskList[];
   /**
+   * @remarks
+   * The default language of cloud computers during startup. This parameter takes effect only when cloud computers are created from system images.
+   * 
    * @example
    * zh-CN
    */
   defaultLanguage?: string;
+  /**
+   * @remarks
+   * The template description. It must meet the following criteria:
+   * 
+   * *   It can be 2 to 256 characters in length and cannot start with `http://` or `https://`.
+   * *   It can contain letters, digits, and special characters, including spaces. Note: You can use carriage returns to break lines.
+   */
   description?: string;
   /**
+   * @remarks
+   * The ID of the cloud computer image. You can query image IDs on the Images page. System images and custom images are supported.
+   * 
    * @example
    * desktopimage-windows-server-2022-64-asp
    */
@@ -197,40 +269,90 @@ export class CreateTemplateRequest extends $dara.Model {
   period?: number;
   periodUnit?: string;
   /**
+   * @remarks
+   * The ID of the policy group.
+   * 
    * @example
    * pg-8hlryfn331******
    */
   policyGroupId?: string;
   postPaidAfterUsedUp?: boolean;
   /**
+   * @remarks
+   * The service type. Set the value to `CloudDesktop`.
+   * 
+   * *
+   * 
    * @example
    * CloudDesktop
    */
   productType?: string;
+  /**
+   * @remarks
+   * The regions of the template. You can create cloud computers by using a template only within the same region as the template itself.
+   * 
+   * >  You can specify up to 20 regions.
+   */
   regionConfigList?: CreateTemplateRequestRegionConfigList[];
   /**
+   * @remarks
+   * The ID of the resource group.
+   * 
    * @example
    * rg-4knxmfneq1e******
    */
   resourceGroupId?: string;
+  /**
+   * @remarks
+   * The tags added to cloud computers. Specify tags in key-value pairs. You can specify up to 20 tags.
+   */
   resourceTagList?: CreateTemplateRequestResourceTagList[];
+  /**
+   * @remarks
+   * 区域配置管理
+   */
   siteConfigList?: CreateTemplateRequestSiteConfigList[];
   /**
+   * @remarks
+   * The performance level (PL) of the system disk.
+   * 
+   * >  Only cloud computers of the Graphics or High Frequency type support Enterprise SSDs (ESSDs).
+   * 
+   * Valid values:
+   * 
+   * *   PL1: a PL1 ESSD.
+   * *   PL0: a PL0 ESSD.
+   * *   AutoPL: an AutoPL ESSD.
+   * 
    * @example
    * AutoPL
    */
   systemDiskPerformanceLevel?: string;
   /**
+   * @remarks
+   * The size of the system disk. Unit: GiB. Valid values: 40 to 500. Increments: 10 GiB.
+   * 
+   * >  The system disk size must be at least as large as the configured image size.
+   * 
    * @example
    * 80
    */
   systemDiskSize?: number;
   /**
    * @remarks
+   * The template name. It must meet the following criteria:
+   * 
+   * *   It can be 2 to 126 characters in length.
+   * *   It must begin with a letter and cannot start with `http://` or `https://`.
+   * *   It can contain letters, digits, colons (:), underscores (_), and hyphens (-). Note: Periods (.) are not supported in the name.
+   * 
    * This parameter is required.
    */
   templateName?: string;
   /**
+   * @remarks
+   * The ID of the scheduled task group.
+   * 
    * @example
    * ccg-0caoeogrk9m5****
    */