@alicloud/ecd20201002 2.1.15 → 2.1.16

package/dist/models/VerifyCredentialResponseBody.d.ts

@@ -1,6 +1,9 @@
 import * as $dara from '@darabonba/typescript';
 export declare class VerifyCredentialResponseBody extends $dara.Model {
     /**
+     * @remarks
+     * The request ID.
+     *
      * @example
      * D5F0BDFB-A229-5F1D-B790-33709D43****
      */

package/dist/models/VerifyCredentialResponseBody.js.map

@@ -1 +1 @@
-{"version":3,"file":"VerifyCredentialResponseBody.js","sourceRoot":"","sources":["../../src/models/VerifyCredentialResponseBody.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,6CAA6C;AAC7C,6DAA+C;AAG/C,MAAa,4BAA6B,SAAQ,KAAK,CAAC,KAAK;IAM3D,MAAM,CAAC,KAAK;QACV,OAAO;YACL,SAAS,EAAE,WAAW;SACvB,CAAC;IACJ,CAAC;IAED,MAAM,CAAC,KAAK;QACV,OAAO;YACL,SAAS,EAAE,QAAQ;SACpB,CAAC;IACJ,CAAC;IAED,QAAQ;QACN,KAAK,CAAC,QAAQ,EAAE,CAAC;IACnB,CAAC;IAED,YAAY,GAA4B;QACtC,KAAK,CAAC,GAAG,CAAC,CAAC;IACb,CAAC;CACF;AAzBD,oEAyBC"}
+{"version":3,"file":"VerifyCredentialResponseBody.js","sourceRoot":"","sources":["../../src/models/VerifyCredentialResponseBody.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,6CAA6C;AAC7C,6DAA+C;AAG/C,MAAa,4BAA6B,SAAQ,KAAK,CAAC,KAAK;IAS3D,MAAM,CAAC,KAAK;QACV,OAAO;YACL,SAAS,EAAE,WAAW;SACvB,CAAC;IACJ,CAAC;IAED,MAAM,CAAC,KAAK;QACV,OAAO;YACL,SAAS,EAAE,QAAQ;SACpB,CAAC;IACJ,CAAC;IAED,QAAQ;QACN,KAAK,CAAC,QAAQ,EAAE,CAAC;IACnB,CAAC;IAED,YAAY,GAA4B;QACtC,KAAK,CAAC,GAAG,CAAC,CAAC;IACb,CAAC;CACF;AA5BD,oEA4BC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@alicloud/ecd20201002",
-  "version": "2.1.15",
+  "version": "2.1.16",
   "description": "",
   "main": "dist/client.js",
   "scripts": {

package/src/client.ts

@@ -30,7 +30,7 @@ export default class Client extends OpenApi {
   }
 
   /**
-   * 允许桌面FOTA升级
+   * Enables OTA updates for cloud computers.
    * 
    * @param request - ApproveFotaUpdateRequest
    * @param runtime - runtime options for this request RuntimeOptions
@@ -89,7 +89,7 @@ export default class Client extends OpenApi {
   }
 
   /**
-   * 允许桌面FOTA升级
+   * Enables OTA updates for cloud computers.
    * 
    * @param request - ApproveFotaUpdateRequest
    * @returns ApproveFotaUpdateResponse
@@ -332,6 +332,12 @@ export default class Client extends OpenApi {
   }
 
   /**
+   * Queries the details of cloud computers. Currently, only the region corresponding to the Chinese mainland can be queried (excluding: Nanjing-local region-shutting down).
+   * 
+   * @remarks
+   *   This API is a centralized domain name. The endpoint is in the China (Shanghai) region. You cannot call this API operation in other regions.
+   * *   The cloud computer status information in this interface has a delay of 1 to 3 seconds from the actual value.
+   * 
    * @param request - DescribeGlobalDesktopsRequest
    * @param runtime - runtime options for this request RuntimeOptions
    * @returns DescribeGlobalDesktopsResponse
@@ -437,6 +443,12 @@ export default class Client extends OpenApi {
   }
 
   /**
+   * Queries the details of cloud computers. Currently, only the region corresponding to the Chinese mainland can be queried (excluding: Nanjing-local region-shutting down).
+   * 
+   * @remarks
+   *   This API is a centralized domain name. The endpoint is in the China (Shanghai) region. You cannot call this API operation in other regions.
+   * *   The cloud computer status information in this interface has a delay of 1 to 3 seconds from the actual value.
+   * 
    * @param request - DescribeGlobalDesktopsRequest
    * @returns DescribeGlobalDesktopsResponse
    */
@@ -446,6 +458,8 @@ export default class Client extends OpenApi {
   }
 
   /**
+   * Queries office networks.
+   * 
    * @param request - DescribeOfficeSitesRequest
    * @param runtime - runtime options for this request RuntimeOptions
    * @returns DescribeOfficeSitesResponse
@@ -465,6 +479,10 @@ export default class Client extends OpenApi {
       query["RegionId"] = request.regionId;
     }
 
+    if (!$dara.isNull(request.uuid)) {
+      query["Uuid"] = request.uuid;
+    }
+
     let req = new $OpenApiUtil.OpenApiRequest({
       query: OpenApiUtil.query(query),
     });
@@ -483,6 +501,8 @@ export default class Client extends OpenApi {
   }
 
   /**
+   * Queries office networks.
+   * 
    * @param request - DescribeOfficeSitesRequest
    * @returns DescribeOfficeSitesResponse
    */
@@ -534,7 +554,7 @@ export default class Client extends OpenApi {
   }
 
   /**
-   * 列举快照
+   * Queries the snapshots that are created based on a cloud computer and the details of the snapshots.
    * 
    * @param request - DescribeSnapshotsRequest
    * @param runtime - runtime options for this request RuntimeOptions
@@ -593,7 +613,7 @@ export default class Client extends OpenApi {
   }
 
   /**
-   * 列举快照
+   * Queries the snapshots that are created based on a cloud computer and the details of the snapshots.
    * 
    * @param request - DescribeSnapshotsRequest
    * @returns DescribeSnapshotsResponse
@@ -604,7 +624,10 @@ export default class Client extends OpenApi {
   }
 
   /**
-   * 查询用户资源列表
+   * Queries user resources.
+   * 
+   * @remarks
+   * Before you call this operation, verify supported resource and service types in Alibaba Cloud Workspace.
    * 
    * @param request - DescribeUserResourcesRequest
    * @param runtime - runtime options for this request RuntimeOptions
@@ -743,7 +766,10 @@ export default class Client extends OpenApi {
   }
 
   /**
-   * 查询用户资源列表
+   * Queries user resources.
+   * 
+   * @remarks
+   * Before you call this operation, verify supported resource and service types in Alibaba Cloud Workspace.
    * 
    * @param request - DescribeUserResourcesRequest
    * @returns DescribeUserResourcesResponse
@@ -820,7 +846,7 @@ export default class Client extends OpenApi {
   }
 
   /**
-   * 获取无影云盘的免密token
+   * Retrieves the logon tokens for enterprise drives.
    * 
    * @param request - GetCloudDriveServiceMountTokenRequest
    * @param runtime - runtime options for this request RuntimeOptions
@@ -867,7 +893,7 @@ export default class Client extends OpenApi {
   }
 
   /**
-   * 获取无影云盘的免密token
+   * Retrieves the logon tokens for enterprise drives.
    * 
    * @param request - GetCloudDriveServiceMountTokenRequest
    * @returns GetCloudDriveServiceMountTokenResponse
@@ -878,7 +904,10 @@ export default class Client extends OpenApi {
   }
 
   /**
-   * 获得连接凭证
+   * Retrieves the credential that is used to connect to a cloud computer.
+   * 
+   * @remarks
+   * The first time you call this operation, the system returns a task ID in the `TaskID` parameter. Use the task ID indicated in the `TaskID` parameter to continue calling this operation until the value of the `TaskStatus` parameter becomes `FINISHED` or `FAILED`. When `TaskStatus` becomes `FINISHED`, the value of the `Ticket` parameter is the ticket that is used to connect the client to the cloud computer.
    * 
    * @param request - GetConnectionTicketRequest
    * @param runtime - runtime options for this request RuntimeOptions
@@ -947,6 +976,10 @@ export default class Client extends OpenApi {
       query["TaskId"] = request.taskId;
     }
 
+    if (!$dara.isNull(request.ticketBlackList)) {
+      query["TicketBlackList"] = request.ticketBlackList;
+    }
+
     if (!$dara.isNull(request.uuid)) {
       query["Uuid"] = request.uuid;
     }
@@ -969,7 +1002,10 @@ export default class Client extends OpenApi {
   }
 
   /**
-   * 获得连接凭证
+   * Retrieves the credential that is used to connect to a cloud computer.
+   * 
+   * @remarks
+   * The first time you call this operation, the system returns a task ID in the `TaskID` parameter. Use the task ID indicated in the `TaskID` parameter to continue calling this operation until the value of the `TaskStatus` parameter becomes `FINISHED` or `FAILED`. When `TaskStatus` becomes `FINISHED`, the value of the `Ticket` parameter is the ticket that is used to connect the client to the cloud computer.
    * 
    * @param request - GetConnectionTicketRequest
    * @returns GetConnectionTicketResponse
@@ -1104,7 +1140,7 @@ export default class Client extends OpenApi {
   }
 
   /**
-   * 是否保持登录判断接口
+   * Verifies whether the client\\"s logon session is still active.
    * 
    * @param request - IsKeepAliveRequest
    * @param runtime - runtime options for this request RuntimeOptions
@@ -1143,7 +1179,7 @@ export default class Client extends OpenApi {
   }
 
   /**
-   * 是否保持登录判断接口
+   * Verifies whether the client\\"s logon session is still active.
    * 
    * @param request - IsKeepAliveRequest
    * @returns IsKeepAliveResponse
@@ -2160,6 +2196,8 @@ export default class Client extends OpenApi {
   }
 
   /**
+   * Validates credentials to lock on-premises sessions on clients.
+   * 
    * @param request - VerifyCredentialRequest
    * @param runtime - runtime options for this request RuntimeOptions
    * @returns VerifyCredentialResponse
@@ -2217,6 +2255,8 @@ export default class Client extends OpenApi {
   }
 
   /**
+   * Validates credentials to lock on-premises sessions on clients.
+   * 
    * @param request - VerifyCredentialRequest
    * @returns VerifyCredentialResponse
    */

package/src/models/ApproveFotaUpdateRequest.ts

@@ -5,6 +5,8 @@ import * as $dara from '@darabonba/typescript';
 export class ApproveFotaUpdateRequest extends $dara.Model {
   /**
    * @remarks
+   * The application version.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -13,6 +15,8 @@ export class ApproveFotaUpdateRequest extends $dara.Model {
   appVersion?: string;
   /**
    * @remarks
+   * The client ID. The system generates a unique ID for each client.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -20,12 +24,17 @@ export class ApproveFotaUpdateRequest extends $dara.Model {
    */
   clientId?: string;
   /**
+   * @remarks
+   * The cloud computer ID.
+   * 
    * @example
    * ecd-138dsptkrt00u****
    */
   desktopId?: string;
   /**
    * @remarks
+   * The logon token.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -34,6 +43,8 @@ export class ApproveFotaUpdateRequest extends $dara.Model {
   loginToken?: string;
   /**
    * @remarks
+   * The region ID.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -41,11 +52,32 @@ export class ApproveFotaUpdateRequest extends $dara.Model {
    */
   regionId?: string;
   /**
+   * @remarks
+   * The session ID.
+   * 
    * @example
    * 4771b873-c757-4893-973c-7f5beejh****
    */
   sessionId?: string;
+  /**
+   * @remarks
+   * The state of the cloud computer after the OTA update.
+   * 
+   * >  This parameter is not publicly available. After the OTA update is complete, the state of the cloud computer changes to `RUNNING`.
+   * 
+   * *   Set the value to running.
+   * 
+   * @example
+   * running
+   */
   targetStatus?: string;
+  /**
+   * @remarks
+   * The unique identifier of the client. To view the unique identifier of an Alibaba Cloud Workspace client, go to the client logon page and click on "About."
+   * 
+   * @example
+   * 28c80e90-f71e-4c23-93d6-1225329c****
+   */
   uuid?: string;
   static names(): { [key: string]: string } {
     return {

package/src/models/ApproveFotaUpdateResponseBody.ts

@@ -4,6 +4,9 @@ import * as $dara from '@darabonba/typescript';
 
 export class ApproveFotaUpdateResponseBody extends $dara.Model {
   /**
+   * @remarks
+   * The request ID.
+   * 
    * @example
    * 1CBAFFAB-B697-4049-A9B1-67E1FC5F****
    */

package/src/models/DeleteFingerPrintTemplateRequest.ts

@@ -5,6 +5,8 @@ import * as $dara from '@darabonba/typescript';
 export class DeleteFingerPrintTemplateRequest 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 DeleteFingerPrintTemplateRequest extends $dara.Model {
    */
   clientId?: string;
   /**
+   * @remarks
+   * The client token to ensure the idempotence of the request. You can use the client to generate the value, but you ensure sure that the value is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length. For more information, see [How to ensure idempotence](https://help.aliyun.com/document_detail/25693.html).
+   * 
    * @example
    * 40401e62-5caf-4508-8de7-bf98af12****
    */
   clientToken?: string;
   /**
    * @remarks
+   * The index.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -26,6 +33,8 @@ export class DeleteFingerPrintTemplateRequest extends $dara.Model {
   index?: number;
   /**
    * @remarks
+   * The logon token.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -34,6 +43,8 @@ export class DeleteFingerPrintTemplateRequest extends $dara.Model {
   loginToken?: string;
   /**
    * @remarks
+   * The region ID.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -42,6 +53,8 @@ export class DeleteFingerPrintTemplateRequest extends $dara.Model {
   regionId?: string;
   /**
    * @remarks
+   * The session ID.
+   * 
    * This parameter is required.
    * 
    * @example

package/src/models/DeleteFingerPrintTemplateResponseBody.ts

@@ -4,6 +4,9 @@ import * as $dara from '@darabonba/typescript';
 
 export class DeleteFingerPrintTemplateResponseBody extends $dara.Model {
   /**
+   * @remarks
+   * The request ID.
+   * 
    * @example
    * 134BD0B2-B848-5743-9CE2-C1FD3D5F****
    */

package/src/models/DescribeGlobalDesktopsRequest.ts

@@ -5,6 +5,8 @@ import * as $dara from '@darabonba/typescript';
 export class DescribeGlobalDesktopsRequest extends $dara.Model {
   /**
    * @remarks
+   * The unique ID generated by the client.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -12,29 +14,66 @@ 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.
+   * 
+   * >  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.
+   * 
    * @example
    * INTERNET
    */
   desktopAccessType?: string;
+  /**
+   * @remarks
+   * The cloud computer ID. You can specify one or more cloud computer IDs. Valid values: 1 to 20.
+   */
   desktopId?: string[];
   /**
+   * @remarks
+   * The cloud computer name.
+   * 
    * @example
    * DesktopTest
    */
   desktopName?: string;
   /**
+   * @remarks
+   * The cloud computer status.
+   * 
+   * Valid value:
+   * 
+   * *   Stopped
+   * *   Starting.
+   * *   Rebuilding
+   * *   Running:.
+   * *   Stopping:.
+   * *   Expired
+   * *   Deleted
+   * *   Pending: The resource is still being prepared.
+   * 
    * @example
    * Running
    */
   desktopStatus?: string;
   /**
+   * @remarks
+   * The office network IDs.
+   * 
+   * >  This parameter is about to be disabled. Use `OfficeSiteId`.
+   * 
    * @example
    * cn-hangzhou+dir-880841****
    */
   directoryId?: string;
   /**
    * @remarks
-   * 关键字。支持模糊搜索桌面ID、云桌面名称和终端用户自定义的桌面名称。
+   * The keyword. Fuzzy search is supported for cloud computer IDs, cloud computer names, and end user custom cloud computer names.
    * 
    * @example
    * ecd
@@ -42,12 +81,20 @@ export class DescribeGlobalDesktopsRequest extends $dara.Model {
   keyword?: string;
   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.
+   * 
+   * *   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.
+   * 
    * @example
    * cn-hangzhou
    */
   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.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -55,51 +102,99 @@ export class DescribeGlobalDesktopsRequest extends $dara.Model {
    */
   loginToken?: string;
   /**
+   * @remarks
+   * The number of entries per page.
+   * 
+   * *   Maximum value: 500.
+   * *   and the default value is 10.
+   * 
    * @example
    * 500
    */
   maxResults?: number;
   /**
+   * @remarks
+   * The token used to start the next query. If NextToken is empty, it indicates that there is no next query.
+   * 
    * @example
    * eyJkZWZhdWx0IjpbIjk2MjEy****
    */
   nextToken?: string;
   /**
+   * @remarks
+   * The office network IDs.
+   * 
+   * >  `DirectoryId` the parameter is about to be retired, use this field.
+   * 
    * @example
    * cn-hangzhou+dir-880841****
    */
   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.
+   * 
    * @example
    * AssignTime
    */
   orderBy?: string;
   /**
+   * @remarks
+   * Specifies whether to query information about the image update.
+   * 
    * @example
    * true
    */
   queryFotaUpdate?: boolean;
   /**
+   * @remarks
+   * The region ID.
+   * 
+   * Valid value:
+   * 
+   * *   cn-shanghai: China (Shanghai)
+   * 
    * @example
    * cn-shanghai
    */
   regionId?: 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 session ID. You can call the GetLoginToken operation to query the value of the SessionId parameter.
+   * 
    * @example
    * 5c456a41-1e65-4e72-ab4d-5dcfff52****
    */
   sessionId?: string;
   /**
+   * @remarks
+   * The sorting method.
+   * 
+   * Valid values:
+   * 
+   * *   ASC (default): the ascending order.
+   * *   DESC: the descending order.
+   * 
    * @example
    * ASC
    */
   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`.
+   * 
    * @example
    * true
    */