@alicloud/ecd20201002 2.1.17 → 3.0.0

package/src/models/DescribeGlobalDesktopsRequest.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class DescribeGlobalDesktopsRequest extends $dara.Model {
   /**
    * @remarks
-   * The unique ID generated by the client.
+   * A unique ID generated by the client.
    * 
    * This parameter is required.
    * 
@@ -15,15 +15,9 @@ export class DescribeGlobalDesktopsRequest extends $dara.Model {
   clientId?: string;
   /**
    * @remarks
-   * The method that is used to connect cloud computers that reside in the office network from WUYING clients.
+   * Connection type allowed when connecting to the cloud desktop.
    * 
-   * >  The VPC connection method depends on Alibaba Cloud PrivateLink. You can use PrivateLink for free. If you set this parameter to VPC or Any, the system automatically enables PrivateLink.
-   * 
-   * Valid values:
-   * 
-   * *   INTERNET (default): End users connect to cloud computers from clients over the Internet.
-   * *   VPC: End users connect to cloud computers from clients over a virtual private cloud (VPC).
-   * *   Any: End users connect to cloud computers from clients over the Internet or a VPC.
+   * > VPC connections depend on Alibaba Cloud PrivateLink, which incurs no additional charges. When you set this parameter to VPC or Any, PrivateLink is automatically enabled for you.
    * 
    * @example
    * INTERNET
@@ -31,12 +25,12 @@ export class DescribeGlobalDesktopsRequest extends $dara.Model {
   desktopAccessType?: string;
   /**
    * @remarks
-   * The cloud computer ID. You can specify one or more cloud computer IDs. Valid values: 1 to 20.
+   * Cloud desktop ID. You can specify one or more IDs. Valid values: 1 to 20.
    */
   desktopId?: string[];
   /**
    * @remarks
-   * The cloud computer name.
+   * Cloud desktop name.
    * 
    * @example
    * DesktopTest
@@ -44,18 +38,7 @@ export class DescribeGlobalDesktopsRequest extends $dara.Model {
   desktopName?: string;
   /**
    * @remarks
-   * The cloud computer status.
-   * 
-   * Valid value:
-   * 
-   * *   Stopped
-   * *   Starting.
-   * *   Rebuilding
-   * *   Running:.
-   * *   Stopping:.
-   * *   Expired
-   * *   Deleted
-   * *   Pending: The resource is still being prepared.
+   * Cloud desktop status.
    * 
    * @example
    * Running
@@ -63,9 +46,9 @@ export class DescribeGlobalDesktopsRequest extends $dara.Model {
   desktopStatus?: string;
   /**
    * @remarks
-   * The office network IDs.
+   * Office site ID.
    * 
-   * >  This parameter is about to be disabled. Use `OfficeSiteId`.
+   * > This parameter is deprecated. Use `OfficeSiteId` instead.
    * 
    * @example
    * cn-hangzhou+dir-880841****
@@ -73,7 +56,7 @@ export class DescribeGlobalDesktopsRequest extends $dara.Model {
   directoryId?: string;
   /**
    * @remarks
-   * The keyword. Fuzzy search is supported for cloud computer IDs, cloud computer names, and end user custom cloud computer names.
+   * Keyword. Supports fuzzy search on cloud desktop ID, cloud desktop name, and end-user-defined cloud desktop names.
    * 
    * @example
    * ecd
@@ -82,10 +65,11 @@ export class DescribeGlobalDesktopsRequest extends $dara.Model {
   language?: string;
   /**
    * @remarks
-   * The ID of the region where the office network resides. This parameter is left empty when you log on with an organization ID.
+   * Region ID of the office site. Leave this blank if you log on using an organization ID.
+   * 
+   * - Required if you log on using an office site ID.
    * 
-   * *   This parameter is required when you log on by using the office network ID.
-   * *   If you log on by using an organization ID, this parameter can be left empty.
+   * - Optional if you log on using an organization ID.
    * 
    * @example
    * cn-hangzhou
@@ -93,7 +77,7 @@ export class DescribeGlobalDesktopsRequest extends $dara.Model {
   loginRegionId?: string;
   /**
    * @remarks
-   * The logon token. You can call the GetLoginToken operation to obtain the token. You can also call the UpdateToken operation to obtain the token RefreshLoginToken. Response parameter: LoginToken.
+   * Login token. Get it by calling GetLoginToken, or refresh it by calling RefreshLoginToken. The response includes the LoginToken parameter.
    * 
    * This parameter is required.
    * 
@@ -103,10 +87,11 @@ export class DescribeGlobalDesktopsRequest extends $dara.Model {
   loginToken?: string;
   /**
    * @remarks
-   * The number of entries per page.
+   * Number of entries per page for paged queries.
+   * 
+   * - Maximum: 500
    * 
-   * *   Maximum value: 500.
-   * *   and the default value is 10.
+   * - Default: 10
    * 
    * @example
    * 500
@@ -114,7 +99,7 @@ export class DescribeGlobalDesktopsRequest extends $dara.Model {
   maxResults?: number;
   /**
    * @remarks
-   * The token used to start the next query. If NextToken is empty, it indicates that there is no next query.
+   * Token that marks the start of the next query. If NextToken is empty, no more results are available.
    * 
    * @example
    * eyJkZWZhdWx0IjpbIjk2MjEy****
@@ -122,9 +107,9 @@ export class DescribeGlobalDesktopsRequest extends $dara.Model {
   nextToken?: string;
   /**
    * @remarks
-   * The office network IDs.
+   * Office site ID.
    * 
-   * >  `DirectoryId` the parameter is about to be retired, use this field.
+   * > Use this field instead of `DirectoryId`, which is deprecated.
    * 
    * @example
    * cn-hangzhou+dir-880841****
@@ -132,11 +117,7 @@ export class DescribeGlobalDesktopsRequest extends $dara.Model {
   officeSiteId?: string;
   /**
    * @remarks
-   * The field used for sorting. If you do not specify this option, the system is sorted in descending order of creation time.
-   * 
-   * Valid values:
-   * 
-   * *   AssignTime: sort by allocation time.
+   * Field to sort by. If not specified, results are sorted by creation time in descending order.
    * 
    * @example
    * AssignTime
@@ -144,7 +125,7 @@ export class DescribeGlobalDesktopsRequest extends $dara.Model {
   orderBy?: string;
   /**
    * @remarks
-   * Specifies whether to query information about the image update.
+   * Whether to query image update information.
    * 
    * @example
    * true
@@ -152,11 +133,7 @@ export class DescribeGlobalDesktopsRequest extends $dara.Model {
   queryFotaUpdate?: boolean;
   /**
    * @remarks
-   * The region ID.
-   * 
-   * Valid value:
-   * 
-   * *   cn-shanghai: China (Shanghai)
+   * Region ID.
    * 
    * @example
    * cn-shanghai
@@ -164,7 +141,7 @@ export class DescribeGlobalDesktopsRequest extends $dara.Model {
   regionId?: string;
   /**
    * @remarks
-   * The ID of the searched region. You can specify this parameter to filter cloud computers in specific regions.
+   * Region ID used to filter cloud desktops by region.
    * 
    * @example
    * cn-shanghai
@@ -172,7 +149,7 @@ export class DescribeGlobalDesktopsRequest extends $dara.Model {
   searchRegionId?: string;
   /**
    * @remarks
-   * The session ID. You can call the GetLoginToken operation to query the value of the SessionId parameter.
+   * Session ID. Get it by calling the GetLoginToken operation. The response includes the SessionId parameter.
    * 
    * @example
    * 5c456a41-1e65-4e72-ab4d-5dcfff52****
@@ -180,12 +157,7 @@ export class DescribeGlobalDesktopsRequest extends $dara.Model {
   sessionId?: string;
   /**
    * @remarks
-   * The sorting method.
-   * 
-   * Valid values:
-   * 
-   * *   ASC (default): the ascending order.
-   * *   DESC: the descending order.
+   * Sorting order.
    * 
    * @example
    * ASC
@@ -193,7 +165,7 @@ export class DescribeGlobalDesktopsRequest extends $dara.Model {
   sortType?: string;
   /**
    * @remarks
-   * Whether to query real-time cloud computer information. The cloud computer status information in the current interface has a delay of 1 to 3 seconds. If you need accurate information, set this value to `true`.
+   * Whether to query real-time cloud desktop information. Because cloud desktop status has a 1–3 second delay, set this value to `true` for accurate information.
    * 
    * @example
    * true