@alicloud/ecd20200930 4.25.5 → 5.0.0

package/dist/client.d.ts

@@ -552,7 +552,7 @@ export default class Client extends OpenApi {
      */
     createADConnectorOfficeSite(request: $_model.CreateADConnectorOfficeSiteRequest): Promise<$_model.CreateADConnectorOfficeSiteResponse>;
     /**
-     * Creates a NAS file system and associate it with the office network of the shared cloud computer.
+     * Creates a NAS file system and binds it to the office network of a shared cloud computer.
      *
      * @param request - CreateAndBindNasFileSystemRequest
      * @param runtime - runtime options for this request RuntimeOptions
@@ -560,7 +560,7 @@ export default class Client extends OpenApi {
      */
     createAndBindNasFileSystemWithOptions(request: $_model.CreateAndBindNasFileSystemRequest, runtime: $dara.RuntimeOptions): Promise<$_model.CreateAndBindNasFileSystemResponse>;
     /**
-     * Creates a NAS file system and associate it with the office network of the shared cloud computer.
+     * Creates a NAS file system and binds it to the office network of a shared cloud computer.
      *
      * @param request - CreateAndBindNasFileSystemRequest
      * @returns CreateAndBindNasFileSystemResponse
@@ -779,25 +779,23 @@ export default class Client extends OpenApi {
      */
     createDesktopOversoldGroup(request: $_model.CreateDesktopOversoldGroupRequest): Promise<$_model.CreateDesktopOversoldGroupResponse>;
     /**
-     * Creates one or more Elastic Desktop Service (EDS) desktops. If you provide user information, the desktops are automatically assigned to the specified users.
+     * Creates one or more cloud desktops. If user information is specified during creation, the cloud desktops are directly assigned to the users.
      *
      * @remarks
-     * Before you create a cloud desktop, meet the following requirements:
-     * - Create an office site (formerly a workspace) and users:
-     *   - Simple office site: [CreateSimpleOfficeSite](https://help.aliyun.com/document_detail/215416.html) and [CreateUsers](https://help.aliyun.com/document_detail/437832.html).
-     *   - AD connector office site: [CreateADConnectorOfficeSite](https://help.aliyun.com/document_detail/215417.html) and [Create AD users](https://help.aliyun.com/document_detail/188619.html).
-     * - Call [CreatePolicyGroup](https://help.aliyun.com/document_detail/188889.html) to create a policy, or use an existing policy.
-     * **Request examples**
+     * Before creating cloud desktops, complete the following preparations:
+     * - Create an office network (formerly workspace) and users. For more information, see the following API operations or documentation:
+     *     - Convenience office network: [CreateSimpleOfficeSite](https://help.aliyun.com/document_detail/215416.html) and [CreateUsers](https://help.aliyun.com/document_detail/437832.html).
+     *     - AD office network: [CreateADConnectorOfficeSite](https://help.aliyun.com/document_detail/215417.html) and [Create AD users](https://help.aliyun.com/document_detail/188619.html).
+     * - Call [CreatePolicyGroup](https://help.aliyun.com/document_detail/188889.html) to create a policy, or confirm that an existing policy is available.
+     * **Call examples:**
      * <details>
-     * <summary>
-     * Example: Create a cloud desktop from a bundle
-     * </summary>
+     * <summary>Example of creating with a template</summary>
      * ```
      * {
-     *   "RegionId": "cn-hangzhou",
+     *   "RegionId": "ap-southeast-1",
      *   "DesktopName": "test-desktop-name",
      *   "Amount": "1",
-     *   "OfficeSiteId": "cn-hangzhou+dir-xxx",// You must create an office site in advance.
+     *   "OfficeSiteId": "ap-southeast-1+dir-xxx",// Create an office network in advance
      *   "PolicyGroupId": "system-all-enabled-policy",
      *   "ChargeType": "PostPaid",
      *   "BundleId": "b-enterprise_office_8c16g_windows2022"
@@ -805,15 +803,13 @@ export default class Client extends OpenApi {
      * ```
      * </details>
      * <details>
-     * <summary>
-     * Example: Create a cloud desktop with custom settings
-     * </summary>
+     * <summary>Example of creating without a template</summary>
      * ```
      * {
-     *   "RegionId": "cn-hangzhou",
+     *   "RegionId": "ap-southeast-1",
      *   "DesktopName": "test-desktop-name",
      *   "Amount": "1",
-     *   "OfficeSiteId": "cn-hangzhou+dir-xxx",// You must create an office site in advance.
+     *   "OfficeSiteId": "ap-southeast-1+dir-xxx",// Create an office network in advance
      *   "PolicyGroupId": "system-all-enabled-policy",
      *   "ChargeType": "PostPaid",
      *   "DesktopAttachment": {
@@ -827,15 +823,13 @@ export default class Client extends OpenApi {
      * ```
      * </details>
      * <details>
-     * <summary>
-     * Example: Create a cloud desktop with a monthly usage package
-     * </summary>
+     * <summary>Example of creating a monthly hourly package</summary>
      * ```
      * {
-     *   "RegionId": "cn-hangzhou",
+     *   "RegionId": "ap-southeast-1",
      *   "DesktopName": "test-desktop-name",
      *   "Amount": "1",
-     *   "OfficeSiteId": "cn-hangzhou+dir-xxx",// You must create an office site in advance.
+     *   "OfficeSiteId": "ap-southeast-1+dir-xxx",// Create an office network in advance
      *   "PolicyGroupId": "system-all-enabled-policy",
      *   "ChargeType": "PostPaid",
      *   "DesktopAttachment": {
@@ -854,16 +848,14 @@ export default class Client extends OpenApi {
      * ```
      * </details>
      * <details>
-     * <summary>
-     * Example: Create an agent resource
-     * </summary>
+     * <summary>Example of creating an Agent resource</summary>
      * ```
      * {
-     *   "RegionId": "cn-hangzhou",
+     *   "RegionId": "ap-southeast-1",
      *   "BundleId": "b-openclaw-linux",
      *   "DesktopName": "test-desktop-name",
      *   "Amount": "1",
-     *   "OfficeSiteId": "cn-hangzhou+dir-xxx",// You must create an office site in advance.
+     *   "OfficeSiteId": "ap-southeast-1+dir-xxx",// Create an office network in advance
      *   "ChargeType": "PostPaid",
      *   "DesktopAttachment": {
      *     "DesktopType": "cloud.space.4c.8g"
@@ -876,7 +868,7 @@ export default class Client extends OpenApi {
      * }
      * ```
      * </details>
-     * To automatically run user commands on a cloud desktop, configure the `UserCommands` parameter.
+     * To have cloud desktops automatically run custom command scripts, use the `UserCommands` field to configure custom commands.
      *
      * @param tmpReq - CreateDesktopsRequest
      * @param runtime - runtime options for this request RuntimeOptions
@@ -884,25 +876,23 @@ export default class Client extends OpenApi {
      */
     createDesktopsWithOptions(tmpReq: $_model.CreateDesktopsRequest, runtime: $dara.RuntimeOptions): Promise<$_model.CreateDesktopsResponse>;
     /**
-     * Creates one or more Elastic Desktop Service (EDS) desktops. If you provide user information, the desktops are automatically assigned to the specified users.
+     * Creates one or more cloud desktops. If user information is specified during creation, the cloud desktops are directly assigned to the users.
      *
      * @remarks
-     * Before you create a cloud desktop, meet the following requirements:
-     * - Create an office site (formerly a workspace) and users:
-     *   - Simple office site: [CreateSimpleOfficeSite](https://help.aliyun.com/document_detail/215416.html) and [CreateUsers](https://help.aliyun.com/document_detail/437832.html).
-     *   - AD connector office site: [CreateADConnectorOfficeSite](https://help.aliyun.com/document_detail/215417.html) and [Create AD users](https://help.aliyun.com/document_detail/188619.html).
-     * - Call [CreatePolicyGroup](https://help.aliyun.com/document_detail/188889.html) to create a policy, or use an existing policy.
-     * **Request examples**
+     * Before creating cloud desktops, complete the following preparations:
+     * - Create an office network (formerly workspace) and users. For more information, see the following API operations or documentation:
+     *     - Convenience office network: [CreateSimpleOfficeSite](https://help.aliyun.com/document_detail/215416.html) and [CreateUsers](https://help.aliyun.com/document_detail/437832.html).
+     *     - AD office network: [CreateADConnectorOfficeSite](https://help.aliyun.com/document_detail/215417.html) and [Create AD users](https://help.aliyun.com/document_detail/188619.html).
+     * - Call [CreatePolicyGroup](https://help.aliyun.com/document_detail/188889.html) to create a policy, or confirm that an existing policy is available.
+     * **Call examples:**
      * <details>
-     * <summary>
-     * Example: Create a cloud desktop from a bundle
-     * </summary>
+     * <summary>Example of creating with a template</summary>
      * ```
      * {
-     *   "RegionId": "cn-hangzhou",
+     *   "RegionId": "ap-southeast-1",
      *   "DesktopName": "test-desktop-name",
      *   "Amount": "1",
-     *   "OfficeSiteId": "cn-hangzhou+dir-xxx",// You must create an office site in advance.
+     *   "OfficeSiteId": "ap-southeast-1+dir-xxx",// Create an office network in advance
      *   "PolicyGroupId": "system-all-enabled-policy",
      *   "ChargeType": "PostPaid",
      *   "BundleId": "b-enterprise_office_8c16g_windows2022"
@@ -910,15 +900,13 @@ export default class Client extends OpenApi {
      * ```
      * </details>
      * <details>
-     * <summary>
-     * Example: Create a cloud desktop with custom settings
-     * </summary>
+     * <summary>Example of creating without a template</summary>
      * ```
      * {
-     *   "RegionId": "cn-hangzhou",
+     *   "RegionId": "ap-southeast-1",
      *   "DesktopName": "test-desktop-name",
      *   "Amount": "1",
-     *   "OfficeSiteId": "cn-hangzhou+dir-xxx",// You must create an office site in advance.
+     *   "OfficeSiteId": "ap-southeast-1+dir-xxx",// Create an office network in advance
      *   "PolicyGroupId": "system-all-enabled-policy",
      *   "ChargeType": "PostPaid",
      *   "DesktopAttachment": {
@@ -932,15 +920,13 @@ export default class Client extends OpenApi {
      * ```
      * </details>
      * <details>
-     * <summary>
-     * Example: Create a cloud desktop with a monthly usage package
-     * </summary>
+     * <summary>Example of creating a monthly hourly package</summary>
      * ```
      * {
-     *   "RegionId": "cn-hangzhou",
+     *   "RegionId": "ap-southeast-1",
      *   "DesktopName": "test-desktop-name",
      *   "Amount": "1",
-     *   "OfficeSiteId": "cn-hangzhou+dir-xxx",// You must create an office site in advance.
+     *   "OfficeSiteId": "ap-southeast-1+dir-xxx",// Create an office network in advance
      *   "PolicyGroupId": "system-all-enabled-policy",
      *   "ChargeType": "PostPaid",
      *   "DesktopAttachment": {
@@ -959,16 +945,14 @@ export default class Client extends OpenApi {
      * ```
      * </details>
      * <details>
-     * <summary>
-     * Example: Create an agent resource
-     * </summary>
+     * <summary>Example of creating an Agent resource</summary>
      * ```
      * {
-     *   "RegionId": "cn-hangzhou",
+     *   "RegionId": "ap-southeast-1",
      *   "BundleId": "b-openclaw-linux",
      *   "DesktopName": "test-desktop-name",
      *   "Amount": "1",
-     *   "OfficeSiteId": "cn-hangzhou+dir-xxx",// You must create an office site in advance.
+     *   "OfficeSiteId": "ap-southeast-1+dir-xxx",// Create an office network in advance
      *   "ChargeType": "PostPaid",
      *   "DesktopAttachment": {
      *     "DesktopType": "cloud.space.4c.8g"
@@ -981,7 +965,7 @@ export default class Client extends OpenApi {
      * }
      * ```
      * </details>
-     * To automatically run user commands on a cloud desktop, configure the `UserCommands` parameter.
+     * To have cloud desktops automatically run custom command scripts, use the `UserCommands` field to configure custom commands.
      *
      * @param request - CreateDesktopsRequest
      * @returns CreateDesktopsResponse
@@ -1117,7 +1101,7 @@ export default class Client extends OpenApi {
      */
     createNatGateway(request: $_model.CreateNatGatewayRequest): Promise<$_model.CreateNatGatewayResponse>;
     /**
-     * Creates a network package for an office network.
+     * Creates a premium bandwidth plan for an office network.
      *
      * @param request - CreateNetworkPackageRequest
      * @param runtime - runtime options for this request RuntimeOptions
@@ -1125,7 +1109,7 @@ export default class Client extends OpenApi {
      */
     createNetworkPackageWithOptions(request: $_model.CreateNetworkPackageRequest, runtime: $dara.RuntimeOptions): Promise<$_model.CreateNetworkPackageResponse>;
     /**
-     * Creates a network package for an office network.
+     * Creates a premium bandwidth plan for an office network.
      *
      * @param request - CreateNetworkPackageRequest
      * @returns CreateNetworkPackageResponse
@@ -1925,7 +1909,7 @@ export default class Client extends OpenApi {
      */
     describeCens(request: $_model.DescribeCensRequest): Promise<$_model.DescribeCensResponse>;
     /**
-     * Query details of policies that are not region-specific.
+     * Queries the details of region-free policies.
      *
      * @param request - DescribeCenterPolicyListRequest
      * @param runtime - runtime options for this request RuntimeOptions
@@ -1933,7 +1917,7 @@ export default class Client extends OpenApi {
      */
     describeCenterPolicyListWithOptions(request: $_model.DescribeCenterPolicyListRequest, runtime: $dara.RuntimeOptions): Promise<$_model.DescribeCenterPolicyListResponse>;
     /**
-     * Query details of policies that are not region-specific.
+     * Queries the details of region-free policies.
      *
      * @param request - DescribeCenterPolicyListRequest
      * @returns DescribeCenterPolicyListResponse
@@ -2323,27 +2307,6 @@ export default class Client extends OpenApi {
      * @returns DescribeFlowMetricResponse
      */
     describeFlowMetric(request: $_model.DescribeFlowMetricRequest): Promise<$_model.DescribeFlowMetricResponse>;
-    /**
-     * Queries cloud computer-level traffic statistics of a single office network.
-     *
-     * @remarks
-     * > You can query only the traffic data in the last 90 days.
-     *
-     * @param request - DescribeFlowStatisticRequest
-     * @param runtime - runtime options for this request RuntimeOptions
-     * @returns DescribeFlowStatisticResponse
-     */
-    describeFlowStatisticWithOptions(request: $_model.DescribeFlowStatisticRequest, runtime: $dara.RuntimeOptions): Promise<$_model.DescribeFlowStatisticResponse>;
-    /**
-     * Queries cloud computer-level traffic statistics of a single office network.
-     *
-     * @remarks
-     * > You can query only the traffic data in the last 90 days.
-     *
-     * @param request - DescribeFlowStatisticRequest
-     * @returns DescribeFlowStatisticResponse
-     */
-    describeFlowStatistic(request: $_model.DescribeFlowStatisticRequest): Promise<$_model.DescribeFlowStatisticResponse>;
     /**
      * 查询DNAT条目
      *
@@ -2617,7 +2580,7 @@ export default class Client extends OpenApi {
      */
     describeNatGateways(request: $_model.DescribeNatGatewaysRequest): Promise<$_model.DescribeNatGatewaysResponse>;
     /**
-     * Queries the details of one or more premium bandwidth plans.
+     * Queries the details of one or more premium Internet bandwidth plans.
      *
      * @param request - DescribeNetworkPackagesRequest
      * @param runtime - runtime options for this request RuntimeOptions
@@ -2625,7 +2588,7 @@ export default class Client extends OpenApi {
      */
     describeNetworkPackagesWithOptions(request: $_model.DescribeNetworkPackagesRequest, runtime: $dara.RuntimeOptions): Promise<$_model.DescribeNetworkPackagesResponse>;
     /**
-     * Queries the details of one or more premium bandwidth plans.
+     * Queries the details of one or more premium Internet bandwidth plans.
      *
      * @param request - DescribeNetworkPackagesRequest
      * @returns DescribeNetworkPackagesResponse
@@ -2961,7 +2924,7 @@ export default class Client extends OpenApi {
      */
     describeSubnets(request: $_model.DescribeSubnetsRequest): Promise<$_model.DescribeSubnetsResponse>;
     /**
-     * Query the details of Cloud Desktop templates.
+     * Queries the details of cloud computer templates.
      *
      * @param request - DescribeTemplatesRequest
      * @param runtime - runtime options for this request RuntimeOptions
@@ -2969,7 +2932,7 @@ export default class Client extends OpenApi {
      */
     describeTemplatesWithOptions(request: $_model.DescribeTemplatesRequest, runtime: $dara.RuntimeOptions): Promise<$_model.DescribeTemplatesResponse>;
     /**
-     * Query the details of Cloud Desktop templates.
+     * Queries the details of cloud computer templates.
      *
      * @param request - DescribeTemplatesRequest
      * @returns DescribeTemplatesResponse
@@ -3479,10 +3442,10 @@ export default class Client extends OpenApi {
      */
     listOfficeSiteUsers(request: $_model.ListOfficeSiteUsersRequest): Promise<$_model.ListOfficeSiteUsersResponse>;
     /**
-     * Queries the tags of cloud computers.
+     * Queries the list of tags that are added to cloud computers.
      *
      * @remarks
-     * You must use at least one of the following parameters in the request to determine the object that you want to query: `ResourceId.N`, `Tag.N.Key`, and `Tag.N.Value`.
+     * You must specify at least one of the following parameters in the request to specify the query object: `ResourceId.N`, `Tag.N.Key`, or `Tag.N.Value`.
      *
      * @param request - ListTagResourcesRequest
      * @param runtime - runtime options for this request RuntimeOptions
@@ -3490,10 +3453,10 @@ export default class Client extends OpenApi {
      */
     listTagResourcesWithOptions(request: $_model.ListTagResourcesRequest, runtime: $dara.RuntimeOptions): Promise<$_model.ListTagResourcesResponse>;
     /**
-     * Queries the tags of cloud computers.
+     * Queries the list of tags that are added to cloud computers.
      *
      * @remarks
-     * You must use at least one of the following parameters in the request to determine the object that you want to query: `ResourceId.N`, `Tag.N.Key`, and `Tag.N.Value`.
+     * You must specify at least one of the following parameters in the request to specify the query object: `ResourceId.N`, `Tag.N.Key`, or `Tag.N.Value`.
      *
      * @param request - ListTagResourcesRequest
      * @returns ListTagResourcesResponse
@@ -3659,7 +3622,7 @@ export default class Client extends OpenApi {
      */
     modifyAclEntries(request: $_model.ModifyAclEntriesRequest): Promise<$_model.ModifyAclEntriesResponse>;
     /**
-     * Modifies the name and snapshot retention period of an automatic snapshot policy.
+     * Modifies the configuration items of an automatic snapshot policy, including the policy name and snapshot retention period.
      *
      * @param request - ModifyAutoSnapshotPolicyRequest
      * @param runtime - runtime options for this request RuntimeOptions
@@ -3667,7 +3630,7 @@ export default class Client extends OpenApi {
      */
     modifyAutoSnapshotPolicyWithOptions(request: $_model.ModifyAutoSnapshotPolicyRequest, runtime: $dara.RuntimeOptions): Promise<$_model.ModifyAutoSnapshotPolicyResponse>;
     /**
-     * Modifies the name and snapshot retention period of an automatic snapshot policy.
+     * Modifies the configuration items of an automatic snapshot policy, including the policy name and snapshot retention period.
      *
      * @param request - ModifyAutoSnapshotPolicyRequest
      * @returns ModifyAutoSnapshotPolicyResponse
@@ -4944,10 +4907,10 @@ export default class Client extends OpenApi {
      */
     setDesktopMaintenance(request: $_model.SetDesktopMaintenanceRequest): Promise<$_model.SetDesktopMaintenanceResponse>;
     /**
-     * Enables or disables the single sign-on (SSO) feature for an Active Directory (AD) account-based office network.
+     * Enables or disables the single sign-on (SSO) feature for an AD-based office network.
      *
      * @remarks
-     * This operation is supported only for AD directories, not for RAM directories.
+     * This operation has the same effect as [SetOfficeSiteSsoStatus](~~SetOfficeSiteSsoStatus~~). Use the SetOfficeSiteSsoStatus operation instead.
      *
      * @param request - SetDirectorySsoStatusRequest
      * @param runtime - runtime options for this request RuntimeOptions
@@ -4955,10 +4918,10 @@ export default class Client extends OpenApi {
      */
     setDirectorySsoStatusWithOptions(request: $_model.SetDirectorySsoStatusRequest, runtime: $dara.RuntimeOptions): Promise<$_model.SetDirectorySsoStatusResponse>;
     /**
-     * Enables or disables the single sign-on (SSO) feature for an Active Directory (AD) account-based office network.
+     * Enables or disables the single sign-on (SSO) feature for an AD-based office network.
      *
      * @remarks
-     * This operation is supported only for AD directories, not for RAM directories.
+     * This operation has the same effect as [SetOfficeSiteSsoStatus](~~SetOfficeSiteSsoStatus~~). Use the SetOfficeSiteSsoStatus operation instead.
      *
      * @param request - SetDirectorySsoStatusRequest
      * @returns SetDirectorySsoStatusResponse
@@ -5079,10 +5042,10 @@ export default class Client extends OpenApi {
      */
     stopInvocation(request: $_model.StopInvocationRequest): Promise<$_model.StopInvocationResponse>;
     /**
-     * Adds tags to cloud computers. This allows you to filter and manage cloud computers by tag.
+     * Adds tags to specified cloud desktops. This makes it easier to filter and manage cloud desktops by tag.
      *
      * @remarks
-     * If TagKey is specified, the new TagValue value overrides the original TagValue value.
+     * If the specified TagKey already exists, the new TagValue overwrites the original TagValue.
      *
      * @param request - TagResourcesRequest
      * @param runtime - runtime options for this request RuntimeOptions
@@ -5090,10 +5053,10 @@ export default class Client extends OpenApi {
      */
     tagResourcesWithOptions(request: $_model.TagResourcesRequest, runtime: $dara.RuntimeOptions): Promise<$_model.TagResourcesResponse>;
     /**
-     * Adds tags to cloud computers. This allows you to filter and manage cloud computers by tag.
+     * Adds tags to specified cloud desktops. This makes it easier to filter and manage cloud desktops by tag.
      *
      * @remarks
-     * If TagKey is specified, the new TagValue value overrides the original TagValue value.
+     * If the specified TagKey already exists, the new TagValue overwrites the original TagValue.
      *
      * @param request - TagResourcesRequest
      * @returns TagResourcesResponse
@@ -5160,7 +5123,7 @@ export default class Client extends OpenApi {
      */
     unlockVirtualMFADevice(request: $_model.UnlockVirtualMFADeviceRequest): Promise<$_model.UnlockVirtualMFADeviceResponse>;
     /**
-     * Removes tags from cloud computers. After you remove a tag, if the tag is not added to a cloud computer, the tag is automatically deleted.
+     * Removes tags from cloud desktops. After a tag is removed, if the tag is not added to any cloud desktop, the tag is automatically deleted.
      *
      * @param request - UntagResourcesRequest
      * @param runtime - runtime options for this request RuntimeOptions
@@ -5168,7 +5131,7 @@ export default class Client extends OpenApi {
      */
     untagResourcesWithOptions(request: $_model.UntagResourcesRequest, runtime: $dara.RuntimeOptions): Promise<$_model.UntagResourcesResponse>;
     /**
-     * Removes tags from cloud computers. After you remove a tag, if the tag is not added to a cloud computer, the tag is automatically deleted.
+     * Removes tags from cloud desktops. After a tag is removed, if the tag is not added to any cloud desktop, the tag is automatically deleted.
      *
      * @param request - UntagResourcesRequest
      * @returns UntagResourcesResponse