@alicloud/ecd20201002 3.0.0 → 3.0.1

package/dist/client.d.ts

@@ -9,7 +9,7 @@ export default class Client extends OpenApi {
         [key: string]: string;
     }, endpoint: string): string;
     /**
-     * Enables OTA updates for cloud computers.
+     * Allows over-the-air updates for cloud computers.
      *
      * @param request - ApproveFotaUpdateRequest
      * @param runtime - runtime options for this request RuntimeOptions
@@ -17,14 +17,14 @@ export default class Client extends OpenApi {
      */
     approveFotaUpdateWithOptions(request: $_model.ApproveFotaUpdateRequest, runtime: $dara.RuntimeOptions): Promise<$_model.ApproveFotaUpdateResponse>;
     /**
-     * Enables OTA updates for cloud computers.
+     * Allows over-the-air updates for cloud computers.
      *
      * @param request - ApproveFotaUpdateRequest
      * @returns ApproveFotaUpdateResponse
      */
     approveFotaUpdate(request: $_model.ApproveFotaUpdateRequest): Promise<$_model.ApproveFotaUpdateResponse>;
     /**
-     * Changes the password of a user account.
+     * Modifies the password of a user.
      *
      * @param request - ChangePasswordRequest
      * @param runtime - runtime options for this request RuntimeOptions
@@ -32,19 +32,23 @@ export default class Client extends OpenApi {
      */
     changePasswordWithOptions(request: $_model.ChangePasswordRequest, runtime: $dara.RuntimeOptions): Promise<$_model.ChangePasswordResponse>;
     /**
-     * Changes the password of a user account.
+     * Modifies the password of a user.
      *
      * @param request - ChangePasswordRequest
      * @returns ChangePasswordResponse
      */
     changePassword(request: $_model.ChangePasswordRequest): Promise<$_model.ChangePasswordResponse>;
     /**
+     * Deletes a specified fingerprint template.
+     *
      * @param request - DeleteFingerPrintTemplateRequest
      * @param runtime - runtime options for this request RuntimeOptions
      * @returns DeleteFingerPrintTemplateResponse
      */
     deleteFingerPrintTemplateWithOptions(request: $_model.DeleteFingerPrintTemplateRequest, runtime: $dara.RuntimeOptions): Promise<$_model.DeleteFingerPrintTemplateResponse>;
     /**
+     * Deletes a specified fingerprint template.
+     *
      * @param request - DeleteFingerPrintTemplateRequest
      * @returns DeleteFingerPrintTemplateResponse
      */
