@alicloud/ecd20201002 2.1.17 → 3.0.0

package/src/models/GetCloudDriveServiceMountTokenRequest.ts

@@ -4,26 +4,41 @@ import * as $dara from '@darabonba/typescript';
 
 export class GetCloudDriveServiceMountTokenRequest extends $dara.Model {
   /**
+   * @remarks
+   * Unique ID generated by the client.
+   * 
    * @example
    * 00e122c3-13fb-4fc3-bc7a-5d9acb89****
    */
   clientId?: string;
   /**
+   * @remarks
+   * Logon credential.
+   * 
    * @example
    * v1972cd3446f0e523598916520951742474e6624fcdea6652994d47bc6157d27f7cc900c339db67882j3no4nh5bk3b4****
    */
   loginToken?: string;
   /**
+   * @remarks
+   * Office Network ID.
+   * 
    * @example
    * cn-hangzhou+dir-7186763****
    */
   officeSiteId?: string;
   /**
+   * @remarks
+   * Region ID.
+   * 
    * @example
    * cn-hangzhou
    */
   regionId?: string;
   /**
+   * @remarks
+   * Session ID.
+   * 
    * @example
    * 14e1fe41-ce9b-491d-aa8c-345jk2n4bk****
    */

package/src/models/GetCloudDriveServiceMountTokenResponseBody.ts

@@ -4,16 +4,25 @@ import * as $dara from '@darabonba/typescript';
 
 export class GetCloudDriveServiceMountTokenResponseBodyToken extends $dara.Model {
   /**
+   * @remarks
+   * Enterprise File Gateway domain name.
+   * 
    * @example
    * h****
    */
   domainId?: string;
   /**
+   * @remarks
+   * Expiration Time.
+   * 
    * @example
    * 2022-10-10T04:41:35Z
    */
   expiredAfter?: string;
   /**
+   * @remarks
+   * Current status of the Enterprise File Gateway user.
+   * 
    * @example
    * enabled
    */
@@ -35,6 +44,9 @@ export class GetCloudDriveServiceMountTokenResponseBodyToken extends $dara.Model
    */
   totalSize?: number;
   /**
+   * @remarks
+   * Used capacity. Unit: GiB.
+   * 
    * @example
    * 605089
    */
@@ -72,6 +84,9 @@ export class GetCloudDriveServiceMountTokenResponseBodyToken extends $dara.Model
 
 export class GetCloudDriveServiceMountTokenResponseBody extends $dara.Model {
   /**
+   * @remarks
+   * Request ID.
+   * 
    * @example
    * DC27288A-F9E1-5092-9B5B-71C27D15****
    */

package/src/models/GetConnectionTicketRequest.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class GetConnectionTicketRequestTag extends $dara.Model {
   /**
    * @remarks
-   * The tag key. If you specify the `Tag` parameter, you must also specify the `Key` parameter. The tag key can be up to 128 characters in length and cannot contain `http://` or `https://`. The tag key cannot start with `acs:` or `aliyun` and contain only spaces.
+   * The tag key. If you specify `Tag`, `Key` is required. The key cannot exceed 128 characters in length. It cannot start with `aliyun` or `acs:`, contain `http://` or `https://`, or consist of only spaces.
    * 
    * @example
    * TestKey
@@ -13,7 +13,7 @@ export class GetConnectionTicketRequestTag extends $dara.Model {
   key?: string;
   /**
    * @remarks
-   * The tag value. You can specify an empty string as a tag value. A tag value can be up to 128 characters in length and cannot start with `acs:`. It cannot contain `http://` or `https://`.
+   * The tag value. The value can be an empty string. It can be up to 128 characters in length. It cannot start with `acs:` or contain `http://` or `https://`.
    * 
    * @example
    * TestValue
@@ -46,6 +46,8 @@ export class GetConnectionTicketRequest extends $dara.Model {
   accessType?: string;
   /**
    * @remarks
+   * A unique ID generated by the client.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -53,33 +55,37 @@ export class GetConnectionTicketRequest extends $dara.Model {
    */
   clientId?: string;
   /**
+   * @remarks
+   * The client operating system.
+   * 
    * @example
    * Windows_NT 10.0.18363 x64
    */
   clientOS?: string;
   /**
    * @remarks
-   * The type of the client.
-   * 
-   * Valid values:
-   * 
-   * *   html5: web client
-   * *   Linux: self-developed hardware terminal
-   * *   android: Android client
-   * *   windows: Windows client
-   * *   ios: iOS client
-   * *   macos: macOS client
+   * The client type.
    * 
    * @example
    * windows
    */
   clientType?: string;
   /**
+   * @remarks
+   * The client version.
+   * 
    * @example
    * 2.1.0-R-20210731.151756
    */
   clientVersion?: string;
   /**
+   * @remarks
+   * This parameter lets you configure a custom user-mode application. After a ticket is obtained, the application is automatically run.
+   * 
+   * - appPath: A string that specifies the path of the application startup file. For example, `"C:\\Program Files (x86)\\000\\000.exe"`. Note: Use double backslashes (\\) as separators.
+   * 
+   * - appParameter: A string that specifies the startup parameters of the application. For example, `"meetingid 000 meetingname aaa"`. Note: Use spaces to separate parameters.
+   * 
    * @example
    * {
    *       "startApplication": {
@@ -100,7 +106,7 @@ export class GetConnectionTicketRequest extends $dara.Model {
   commandContent?: string;
   /**
    * @remarks
-   * The cloud compute ID.
+   * The cloud computer ID.
    * 
    * @example
    * ecd-gx2x1dhsmucyy****
@@ -108,6 +114,8 @@ export class GetConnectionTicketRequest extends $dara.Model {
   desktopId?: string;
   /**
    * @remarks
+   * The logon credential. Call GetLoginToken to obtain this credential.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -117,7 +125,7 @@ export class GetConnectionTicketRequest extends $dara.Model {
   ownerId?: number;
   /**
    * @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.
+   * The region ID. Call [](t2223508.xdita#)to get a list of regions that Elastic Desktop Service (EDS) supports.
    * 
    * This parameter is required.
    * 
@@ -128,19 +136,21 @@ export class GetConnectionTicketRequest extends $dara.Model {
   resourceOwnerAccount?: string;
   resourceOwnerId?: number;
   /**
+   * @remarks
+   * The session ID. Call GetLoginToken to obtain this ID.
+   * 
    * @example
    * cd45e873-650d-4d70-acb9-f996187a****
    */
   sessionId?: string;
   /**
    * @remarks
-   * The tags. You can specify 1 to 20 tags.
+   * A list of tags. You can include 1 to 20 tags.
    */
   tag?: GetConnectionTicketRequestTag[];
   /**
    * @remarks
-   * The ID of the cloud computer connection task.\\
-   * The first time you call the GetConnectionTicket operation, you do not need to configure this parameter. When you call the GetConnectionTicket operation later, set this parameter to the value of the `TaskId` parameter returned from the previous invocation.
+   * The ID of the cloud computer connection task.<br>Do not specify this parameter in your first call. For subsequent calls, set this parameter to the `TaskId` returned from the previous call.<br>
    * 
    * @example
    * 2afbad19-778a-4fc5-9674-1f19c638****
@@ -148,6 +158,9 @@ export class GetConnectionTicketRequest extends $dara.Model {
   taskId?: string;
   ticketBlackList?: string[];
   /**
+   * @remarks
+   * The unique identifier of the client. If you use a Alibaba Cloud Workspace client, find this parameter in the **About** dialog box on the logon screen.
+   * 
    * @example
    * 28c80e90-f71e-4c23-93d6-1225329cf949
    */

package/src/models/GetConnectionTicketResponseBody.ts

@@ -6,36 +6,60 @@ export class GetConnectionTicketResponseBody extends $dara.Model {
   desktopId?: string;
   p2PToken?: string;
   /**
+   * @remarks
+   * The request ID.
+   * 
    * @example
    * 1CBAFFAB-B697-4049-A9B1-67E1FC5F****
    */
   requestId?: string;
   /**
+   * @remarks
+   * The ticket used to connect to the user instance. Before you use the ticket, decode its content from Base64, save it as an .ica file, and then open the file. The following code provides a Python example:
+   * 
+   * ```
+   * import base64
+   * response = {
+   *     "Ticket": "W0VuY29kaW5nXQ0KSW5wdXRFbmNvZGluZz1V********",
+   *     "RequestId": "1CBAFFAB-B697-4049-A9B1-67E1FC5F****",
+   * }
+   * f = open (\\"xxx.ica\\", \\"w\\")
+   * out = base64.b64decode(response[\\"Ticket\\"])
+   * f.write(out)
+   * f.close()
+   * ```
+   * 
    * @example
    * W0VuY29kaW5nXQ0KSW5wdXRFbmNvZGluZz1V********
    */
   taskCode?: string;
   /**
    * @remarks
-   * The ID of the task to connect to the cloud computer.
+   * The ID of the cloud computer connection task.
    * 
    * @example
    * 2afbad19-778a-4fc5-9674-1f19c63862da
    */
   taskId?: string;
   /**
+   * @remarks
+   * The ID of the cloud computer connection task.
+   * 
    * @example
    * 2afbad19-778a-4fc5-9674-1f19c638****
    */
   taskMessage?: string;
   /**
+   * @remarks
+   * The task status.
+   * 
    * @example
    * FINISHED
    */
   taskStatus?: string;
   /**
    * @remarks
-   * The credentials for connecting to the cloud computer.
+   * The connection ticket for the cloud computer.
    * 
    * @example
    * W0VuY29kaW5nXQ0KSW5wdXRFbmNvZGluZz1V********

package/src/models/GetLoginTokenRequest.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class GetLoginTokenRequest extends $dara.Model {
   /**
    * @remarks
-   * The verification code that is generated by the virtual MFA device. This parameter is required if you set `CurrentStage` to `MFAVerify`.
+   * The security code generated by the virtual MFA device. This parameter is required when `CurrentStage` is set to `MFAVerify`.
    * 
    * @example
    * 47****
@@ -14,7 +14,7 @@ export class GetLoginTokenRequest extends $dara.Model {
   availableFeatures?: { [key: string]: string };
   /**
    * @remarks
-   * The ID of the Alibaba Cloud Workspace client. The system generates a unique ID for each client.
+   * The unique ID generated by the client.
    * 
    * This parameter is required.
    * 
@@ -25,50 +25,38 @@ export class GetLoginTokenRequest extends $dara.Model {
   clientName?: string;
   /**
    * @remarks
-   * The operating system (OS) of the device that runs an Alibaba Cloud Workspace client.
+   * The operating system of the device on which the client runs.
    * 
    * @example
-   * Windows_NT 10.0.1**** x64
+   * Windows_NT 10.0.18363 x64
    */
   clientOS?: string;
   /**
    * @remarks
-   * The type of Alibaba Cloud Workspace clients.
-   * 
-   * Valid values:
-   * 
-   * *   HTML5: web client.
-   * 
-   * *   WINDOWS: Windows client.
-   * 
-   * *   MACOS: macOS client.
-   * 
-   * *   IOS: iOS client.
-   * 
-   * *   ANDROID: Android client.
+   * The type of the Elastic Desktop Service software client.
    * 
    * @example
-   * Windows
+   * WINDOWS
    */
   clientType?: string;
   /**
    * @remarks
-   * The version of the client. When you use an Alibaba Cloud Workspace client, you can view the client version in the **About** dialog box on the client logon page.
+   * The client version. If you use the Elastic Desktop Service client, you can view this parameter in the **About** dialog box on the client logon page.
    * 
    * @example
-   * 2.1.0-R-20210731.1****
+   * 2.1.0-R-20210731.151756
    */
   clientVersion?: string;
   /**
    * @remarks
-   * The logon authentication stage. Valid values:
+   * The current logon authentication stage. The stages are as follows:
    * 
-   * *   `ADPassword`: the stage to verify the identity of the Active Directory (AD) user. You must specify the value when the system verifies the identity of a convenience account or an AD account.
-   * *   `MFABind: the stage to bind a virtual multi-factor authentication (MFA) device.`
-   * *   `MFAVerify: the stage to verify the verification code that is generated by the virtual MFA device.`
-   * *   `TokenVerify`: the stage to perform two-factor authentication on an Alibaba Cloud Workspace client (hereinafter referred to as the client).
-   * *   `ChangePassword`: the stage to change the password of the user.
-   * *   `KeepAliveVerify`: the stage to obtain LoginToken if KeepAliveToken is valid.
+   * - `ADPassword`: verifies user information. Specify this value when authenticating with the credentials of a convenience account or an AD account.
+   * - `MFABind`: binds a virtual MFA device.
+   * - `MFAVerify`: verifies the security code generated by the virtual MFA device.
+   * - `TokenVerify`: performs client secondary authentication.
+   * - `ChangePassword`: changes the user password.
+   * - `KeepAliveVerify`: exchanges a valid KeepAliveToken for a LoginToken.
    * 
    * @example
    * ADPassword
@@ -76,7 +64,7 @@ export class GetLoginTokenRequest extends $dara.Model {
   currentStage?: string;
   /**
    * @remarks
-   * The office network ID. This parameter has the same meaning as `OfficeSiteId`. We recommend that you replace `DirectoryId` with `OfficeSiteId`. You can specify a value for `DirectoryId` or `OfficeSiteId`.
+   * The office network ID, which has the same meaning as `OfficeSiteId`. We recommend that you stop using `DirectoryId` and use `OfficeSiteId` instead. You can specify only one of `DirectoryId` and `OfficeSiteId`, not both.
    * 
    * @example
    * cn-hangzhou+dir-885351****
@@ -84,7 +72,7 @@ export class GetLoginTokenRequest extends $dara.Model {
   directoryId?: string;
   /**
    * @remarks
-   * The name of the convenience user or the AD user. This parameter is required if you set `CurrentStage` to `ADPassword`.
+   * The username of the convenience user or AD user. This parameter is required when `CurrentStage` is set to `ADPassword`.
    * 
    * @example
    * alice
@@ -92,11 +80,7 @@ export class GetLoginTokenRequest extends $dara.Model {
   endUserId?: string;
   /**
    * @remarks
-   * Specifies whether to keep the user logged on to the client. 
-   * Valid values:
-   * * null: Default value. Do not keep the user logged on to the client.
-   * * true: Keep the user logged on to the client.
-   * * false:  Do not keep the user logged on to the client.
+   * Specifies whether to keep the logon session alive.
    * 
    * @example
    * false
@@ -104,7 +88,7 @@ export class GetLoginTokenRequest extends $dara.Model {
   keepAlive?: boolean;
   /**
    * @remarks
-   * The token to keep logging on to an Alibaba Cloud Workspace client. When an end user logs on to the Alibaba Cloud Workspace client and select Auto Sign-in, `KeepAliveToken` is returned after you call this operation. Within the valid period of the returned token``, you can call the `GetLoginToken` operation and set `CurrentStage` to `KeepAliveVerify`. Then, you can obtain LoginToken. If you set `CurrentStage` to `KeepAliveVerify`, `KeepAliveToken` is required.
+   * The token used to keep the logon session alive. After a successful logon with the keep-alive option enabled, the operation returns a `KeepAliveToken`. While the `KeepAliveToken` is valid, you can call the `GetLoginToken` operation with `CurrentStage` set to `KeepAliveVerify` to exchange it for a logon credential (LoginToken). This parameter is required when `CurrentStage` is set to `KeepAliveVerify`.
    * 
    * @example
    * hide
@@ -112,7 +96,7 @@ export class GetLoginTokenRequest extends $dara.Model {
   keepAliveToken?: string;
   /**
    * @remarks
-   * The new password. This parameter is required if you set `CurrentStage` to `ChangePassword`.
+   * The new password. This parameter is required when `CurrentStage` is set to `ChangePassword`.
    * 
    * @example
    * NewPassword
@@ -128,7 +112,7 @@ export class GetLoginTokenRequest extends $dara.Model {
   officeSiteId?: string;
   /**
    * @remarks
-   * The current password. This parameter is required if you set `CurrentStage` to `ChangePassword`.
+   * The old password. This parameter is required when `CurrentStage` is set to `ChangePassword`.
    * 
    * @example
    * OldPassword
@@ -136,7 +120,7 @@ export class GetLoginTokenRequest extends $dara.Model {
   oldPassword?: string;
   /**
    * @remarks
-   * The password of the convenience user or the AD user. This parameter is required if you set `CurrentStage` to `ADPassword`.
+   * The password of the convenience user or AD user. This parameter is required when `CurrentStage` is set to `ADPassword`.
    * 
    * @example
    * Password1234
@@ -144,7 +128,7 @@ export class GetLoginTokenRequest extends $dara.Model {
   password?: string;
   /**
    * @remarks
-   * The region ID. You can call the [DescribeRegions](https://help.aliyun.com/document_detail/196646.html) operation to query the regions supported by EDS.
+   * The region ID. You can call [DescribeRegions](https://help.aliyun.com/document_detail/196646.html) to query the regions supported by Elastic Desktop Service.
    * 
    * This parameter is required.
    * 
@@ -154,10 +138,10 @@ export class GetLoginTokenRequest extends $dara.Model {
   regionId?: string;
   /**
    * @remarks
-   * The ID of the session.
+   * The session ID for logon.
    * 
-   * *   If the virtual multi-factor authentication (MFA) device is not bound or two-factor authentication is not enabled for the client, you do not need to specify a value for `SessionId`.
-   * *   If the virtual MFA device is not bound or two-factor authentication is enabled for the client, you must specify a value for `SessionId` to verify the user identity after you specify a value for `ADPassword`. The value of the `SessionId` parameter is returned only if the CurrentStage parameter is set to `ADPassword` when you call the `GetLoginToken` operation.
+   * - If no virtual MFA device is bound or client secondary authentication is not enabled, you do not need to specify `SessionId`.
+   * - If a virtual MFA device is bound or client secondary authentication is enabled, you must specify `SessionId` for the authentication stages after `ADPassword`. You can obtain `SessionId` from the response of the convenience account verification (when the `GetLoginToken` request is in the `ADPassword` stage).
    * 
    * @example
    * cd45e873-650d-4d70-acb9-f996187a****
@@ -165,7 +149,7 @@ export class GetLoginTokenRequest extends $dara.Model {
   sessionId?: string;
   /**
    * @remarks
-   * If two-factor authentication is enabled for Alibaba Cloud Workspace terminals in the EDS console and the system detects that the current logon user is exposed to risks, the system sends a verification code to the email address of the user. This parameter is required if you set `CurrentStage` to `TokenVerify`.
+   * If client secondary authentication is enabled in the Elastic Desktop Service console and the current logon user is identified as risky, a secondary authentication verification code is sent to the end user\\"s email address. This parameter is required when `CurrentStage` is set to `TokenVerify`.
    * 
    * @example
    * 63****
@@ -173,7 +157,7 @@ export class GetLoginTokenRequest extends $dara.Model {
   tokenCode?: string;
   /**
    * @remarks
-   * The unique identifier of the client. When you use an Alibaba Cloud Workspace client, you can view the client version in the **About** dialog box on the client logon page.
+   * The unique identifier of the client. If you use the Elastic Desktop Service client, you can view this parameter in the **About** dialog box on the client logon page.
    * 
    * @example
    * C78CA9E99315687575DD2844C1F3****