@alicloud/ecd20201002 2.1.15 → 2.1.17

package/src/models/DescribeSnapshotsRequest.ts

@@ -5,6 +5,8 @@ import * as $dara from '@darabonba/typescript';
 export class DescribeSnapshotsRequest extends $dara.Model {
   /**
    * @remarks
+   * The client ID. The system generates a unique ID for each client.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -12,12 +14,17 @@ export class DescribeSnapshotsRequest extends $dara.Model {
    */
   clientId?: string;
   /**
+   * @remarks
+   * The cloud computer ID.
+   * 
    * @example
    * ecd-gx2x1dhsmucyy****
    */
   desktopId?: string;
   /**
    * @remarks
+   * The logon token.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -25,17 +32,25 @@ export class DescribeSnapshotsRequest extends $dara.Model {
    */
   loginToken?: string;
   /**
+   * @remarks
+   * The number of entries per page. Default value: 100.
+   * 
    * @example
    * 10
    */
   maxResults?: number;
   /**
+   * @remarks
+   * The pagination token that is used in the next request to retrieve a new page of results. You do not need to specify this parameter for the first request.
+   * 
    * @example
    * AAAAAV3MpHK1AP0pfERHZN5pu6nmB7qrRFJ8vmttjxPL****
    */
   nextToken?: string;
   /**
    * @remarks
+   * The region ID. You can call the [DescribeRegions](https://help.aliyun.com/document_detail/196646.html) operation to query the list of regions where Elastic Desktop Service (EDS) Enterprise is available.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -43,11 +58,17 @@ export class DescribeSnapshotsRequest extends $dara.Model {
    */
   regionId?: string;
   /**
+   * @remarks
+   * The session ID.
+   * 
    * @example
    * a99b9aca-bac5-4da2-819e-400ce98f****
    */
   sessionId?: string;
   /**
+   * @remarks
+   * The snapshot ID.
+   * 
    * @example
    * s-2ze81owrnv9pity4****
    */

package/src/models/DescribeSnapshotsResponseBody.ts

@@ -4,58 +4,121 @@ import * as $dara from '@darabonba/typescript';
 
 export class DescribeSnapshotsResponseBodySnapshots extends $dara.Model {
   /**
+   * @remarks
+   * The time when the snapshot was created. The time follows the [ISO 8601](https://help.aliyun.com/document_detail/25696.html) standard in the `yyyy-MM-ddTHH:mm:ssZ` format. The time is displayed in UTC.
+   * 
    * @example
    * 2020-12-20T14:52:28Z
    */
   creationTime?: string;
   /**
+   * @remarks
+   * The snapshot description.
+   * 
    * @example
    * testDescription
    */
   description?: string;
   /**
+   * @remarks
+   * The ID of the cloud computer to which the snapshot belongs.
+   * 
    * @example
    * ecd-g03l3tlm8djoj****
    */
   desktopId?: string;
   /**
+   * @remarks
+   * The progress of creating the cloud computer.
+   * 
    * @example
    * 100%
    */
   progress?: string;
   /**
+   * @remarks
+   * The remaining time required to complete snapshot creation. Unit: seconds.
+   * 
    * @example
    * 30
    */
   remainTime?: number;
+  /**
+   * @remarks
+   * The ID of the restore point.
+   * 
+   * @example
+   * rp-btgmaa20wkcju****
+   */
   restorePointId?: string;
+  /**
+   * @remarks
+   * The name of the restore point.
+   * 
+   * @example
+   * Data Disk Backup
+   */
   restorePointName?: string;
   /**
+   * @remarks
+   * The snapshot ID.
+   * 
    * @example
    * s-2zeipxmnhej803x7****
    */
   snapshotId?: string;
   /**
+   * @remarks
+   * The snapshot name.
+   * 
    * @example
    * testSnapshotName
    */
   snapshotName?: string;
   /**
+   * @remarks
+   * The snapshot type.
+   * 
+   * Valid values:
+   * 
+   * *   AUTO: an automatic snapshot.
+   * *   USER: a manual snapshot.
+   * 
    * @example
    * USER
    */
   snapshotType?: string;
   /**
+   * @remarks
+   * The size of the source disk. Unit: GiB.
+   * 
    * @example
    * 150
    */
   sourceDiskSize?: string;
   /**
+   * @remarks
+   * The type of the source disk.
+   * 
+   * Valid values:
+   * 
+   * *   SYSTEM: a system disk.
+   * *   DATA: a data disk.
+   * 
    * @example
    * SYSTEM
    */
   sourceDiskType?: string;
   /**
+   * @remarks
+   * The snapshot status.
+   * 
+   * Valid values:
+   * 
+   * *   PROGRESSING: The snapshot is being created.
+   * *   FAILED: The snapshot failed to be created.
+   * *   ACCOMPLISHED: The snapshot is created.
+   * 
    * @example
    * ACCOMPLISHED
    */
@@ -107,15 +170,25 @@ export class DescribeSnapshotsResponseBodySnapshots extends $dara.Model {
 
 export class DescribeSnapshotsResponseBody extends $dara.Model {
   /**
+   * @remarks
+   * A pagination token. It can be used in the next request to retrieve a new page of results.If NextToken is empty, no next page exists.
+   * 
    * @example
    * AAAAAV3MpHK1AP0pfERHZN5pu6nmB7qrRFJ8vmttjxPL****
    */
   nextToken?: string;
   /**
+   * @remarks
+   * The request ID.
+   * 
    * @example
    * 51592A88-0F2C-55E6-AD2C-2AD9C10D****
    */
   requestId?: string;
+  /**
+   * @remarks
+   * The snapshots.
+   */
   snapshots?: DescribeSnapshotsResponseBodySnapshots[];
   static names(): { [key: string]: string } {
     return {

package/src/models/DescribeUserResourcesRequest.ts

@@ -4,27 +4,53 @@ import * as $dara from '@darabonba/typescript';
 
 export class DescribeUserResourcesRequest extends $dara.Model {
   /**
+   * @remarks
+   * The access type. If you leave this parameter empty, both types will be displayed.
+   * 
+   * Valid values:
+   * 
+   * *   INTERNET: access over the Internet.
+   * *   VPC: access over an enterprise virtual private cloud (VPC).
+   * 
    * @example
    * INTERNET
    */
   accessType?: string;
   /**
+   * @remarks
+   * Specifies whether to enable the immediate refresh feature.
+   * 
+   * >  To ensure the operation response speed, we recommend that you set the value to `false`.
+   * 
+   * Valid values:
+   * 
+   * *   false
+   * *   true
+   * 
    * @example
    * false
    */
   autoRefresh?: boolean;
   /**
+   * @remarks
+   * The level-2 resource category.
+   * 
    * @example
    * 0
    */
   categoryId?: number;
   /**
+   * @remarks
+   * The level-1 resource category.
+   * 
    * @example
    * 1
    */
   categoryType?: number;
   /**
    * @remarks
+   * The client ID. The system generates a unique ID for each client. This parameter is non-sensitive and does not need encryption.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -32,16 +58,37 @@ export class DescribeUserResourcesRequest extends $dara.Model {
    */
   clientId?: string;
   /**
+   * @remarks
+   * The client type.
+   * 
+   * Valid values:
+   * 
+   * *   html5: the web client.
+   * *   android: the Android client.
+   * *   windows: the Windows client.
+   * *   ios: the iOS client.
+   * *   macos: the macOS client.
+   * 
    * @example
    * windows
    */
   clientType?: string;
   /**
+   * @remarks
+   * The client version.
+   * 
    * @example
    * 7.6.0-R-20241112.222305
    */
   clientVersion?: string;
   /**
+   * @remarks
+   * Specifies whether to enable geo-redundant forwarding. Set the value to `false`.
+   * 
+   * Valid value:
+   * 
+   * *   false: disables geo-redundant forwarding.
+   * 
    * @example
    * false
    * 
@@ -49,17 +96,31 @@ export class DescribeUserResourcesRequest extends $dara.Model {
    */
   dualCenterForward?: boolean;
   /**
+   * @remarks
+   * The client language.
+   * 
+   * Valid values:
+   * 
+   * *   en_US: English.
+   * *   zh_CN: Simplified Chinese.
+   * *   ja_JP: Japanese.
+   * 
    * @example
    * zh-CN
    */
   language?: string;
   /**
+   * @remarks
+   * The ID of the region where end users log on to clients. This parameter applies to office network ID-based logons. For organization ID-based logons, you can leave this parameter empty.
+   * 
    * @example
    * cn-hangzhou
    */
   loginRegionId?: string;
   /**
    * @remarks
+   * The logon token. You can call the `GetLoginToken` or `RefreshLoginToken` operation to retrieve the logon token.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -67,70 +128,150 @@ export class DescribeUserResourcesRequest extends $dara.Model {
    */
   loginToken?: string;
   /**
+   * @remarks
+   * The number of entries per page. Default value: 500.
+   * 
    * @example
    * 500
    */
   maxResults?: number;
   /**
+   * @remarks
+   * A pagination token. It can be used in the next request to retrieve a new page of results.
+   * 
    * @example
    * caeba0bbb2be03f84eb48b699f0a4883
    */
   nextToken?: string;
+  /**
+   * @remarks
+   * The office network IDs. This parameter is required for logons by using enterprise Active Directory (AD) accounts.
+   */
   officeSiteIds?: string[];
   /**
+   * @remarks
+   * The sorting field. If you do not specify this parameter, resources are sorted by creation time by default.
+   * 
+   * Valid values:
+   * 
+   * *   CreateTime: the time when resources are created.
+   * *   AssignTime: the time when resources are assigned.
+   * 
    * @example
    * AssignTime
    */
   orderBy?: string;
+  /**
+   * @remarks
+   * The service types. If you leave this parameter empty, services of all supported types will be queried.
+   */
   productTypes?: string[];
   /**
+   * @remarks
+   * The protocol type. You can specify this parameter to filter cloud computers.
+   * 
+   * Valid values:
+   * 
+   * *   HDX: High-definition Experience (HDX).
+   * *   ASP: Adaptive Streaming Protocol (ASP).
+   * 
    * @example
    * ASP
    */
   protocolType?: string;
   /**
+   * @remarks
+   * 是否查询云桌面套餐包信息，默认为true。
+   * 
+   * @example
+   * true
+   * 
    * **if can be null:**
    * true
    */
   queryDesktopDurationList?: boolean;
   /**
+   * @remarks
+   * 是否查询云电脑定时任务信息，默认为true。
+   * 
+   * @example
+   * true
+   * 
    * **if can be null:**
    * true
    */
   queryDesktopTimers?: boolean;
   /**
+   * @remarks
+   * Specifies whether to return the image version information of cloud computers.
+   * 
    * @example
    * false
    */
   queryFotaUpdate?: boolean;
   /**
+   * @remarks
+   * Specifies whether to refresh over-the-air (OTA) information in real time.
+   * 
    * @example
    * false
    */
   refreshFotaUpdate?: boolean;
+  /**
+   * @remarks
+   * The resource IDs. You can specify up to 100 resource IDs.
+   */
   resourceIds?: string[];
   /**
+   * @remarks
+   * The resource name. Fuzzy search is supported.
+   * 
    * @example
    * testName
    */
   resourceName?: string;
+  /**
+   * @remarks
+   * The resource types. If you leave this parameter empty, resources of all supported types will be queried.
+   */
   resourceTypes?: string[];
   /**
+   * @remarks
+   * The client usage scenario. Set the value to `desktop`.
+   * 
+   * Valid value:
+   * 
+   * *   desktop: cloud computers.
+   * 
    * @example
    * desktop
    */
   scene?: string;
   /**
+   * @remarks
+   * The ID of the searched region. You can specify this parameter to filter cloud resources in specific regions.
+   * 
    * @example
    * cn-hangzhou
    */
   searchRegionId?: string;
   /**
+   * @remarks
+   * The session ID. You can call the `GetLoginToken` operation to retrieve the session ID.
+   * 
    * @example
    * cd45e873-650d-4d70-acb9-f996187a****
    */
   sessionId?: string;
   /**
+   * @remarks
+   * The sorting method.
+   * 
+   * Valid values:
+   * 
+   * *   ASC (default): the ascending order.
+   * *   DESC: the descending order.
+   * 
    * @example
    * ASC
    */