@@ -80,11 +84,11 @@ export default class Client extends OpenApi {
      */
     describeFingerPrintTemplates(request: $_model.DescribeFingerPrintTemplatesRequest): Promise<$_model.DescribeFingerPrintTemplatesResponse>;
     /**
-     * Query detailed information about cloud desktops across multiple regions. You can query only regions in the Chinese mainland (excluding Nanjing – Local Region – Shutting Down).
+     * Queries the details of cloud computers in multiple regions. Currently, only regions in the Chinese mainland are supported.
      *
      * @remarks
-     * - This API uses a centralized domain name with its endpoint in Shanghai. You cannot call this API from other regions.
-     * - The cloud desktop status returned by this API may be delayed by 1 to 3 seconds.
+     * - This API operation uses a centralized domain name. The endpoint is in Shanghai, and calls from other regions are not supported.
+     * - The cloud computer status information in this API operation has a delay of 1 to 3 seconds compared to the actual value.
      *
      * @param request - DescribeGlobalDesktopsRequest
      * @param runtime - runtime options for this request RuntimeOptions
@@ -92,11 +96,11 @@ export default class Client extends OpenApi {
      */
     describeGlobalDesktopsWithOptions(request: $_model.DescribeGlobalDesktopsRequest, runtime: $dara.RuntimeOptions): Promise<$_model.DescribeGlobalDesktopsResponse>;
     /**
-     * Query detailed information about cloud desktops across multiple regions. You can query only regions in the Chinese mainland (excluding Nanjing – Local Region – Shutting Down).
+     * Queries the details of cloud computers in multiple regions. Currently, only regions in the Chinese mainland are supported.
      *
      * @remarks
-     * - This API uses a centralized domain name with its endpoint in Shanghai. You cannot call this API from other regions.
-     * - The cloud desktop status returned by this API may be delayed by 1 to 3 seconds.
+     * - This API operation uses a centralized domain name. The endpoint is in Shanghai, and calls from other regions are not supported.
+     * - The cloud computer status information in this API operation has a delay of 1 to 3 seconds compared to the actual value.
      *
      * @param request - DescribeGlobalDesktopsRequest
      * @returns DescribeGlobalDesktopsResponse
@@ -118,18 +122,22 @@ export default class Client extends OpenApi {
      */
     describeOfficeSites(request: $_model.DescribeOfficeSitesRequest): Promise<$_model.DescribeOfficeSitesResponse>;
     /**
+     * Queries the Alibaba Cloud region information supported by WUYING Workspace by calling DescribeRegions.
+     *
      * @param request - DescribeRegionsRequest
      * @param runtime - runtime options for this request RuntimeOptions
      * @returns DescribeRegionsResponse
      */
     describeRegionsWithOptions(request: $_model.DescribeRegionsRequest, runtime: $dara.RuntimeOptions): Promise<$_model.DescribeRegionsResponse>;
     /**
+     * Queries the Alibaba Cloud region information supported by WUYING Workspace by calling DescribeRegions.
+     *
      * @param request - DescribeRegionsRequest
      * @returns DescribeRegionsResponse
      */
     describeRegions(request: $_model.DescribeRegionsRequest): Promise<$_model.DescribeRegionsResponse>;
     /**
-     * Queries the snapshots that are created based on a cloud computer and the details of the snapshots.
+     * Queries the list and details of snapshots for a cloud desktop.
      *
      * @param request - DescribeSnapshotsRequest
      * @param runtime - runtime options for this request RuntimeOptions
@@ -137,17 +145,17 @@ export default class Client extends OpenApi {
      */
     describeSnapshotsWithOptions(request: $_model.DescribeSnapshotsRequest, runtime: $dara.RuntimeOptions): Promise<$_model.DescribeSnapshotsResponse>;
     /**
-     * Queries the snapshots that are created based on a cloud computer and the details of the snapshots.
+     * Queries the list and details of snapshots for a cloud desktop.
      *
      * @param request - DescribeSnapshotsRequest
      * @returns DescribeSnapshotsResponse
      */
     describeSnapshots(request: $_model.DescribeSnapshotsRequest): Promise<$_model.DescribeSnapshotsResponse>;
     /**
-     * Queries the list of resources owned by a user.
+     * Queries the list of user resources.
      *
      * @remarks
-     * Make sure that you are familiar with the resource types and product types of WUYING before you call this operation.
+     * Before you call this operation, make sure that you fully understand the resource types and product types of WUYING Workspace.
      *
      * @param request - DescribeUserResourcesRequest
      * @param runtime - runtime options for this request RuntimeOptions
@@ -155,17 +163,17 @@ export default class Client extends OpenApi {
      */
     describeUserResourcesWithOptions(request: $_model.DescribeUserResourcesRequest, runtime: $dara.RuntimeOptions): Promise<$_model.DescribeUserResourcesResponse>;
     /**
-     * Queries the list of resources owned by a user.
+     * Queries the list of user resources.
      *
      * @remarks
-     * Make sure that you are familiar with the resource types and product types of WUYING before you call this operation.
+     * Before you call this operation, make sure that you fully understand the resource types and product types of WUYING Workspace.
      *
      * @param request - DescribeUserResourcesRequest
      * @returns DescribeUserResourcesResponse
      */
     describeUserResources(request: $_model.DescribeUserResourcesRequest): Promise<$_model.DescribeUserResourcesResponse>;
     /**
-     * Encrypts a password.
+     * Encrypts a user password.
      *
      * @param request - EncryptPasswordRequest
      * @param runtime - runtime options for this request RuntimeOptions
@@ -173,7 +181,7 @@ export default class Client extends OpenApi {
      */
     encryptPasswordWithOptions(request: $_model.EncryptPasswordRequest, runtime: $dara.RuntimeOptions): Promise<$_model.EncryptPasswordResponse>;
     /**
-     * Encrypts a password.
+     * Encrypts a user password.
      *
      * @param request - EncryptPasswordRequest
      * @returns EncryptPasswordResponse
@@ -195,10 +203,10 @@ export default class Client extends OpenApi {
      */
     getCloudDriveServiceMountToken(request: $_model.GetCloudDriveServiceMountTokenRequest): Promise<$_model.GetCloudDriveServiceMountTokenResponse>;
     /**
-     * Obtains a connection ticket for a cloud computer.
+     * Retrieves the connection credentials for a cloud desktop.
      *
      * @remarks
-     * The first time you call this operation, it returns a `TaskID`. You can use this `TaskID` to call the operation again until `TaskStatus` changes to `FINISHED` or `FAILED`. If `TaskStatus` is `FINISHED`, the `Ticket` value is the connection ticket that the client uses to connect to the cloud computer.
+     * When you call this operation for the first time, the system returns a `TaskId`. Use this `TaskId` to continue calling this operation until the value of `TaskStatus` changes to `FINISHED` or `FAILED`. When `TaskStatus` is `FINISHED`, the value of `Ticket` is the ticket that the client uses to connect to the cloud desktop.
      *
      * @param request - GetConnectionTicketRequest
      * @param runtime - runtime options for this request RuntimeOptions
@@ -206,10 +214,10 @@ export default class Client extends OpenApi {
      */
     getConnectionTicketWithOptions(request: $_model.GetConnectionTicketRequest, runtime: $dara.RuntimeOptions): Promise<$_model.GetConnectionTicketResponse>;
     /**
-     * Obtains a connection ticket for a cloud computer.
+     * Retrieves the connection credentials for a cloud desktop.
      *
      * @remarks
-     * The first time you call this operation, it returns a `TaskID`. You can use this `TaskID` to call the operation again until `TaskStatus` changes to `FINISHED` or `FAILED`. If `TaskStatus` is `FINISHED`, the `Ticket` value is the connection ticket that the client uses to connect to the cloud computer.
+     * When you call this operation for the first time, the system returns a `TaskId`. Use this `TaskId` to continue calling this operation until the value of `TaskStatus` changes to `FINISHED` or `FAILED`. When `TaskStatus` is `FINISHED`, the value of `Ticket` is the ticket that the client uses to connect to the cloud desktop.
      *
      * @param request - GetConnectionTicketRequest
      * @returns GetConnectionTicketResponse
@@ -261,10 +269,10 @@ export default class Client extends OpenApi {
      */
     rebootDesktops(request: $_model.RebootDesktopsRequest): Promise<$_model.RebootDesktopsResponse>;
     /**
-     * Purge the logon credential.
+     * Refreshes the logon credential.
      *
      * @remarks
-     * The validity period of a logon credential (LoginToken) is 8 hours. If the end user does not log off from the client within 8 hours, the client must purge the logon credential.
+     * A logon credential (LoginToken) is valid for 8 hours. If the end user does not log off from the client within 8 hours, the client must refresh the logon credential.
      *
      * @param request - RefreshLoginTokenRequest
      * @param runtime - runtime options for this request RuntimeOptions
@@ -272,10 +280,10 @@ export default class Client extends OpenApi {
      */
     refreshLoginTokenWithOptions(request: $_model.RefreshLoginTokenRequest, runtime: $dara.RuntimeOptions): Promise<$_model.RefreshLoginTokenResponse>;
     /**
-     * Purge the logon credential.
+     * Refreshes the logon credential.
      *
      * @remarks
-     * The validity period of a logon credential (LoginToken) is 8 hours. If the end user does not log off from the client within 8 hours, the client must purge the logon credential.
+     * A logon credential (LoginToken) is valid for 8 hours. If the end user does not log off from the client within 8 hours, the client must refresh the logon credential.
      *
      * @param request - RefreshLoginTokenRequest
      * @returns RefreshLoginTokenResponse
@@ -297,7 +305,7 @@ export default class Client extends OpenApi {
      */
     reportEdsAgentInfo(request: $_model.ReportEdsAgentInfoRequest): Promise<$_model.ReportEdsAgentInfoResponse>;
     /**
-     * Report session status.
+     * Reports the session status.
      *
      * @param request - ReportSessionStatusRequest
      * @param runtime - runtime options for this request RuntimeOptions
@@ -305,14 +313,14 @@ export default class Client extends OpenApi {
      */
     reportSessionStatusWithOptions(request: $_model.ReportSessionStatusRequest, runtime: $dara.RuntimeOptions): Promise<$_model.ReportSessionStatusResponse>;
     /**
-     * Report session status.
+     * Reports the session status.
      *
      * @param request - ReportSessionStatusRequest
      * @returns ReportSessionStatusResponse
      */
     reportSessionStatus(request: $_model.ReportSessionStatusRequest): Promise<$_model.ReportSessionStatusResponse>;
     /**
-     * Resets a password.
+     * Resets a user password.
      *
      * @param request - ResetPasswordRequest
      * @param runtime - runtime options for this request RuntimeOptions
@@ -320,14 +328,14 @@ export default class Client extends OpenApi {
      */
     resetPasswordWithOptions(request: $_model.ResetPasswordRequest, runtime: $dara.RuntimeOptions): Promise<$_model.ResetPasswordResponse>;
     /**
-     * Resets a password.
+     * Resets a user password.
      *
      * @param request - ResetPasswordRequest
      * @returns ResetPasswordResponse
      */
     resetPassword(request: $_model.ResetPasswordRequest): Promise<$_model.ResetPasswordResponse>;
     /**
-     * Restores the data of a disk from a snapshot.
+     * Restores the disk data corresponding to a snapshot.
      *
      * @param request - ResetSnapshotRequest
      * @param runtime - runtime options for this request RuntimeOptions
@@ -335,7 +343,7 @@ export default class Client extends OpenApi {
      */
     resetSnapshotWithOptions(request: $_model.ResetSnapshotRequest, runtime: $dara.RuntimeOptions): Promise<$_model.ResetSnapshotResponse>;
     /**
-     * Restores the data of a disk from a snapshot.
+     * Restores the disk data corresponding to a snapshot.
      *
      * @param request - ResetSnapshotRequest
      * @returns ResetSnapshotResponse
@@ -357,23 +365,31 @@ export default class Client extends OpenApi {
      */
     sendTokenCode(request: $_model.SendTokenCodeRequest): Promise<$_model.SendTokenCodeResponse>;
     /**
+     * Sets a fingerprint template.
+     *
      * @param request - SetFingerPrintTemplateRequest
      * @param runtime - runtime options for this request RuntimeOptions
      * @returns SetFingerPrintTemplateResponse
      */
     setFingerPrintTemplateWithOptions(request: $_model.SetFingerPrintTemplateRequest, runtime: $dara.RuntimeOptions): Promise<$_model.SetFingerPrintTemplateResponse>;
     /**
+     * Sets a fingerprint template.
+     *
      * @param request - SetFingerPrintTemplateRequest
      * @returns SetFingerPrintTemplateResponse
      */
     setFingerPrintTemplate(request: $_model.SetFingerPrintTemplateRequest): Promise<$_model.SetFingerPrintTemplateResponse>;
     /**
+     * Sets the description of a fingerprint template.
+     *
      * @param request - SetFingerPrintTemplateDescriptionRequest
      * @param runtime - runtime options for this request RuntimeOptions
      * @returns SetFingerPrintTemplateDescriptionResponse
      */
     setFingerPrintTemplateDescriptionWithOptions(request: $_model.SetFingerPrintTemplateDescriptionRequest, runtime: $dara.RuntimeOptions): Promise<$_model.SetFingerPrintTemplateDescriptionResponse>;
     /**
+     * Sets the description of a fingerprint template.
+     *
      * @param request - SetFingerPrintTemplateDescriptionRequest
      * @returns SetFingerPrintTemplateDescriptionResponse
      */
@@ -411,10 +427,10 @@ export default class Client extends OpenApi {
      */
     startRecordContent(request: $_model.StartRecordContentRequest): Promise<$_model.StartRecordContentResponse>;
     /**
-     * Stops one or more cloud computers.
+     * Stops one or more cloud desktops.
      *
      * @remarks
-     * You can stop only cloud computers that are in the Running state. After you call this operation, their state changes to Stopped.
+     * The cloud desktop must be in the Running state. After the API operation is called, the state of the cloud desktop changes to Stopped.
      *
      * @param request - StopDesktopsRequest
      * @param runtime - runtime options for this request RuntimeOptions
@@ -422,10 +438,10 @@ export default class Client extends OpenApi {
      */
     stopDesktopsWithOptions(request: $_model.StopDesktopsRequest, runtime: $dara.RuntimeOptions): Promise<$_model.StopDesktopsResponse>;
     /**
-     * Stops one or more cloud computers.
+     * Stops one or more cloud desktops.
      *
      * @remarks
-     * You can stop only cloud computers that are in the Running state. After you call this operation, their state changes to Stopped.
+     * The cloud desktop must be in the Running state. After the API operation is called, the state of the cloud desktop changes to Stopped.
      *
      * @param request - StopDesktopsRequest
      * @returns StopDesktopsResponse
@@ -443,7 +459,7 @@ export default class Client extends OpenApi {
      */
     stopRecordContent(request: $_model.StopRecordContentRequest): Promise<$_model.StopRecordContentResponse>;
     /**
-     * Unbinds end users from cloud computers.
+     * Disassociates a user from a cloud desktop.
      *
      * @param request - UnbindUserDesktopRequest
      * @param runtime - runtime options for this request RuntimeOptions
@@ -451,14 +467,14 @@ export default class Client extends OpenApi {
      */
     unbindUserDesktopWithOptions(request: $_model.UnbindUserDesktopRequest, runtime: $dara.RuntimeOptions): Promise<$_model.UnbindUserDesktopResponse>;
     /**
-     * Unbinds end users from cloud computers.
+     * Disassociates a user from a cloud desktop.
      *
      * @param request - UnbindUserDesktopRequest
      * @returns UnbindUserDesktopResponse
      */
     unbindUserDesktop(request: $_model.UnbindUserDesktopRequest): Promise<$_model.UnbindUserDesktopResponse>;
     /**
-     * Validates credentials to lock on-premises sessions on clients.
+     * Verifies the credential used to unlock a local session on the client.
      *
      * @param request - VerifyCredentialRequest
      * @param runtime - runtime options for this request RuntimeOptions
@@ -466,7 +482,7 @@ export default class Client extends OpenApi {
      */
     verifyCredentialWithOptions(request: $_model.VerifyCredentialRequest, runtime: $dara.RuntimeOptions): Promise<$_model.VerifyCredentialResponse>;
     /**
-     * Validates credentials to lock on-premises sessions on clients.
+     * Verifies the credential used to unlock a local session on the client.
      *
      * @param request - VerifyCredentialRequest
      * @returns VerifyCredentialResponse